Class: AsposeSlidesCloud::TiffExportOptions

Inherits:
ImageExportOptionsBase show all
Defined in:
lib/aspose_slides_cloud/models/tiff_export_options.rb

Overview

Provides options that control how a presentation is saved in TIFF format.

Instance Attribute Summary collapse

Attributes inherited from ImageExportOptionsBase

#height, #width

Attributes inherited from ExportOptions

#default_regular_font, #font_fallback_rules, #font_subst_rules, #format, #gradient_style

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseObject

#_deserialize, #_to_hash, #build_from_hash, #to_body, #to_hash, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ TiffExportOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 77

def initialize(attributes = {})
  super

  if attributes.has_key?(:'Compression')
    self.compression = attributes[:'Compression']
  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?(:'SlidesLayoutOptions')
    self.slides_layout_options = attributes[:'SlidesLayoutOptions']
  end

  if attributes.has_key?(:'BwConversionMode')
    self.bw_conversion_mode = attributes[:'BwConversionMode']
  end
  self.format = 'tiff'
end

Instance Attribute Details

#bw_conversion_modeObject

Specifies the algorithm for converting a color image into a black and white image. This option will applied only if Aspose.Slides.Export.TiffOptions.CompressionType is set to Aspose.Slides.Export.TiffCompressionTypes.CCITT4 or Aspose.Slides.Export.TiffCompressionTypes.CCITT3.



47
48
49
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 47

def bw_conversion_mode
  @bw_conversion_mode
end

#compressionObject

Compression type.



29
30
31
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 29

def compression
  @compression
end

#dpi_xObject

Horizontal resolution, in dots per inch.



32
33
34
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 32

def dpi_x
  @dpi_x
end

#dpi_yObject

Vertical resolution, in dots per inch.



35
36
37
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 35

def dpi_y
  @dpi_y
end

#pixel_formatObject

Specifies the pixel format for the generated images. Read/write ImagePixelFormat.



41
42
43
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 41

def pixel_format
  @pixel_format
end

#show_hidden_slidesObject

Specifies whether the generated document should include hidden slides or not. Default is false.



38
39
40
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 38

def show_hidden_slides
  @show_hidden_slides
end

#slides_layout_optionsObject

Slides layouting options



44
45
46
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 44

def slides_layout_options
  @slides_layout_options
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



50
51
52
53
54
55
56
57
58
59
60
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 50

def self.attribute_map
  super.merge({
    :'compression' => :'Compression',
    :'dpi_x' => :'DpiX',
    :'dpi_y' => :'DpiY',
    :'show_hidden_slides' => :'ShowHiddenSlides',
    :'pixel_format' => :'PixelFormat',
    :'slides_layout_options' => :'SlidesLayoutOptions',
    :'bw_conversion_mode' => :'BwConversionMode',
  })
end

.swagger_typesObject

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 63

def self.swagger_types
  super.merge({
    :'compression' => :'String',
    :'dpi_x' => :'Integer',
    :'dpi_y' => :'Integer',
    :'show_hidden_slides' => :'BOOLEAN',
    :'pixel_format' => :'String',
    :'slides_layout_options' => :'SlidesLayoutOptions',
    :'bw_conversion_mode' => :'String',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_regular_font == o.default_regular_font &&
      gradient_style == o.gradient_style &&
      font_fallback_rules == o.font_fallback_rules &&
      font_subst_rules == o.font_subst_rules &&
      format == o.format &&
      height == o.height &&
      width == o.width &&
      compression == o.compression &&
      dpi_x == o.dpi_x &&
      dpi_y == o.dpi_y &&
      show_hidden_slides == o.show_hidden_slides &&
      pixel_format == o.pixel_format &&
      slides_layout_options == o.slides_layout_options &&
      bw_conversion_mode == o.bw_conversion_mode
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


183
184
185
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 183

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



189
190
191
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 189

def hash
  [default_regular_font, gradient_style, font_fallback_rules, font_subst_rules, format, height, width, compression, dpi_x, dpi_y, show_hidden_slides, pixel_format, slides_layout_options, bw_conversion_mode].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



112
113
114
115
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 112

def list_invalid_properties
  invalid_properties = super
  invalid_properties
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



119
120
121
122
123
124
125
126
127
128
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 119

def valid?
  return false if !super
  compression_validator = EnumAttributeValidator.new('String', ['Default', 'None', 'CCITT3', 'CCITT4', 'LZW', 'RLE'])
  return false unless compression_validator.valid?(@compression)
  pixel_format_validator = EnumAttributeValidator.new('String', ['Format1bppIndexed', 'Format4bppIndexed', 'Format8bppIndexed', 'Format24bppRgb', 'Format32bppArgb'])
  return false unless pixel_format_validator.valid?(@pixel_format)
  bw_conversion_mode_validator = EnumAttributeValidator.new('String', ['Default', 'Dithering', 'DitheringFloydSteinberg', 'Auto', 'AutoOtsu', 'Threshold25', 'Threshold50', 'Threshold75'])
  return false unless bw_conversion_mode_validator.valid?(@bw_conversion_mode)
  true
end