class AsposeSlidesCloud::TiffExportOptions
Provides options that control how a presentation is saved in TIFF format.
Attributes
Gets or sets the color of comments area (Applies only if comments are displayed on the right).
Gets or sets the width of the comment output area in pixels (Applies only if comments are displayed on the right).
Gets or sets the position of the comments on the page.
Compression type.
Horizontal resolution, in dots per inch.
Vertical resolution, in dots per inch.
Height.
Gets or sets the position of the notes on the page.
Specifies the pixel format for the generated images. Read/write ImagePixelFormat.
Width.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
AsposeSlidesCloud::ExportOptions::attribute_map
# File lib/aspose_slides_cloud/models/tiff_export_options.rb, line 87 def self.attribute_map super.merge({ :'compression' => :'Compression', :'width' => :'Width', :'height' => :'Height', :'dpi_x' => :'DpiX', :'dpi_y' => :'DpiY', :'show_hidden_slides' => :'ShowHiddenSlides', :'pixel_format' => :'PixelFormat', :'notes_position' => :'NotesPosition', :'comments_position' => :'CommentsPosition', :'comments_area_width' => :'CommentsAreaWidth', :'comments_area_color' => :'CommentsAreaColor', :'show_comments_by_no_author' => :'ShowCommentsByNoAuthor', }) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
AsposeSlidesCloud::ExportOptions::new
# File lib/aspose_slides_cloud/models/tiff_export_options.rb, line 124 def initialize(attributes = {}) super if attributes.has_key?(:'Compression') self.compression = attributes[:'Compression'] end if attributes.has_key?(:'Width') self.width = attributes[:'Width'] end if attributes.has_key?(:'Height') self.height = attributes[:'Height'] end if attributes.has_key?(:'DpiX') self.dpi_x = attributes[:'DpiX'] end if attributes.has_key?(:'DpiY') self.dpi_y = attributes[:'DpiY'] end if attributes.has_key?(:'ShowHiddenSlides') self.show_hidden_slides = attributes[:'ShowHiddenSlides'] end if attributes.has_key?(:'PixelFormat') self.pixel_format = attributes[:'PixelFormat'] end if attributes.has_key?(:'NotesPosition') self.notes_position = attributes[:'NotesPosition'] end if attributes.has_key?(:'CommentsPosition') self.comments_position = attributes[:'CommentsPosition'] end if attributes.has_key?(:'CommentsAreaWidth') self.comments_area_width = attributes[:'CommentsAreaWidth'] end if attributes.has_key?(:'CommentsAreaColor') self.comments_area_color = attributes[:'CommentsAreaColor'] end if attributes.has_key?(:'ShowCommentsByNoAuthor') self.show_comments_by_no_author = attributes[:'ShowCommentsByNoAuthor'] end self.format = "tiff" end
Attribute type mapping.
AsposeSlidesCloud::ExportOptions::swagger_types
# File lib/aspose_slides_cloud/models/tiff_export_options.rb, line 105 def self.swagger_types super.merge({ :'compression' => :'String', :'width' => :'Integer', :'height' => :'Integer', :'dpi_x' => :'Integer', :'dpi_y' => :'Integer', :'show_hidden_slides' => :'BOOLEAN', :'pixel_format' => :'String', :'notes_position' => :'String', :'comments_position' => :'String', :'comments_area_width' => :'Integer', :'comments_area_color' => :'String', :'show_comments_by_no_author' => :'BOOLEAN', }) end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/aspose_slides_cloud/models/tiff_export_options.rb, line 276 def ==(o) return true if self.equal?(o) self.class == o.class && default_regular_font == o.default_regular_font && format == o.format && compression == o.compression && width == o.width && height == o.height && dpi_x == o.dpi_x && dpi_y == o.dpi_y && show_hidden_slides == o.show_hidden_slides && pixel_format == o.pixel_format && notes_position == o.notes_position && comments_position == o.comments_position && comments_area_width == o.comments_area_width && comments_area_color == o.comments_area_color && show_comments_by_no_author == o.show_comments_by_no_author 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/aspose_slides_cloud/models/tiff_export_options.rb, line 343 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 = AsposeSlidesCloud.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/aspose_slides_cloud/models/tiff_export_options.rb, line 409 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/aspose_slides_cloud/models/tiff_export_options.rb, line 310 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| mapKey = self.class.attribute_map[key] if !mapKey.nil? val = attributes[mapKey] if val.nil? mapKeyString = mapKey.to_s mapKeyString[0] = mapKeyString[0].downcase mapKey = mapKeyString.to_sym val = attributes[mapKey] end if !val.nil? 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 val.is_a?(Array) self.send("#{key}=", val.map { |v| _deserialize($1, v) }) end else self.send("#{key}=", _deserialize(type, val)) end end end end self end
Custom attribute writer method checking allowed values (enum). @param [Object] comments_position
Object to be assigned
# File lib/aspose_slides_cloud/models/tiff_export_options.rb, line 266 def comments_position=(comments_position) validator = EnumAttributeValidator.new('String', ['None', 'Bottom', 'Right']) unless validator.valid?(comments_position) fail ArgumentError, 'invalid value for "comments_position", must be one of #{validator.allowable_values}.' end @comments_position = comments_position end
Custom attribute writer method checking allowed values (enum). @param [Object] compression Object to be assigned
# File lib/aspose_slides_cloud/models/tiff_export_options.rb, line 236 def compression=(compression) validator = EnumAttributeValidator.new('String', ['Default', 'None', 'CCITT3', 'CCITT4', 'LZW', 'RLE']) unless validator.valid?(compression) fail ArgumentError, 'invalid value for "compression", must be one of #{validator.allowable_values}.' end @compression = compression end
@see the `==` method @param [Object] Object to be compared
# File lib/aspose_slides_cloud/models/tiff_export_options.rb, line 297 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/aspose_slides_cloud/models/tiff_export_options.rb, line 303 def hash [default_regular_font, format, compression, width, height, dpi_x, dpi_y, show_hidden_slides, pixel_format, notes_position, comments_position, comments_area_width, comments_area_color, show_comments_by_no_author].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
AsposeSlidesCloud::ExportOptions#list_invalid_properties
# File lib/aspose_slides_cloud/models/tiff_export_options.rb, line 179 def list_invalid_properties invalid_properties = super if @compression.nil? invalid_properties.push('invalid value for "compression", compression cannot be nil.') end if @show_hidden_slides.nil? invalid_properties.push('invalid value for "show_hidden_slides", show_hidden_slides cannot be nil.') end if @pixel_format.nil? invalid_properties.push('invalid value for "pixel_format", pixel_format cannot be nil.') end if @notes_position.nil? invalid_properties.push('invalid value for "notes_position", notes_position cannot be nil.') end if @comments_position.nil? invalid_properties.push('invalid value for "comments_position", comments_position cannot be nil.') end if @comments_area_width.nil? invalid_properties.push('invalid value for "comments_area_width", comments_area_width cannot be nil.') end if @show_comments_by_no_author.nil? invalid_properties.push('invalid value for "show_comments_by_no_author", show_comments_by_no_author cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] notes_position
Object to be assigned
# File lib/aspose_slides_cloud/models/tiff_export_options.rb, line 256 def notes_position=(notes_position) validator = EnumAttributeValidator.new('String', ['None', 'BottomFull', 'BottomTruncated']) unless validator.valid?(notes_position) fail ArgumentError, 'invalid value for "notes_position", must be one of #{validator.allowable_values}.' end @notes_position = notes_position end
Custom attribute writer method checking allowed values (enum). @param [Object] pixel_format
Object to be assigned
# File lib/aspose_slides_cloud/models/tiff_export_options.rb, line 246 def pixel_format=(pixel_format) validator = EnumAttributeValidator.new('String', ['Format1bppIndexed', 'Format4bppIndexed', 'Format8bppIndexed', 'Format24bppRgb', 'Format32bppArgb']) unless validator.valid?(pixel_format) fail ArgumentError, 'invalid value for "pixel_format", must be one of #{validator.allowable_values}.' end @pixel_format = pixel_format end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/aspose_slides_cloud/models/tiff_export_options.rb, line 395 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/aspose_slides_cloud/models/tiff_export_options.rb, line 383 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
AsposeSlidesCloud::ExportOptions#valid?
# File lib/aspose_slides_cloud/models/tiff_export_options.rb, line 214 def valid? return false if !super return false if @compression.nil? compression_validator = EnumAttributeValidator.new('String', ['Default', 'None', 'CCITT3', 'CCITT4', 'LZW', 'RLE']) return false unless compression_validator.valid?(@compression) return false if @show_hidden_slides.nil? return false if @pixel_format.nil? pixel_format_validator = EnumAttributeValidator.new('String', ['Format1bppIndexed', 'Format4bppIndexed', 'Format8bppIndexed', 'Format24bppRgb', 'Format32bppArgb']) return false unless pixel_format_validator.valid?(@pixel_format) return false if @notes_position.nil? notes_position_validator = EnumAttributeValidator.new('String', ['None', 'BottomFull', 'BottomTruncated']) return false unless notes_position_validator.valid?(@notes_position) return false if @comments_position.nil? comments_position_validator = EnumAttributeValidator.new('String', ['None', 'Bottom', 'Right']) return false unless comments_position_validator.valid?(@comments_position) return false if @comments_area_width.nil? return false if @show_comments_by_no_author.nil? true end