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

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 92

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?(:'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

Instance Attribute Details

#comments_area_color ⇒ Object

Gets or sets the color of comments area (Applies only if comments are displayed on the right).



53
54
55
 
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 53

def comments_area_color
  @comments_area_color
end

#comments_area_width ⇒ Object

Gets or sets the width of the comment output area in pixels (Applies only if comments are displayed on the right).



50
51
52
 
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 50

def comments_area_width
  @comments_area_width
end

#comments_position ⇒ Object

Gets or sets the position of the comments on the page.



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

def comments_position
  @comments_position
end

#compression ⇒ Object

Compression type.



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

def compression
  @compression
end

#dpi_x ⇒ Object

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_y ⇒ Object

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

#notes_position ⇒ Object

Gets or sets the position of the notes on the page.



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

def notes_position
  @notes_position
end

#pixel_format ⇒ Object

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_comments_by_no_author ⇒ Object

True if comments that have no author are displayed. (Applies only if comments are displayed).



56
57
58
 
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 56

def show_comments_by_no_author
  @show_comments_by_no_author
end

#show_hidden_slides ⇒ Object

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

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  super.merge({
    :'compression' => :'Compression',
    :'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

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 75

def self.swagger_types
  super.merge({
    :'compression' => :'String',
    :'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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 201

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_regular_font == o.default_regular_font &&
      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 &&
      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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


224
225
226
 
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



230
231
232
 
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 230

def hash
  [default_regular_font, font_fallback_rules, font_subst_rules, format, height, width, compression, 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

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



139
140
141
142
 
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 139

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



146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/aspose_slides_cloud/models/tiff_export_options.rb', line 146

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)
  notes_position_validator = EnumAttributeValidator.new('String', ['None', 'BottomFull', 'BottomTruncated'])
  return false unless notes_position_validator.valid?(@notes_position)
  comments_position_validator = EnumAttributeValidator.new('String', ['None', 'Bottom', 'Right'])
  return false unless comments_position_validator.valid?(@comments_position)
  true
end