class AsposeDiagramCloud::PdfSaveOptions
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 77 def self.attribute_map { :'save_format' => :'SaveFormat', :'default_font' => :'DefaultFont', :'area' => :'Area', :'export_guide_shapes' => :'ExportGuideShapes', :'page_size' => :'PageSize', :'is_export_comments' => :'IsExportComments', :'horizontal_resolution' => :'HorizontalResolution', :'vertical_resolution' => :'VerticalResolution', :'page_count' => :'PageCount', :'jpeg_quality' => :'JpegQuality', :'export_hidden_page' => :'ExportHiddenPage', :'page_index' => :'PageIndex', :'save_foreground_pages_only' => :'SaveForegroundPagesOnly', :'compliance' => :'Compliance', :'encryption_details' => :'EncryptionDetails', :'text_compression' => :'TextCompression', :'split_multi_pages' => :'SplitMultiPages', :'digital_signature_details' => :'DigitalSignatureDetails' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 126 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'SaveFormat') self.save_format = attributes[:'SaveFormat'] end if attributes.has_key?(:'DefaultFont') self.default_font = attributes[:'DefaultFont'] end if attributes.has_key?(:'Area') self.area = attributes[:'Area'] end if attributes.has_key?(:'ExportGuideShapes') self.export_guide_shapes = attributes[:'ExportGuideShapes'] end if attributes.has_key?(:'PageSize') self.page_size = attributes[:'PageSize'] end if attributes.has_key?(:'IsExportComments') self.is_export_comments = attributes[:'IsExportComments'] end if attributes.has_key?(:'HorizontalResolution') self.horizontal_resolution = attributes[:'HorizontalResolution'] end if attributes.has_key?(:'VerticalResolution') self.vertical_resolution = attributes[:'VerticalResolution'] end if attributes.has_key?(:'PageCount') self.page_count = attributes[:'PageCount'] end if attributes.has_key?(:'JpegQuality') self.jpeg_quality = attributes[:'JpegQuality'] end if attributes.has_key?(:'ExportHiddenPage') self.export_hidden_page = attributes[:'ExportHiddenPage'] end if attributes.has_key?(:'PageIndex') self.page_index = attributes[:'PageIndex'] end if attributes.has_key?(:'SaveForegroundPagesOnly') self.save_foreground_pages_only = attributes[:'SaveForegroundPagesOnly'] end if attributes.has_key?(:'Compliance') self.compliance = attributes[:'Compliance'] end if attributes.has_key?(:'EncryptionDetails') self.encryption_details = attributes[:'EncryptionDetails'] end if attributes.has_key?(:'TextCompression') self.text_compression = attributes[:'TextCompression'] end if attributes.has_key?(:'SplitMultiPages') self.split_multi_pages = attributes[:'SplitMultiPages'] end if attributes.has_key?(:'DigitalSignatureDetails') self.digital_signature_details = attributes[:'DigitalSignatureDetails'] end end
Attribute type mapping.
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 101 def self.swagger_types { :'save_format' => :'String', :'default_font' => :'String', :'area' => :'RectangleF', :'export_guide_shapes' => :'BOOLEAN', :'page_size' => :'PageSize', :'is_export_comments' => :'BOOLEAN', :'horizontal_resolution' => :'Integer', :'vertical_resolution' => :'Integer', :'page_count' => :'Integer', :'jpeg_quality' => :'Integer', :'export_hidden_page' => :'BOOLEAN', :'page_index' => :'Integer', :'save_foreground_pages_only' => :'BOOLEAN', :'compliance' => :'String', :'encryption_details' => :'PdfEncryptionDetails', :'text_compression' => :'String', :'split_multi_pages' => :'BOOLEAN', :'digital_signature_details' => :'PdfDigitalSignatureDetails' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 267 def ==(o) return true if self.equal?(o) self.class == o.class && save_format == o.save_format && default_font == o.default_font && area == o.area && export_guide_shapes == o.export_guide_shapes && page_size == o.page_size && is_export_comments == o.is_export_comments && horizontal_resolution == o.horizontal_resolution && vertical_resolution == o.vertical_resolution && page_count == o.page_count && jpeg_quality == o.jpeg_quality && export_hidden_page == o.export_hidden_page && page_index == o.page_index && save_foreground_pages_only == o.save_foreground_pages_only && compliance == o.compliance && encryption_details == o.encryption_details && text_compression == o.text_compression && split_multi_pages == o.split_multi_pages && digital_signature_details == o.digital_signature_details end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 326 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = AsposeDiagramCloud.const_get(type).new temp_model.build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 392 def _to_hash(value) if value.is_a?(Array) value.compact.map{ |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 305 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
Custom attribute writer method checking allowed values (enum). @param [Object] compliance Object to be assigned
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 247 def compliance=(compliance) validator = EnumAttributeValidator.new('String', ["Pdf15", "PdfA1a", "PdfA1b"]) unless validator.valid?(compliance) fail ArgumentError, "invalid value for 'compliance', must be one of #{validator.allowable_values}." end @compliance = compliance end
@see the `==` method @param [Object] Object to be compared
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 292 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 298 def hash [save_format, default_font, area, export_guide_shapes, page_size, is_export_comments, horizontal_resolution, vertical_resolution, page_count, jpeg_quality, export_hidden_page, page_index, save_foreground_pages_only, compliance, encryption_details, text_compression, split_multi_pages, digital_signature_details].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 208 def list_invalid_properties invalid_properties = Array.new if @save_format.nil? invalid_properties.push("invalid value for 'save_format', save_format cannot be nil.") end if @area.nil? invalid_properties.push("invalid value for 'area', area cannot be nil.") end return invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] save_format
Object to be assigned
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 237 def save_format=(save_format) validator = EnumAttributeValidator.new('String', ["VDX", "VSX", "VTX", "TIFF", "PNG", "BMP", "EMF", "JPEG", "PDF", "XPS", "GIF", "HTML", "SVG", "SWF", "XAML", "VSDX", "VSTX", "VSSX", "VSDM", "VSSM", "VSTM"]) unless validator.valid?(save_format) fail ArgumentError, "invalid value for 'save_format', must be one of #{validator.allowable_values}." end @save_format = save_format end
Custom attribute writer method checking allowed values (enum). @param [Object] text_compression
Object to be assigned
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 257 def text_compression=(text_compression) validator = EnumAttributeValidator.new('String', ["None", "Flate"]) unless validator.valid?(text_compression) fail ArgumentError, "invalid value for 'text_compression', must be one of #{validator.allowable_values}." end @text_compression = text_compression end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 378 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 366 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/AsposeDiagramCloud/models/pdf_save_options.rb, line 223 def valid? return false if @save_format.nil? save_format_validator = EnumAttributeValidator.new('String', ["VDX", "VSX", "VTX", "TIFF", "PNG", "BMP", "EMF", "JPEG", "PDF", "XPS", "GIF", "HTML", "SVG", "SWF", "XAML", "VSDX", "VSTX", "VSSX", "VSDM", "VSSM", "VSTM"]) return false unless save_format_validator.valid?(@save_format) return false if @area.nil? compliance_validator = EnumAttributeValidator.new('String', ["Pdf15", "PdfA1a", "PdfA1b"]) return false unless compliance_validator.valid?(@compliance) text_compression_validator = EnumAttributeValidator.new('String', ["None", "Flate"]) return false unless text_compression_validator.valid?(@text_compression) return true end