Class: AsposeSlidesCloud::HtmlExportOptions

Inherits:
ExportOptions show all
Defined in:
lib/aspose_slides_cloud/models/html_export_options.rb

Overview

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

Instance Attribute Summary collapse

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 = {}) ⇒ HtmlExportOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
109
110
111
112
113
114
115
116
117
 
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 82

def initialize(attributes = {})
  super

  if attributes.has_key?(:'SaveAsZip')
    self.save_as_zip = attributes[:'SaveAsZip']
  end

  if attributes.has_key?(:'SubDirectoryName')
    self.sub_directory_name = attributes[:'SubDirectoryName']
  end

  if attributes.has_key?(:'ShowHiddenSlides')
    self.show_hidden_slides = attributes[:'ShowHiddenSlides']
  end

  if attributes.has_key?(:'SvgResponsiveLayout')
    self.svg_responsive_layout = attributes[:'SvgResponsiveLayout']
  end

  if attributes.has_key?(:'JpegQuality')
    self.jpeg_quality = attributes[:'JpegQuality']
  end

  if attributes.has_key?(:'PicturesCompression')
    self.pictures_compression = attributes[:'PicturesCompression']
  end

  if attributes.has_key?(:'DeletePicturesCroppedAreas')
    self.delete_pictures_cropped_areas = attributes[:'DeletePicturesCroppedAreas']
  end

  if attributes.has_key?(:'SlidesLayoutOptions')
    self.slides_layout_options = attributes[:'SlidesLayoutOptions']
  end
  self.format = 'html'
end

Instance Attribute Details

#delete_pictures_cropped_areas ⇒ Object

A boolean flag indicates if the cropped parts remain as part of the document. If true the cropped parts will removed, if false they will be serialized in the document (which can possible lead to a larger file)



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

def delete_pictures_cropped_areas
  @delete_pictures_cropped_areas
end

#jpeg_quality ⇒ Object

Returns or sets a value determining the quality of the JPEG images inside PDF document.



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

def jpeg_quality
  @jpeg_quality
end

#pictures_compression ⇒ Object

Represents the pictures compression level



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

def pictures_compression
  @pictures_compression
end

#save_as_zip ⇒ Object

Get or sets flag for save presentation as zip file



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

def save_as_zip
  @save_as_zip
end

#show_hidden_slides ⇒ Object

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



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

def show_hidden_slides
  @show_hidden_slides
end

#slides_layout_options ⇒ Object

Slides layouting options



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

def slides_layout_options
  @slides_layout_options
end

#sub_directory_name ⇒ Object

Get or set name of subdirectory in zip-file for store external files



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

def sub_directory_name
  @sub_directory_name
end

#svg_responsive_layout ⇒ Object

True to make layout responsive by excluding width and height attributes from svg container.



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

def svg_responsive_layout
  @svg_responsive_layout
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 53

def self.attribute_map
  super.merge({
    :'save_as_zip' => :'SaveAsZip',
    :'sub_directory_name' => :'SubDirectoryName',
    :'show_hidden_slides' => :'ShowHiddenSlides',
    :'svg_responsive_layout' => :'SvgResponsiveLayout',
    :'jpeg_quality' => :'JpegQuality',
    :'pictures_compression' => :'PicturesCompression',
    :'delete_pictures_cropped_areas' => :'DeletePicturesCroppedAreas',
    :'slides_layout_options' => :'SlidesLayoutOptions',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 67

def self.swagger_types
  super.merge({
    :'save_as_zip' => :'BOOLEAN',
    :'sub_directory_name' => :'String',
    :'show_hidden_slides' => :'BOOLEAN',
    :'svg_responsive_layout' => :'BOOLEAN',
    :'jpeg_quality' => :'Integer',
    :'pictures_compression' => :'String',
    :'delete_pictures_cropped_areas' => :'BOOLEAN',
    :'slides_layout_options' => :'SlidesLayoutOptions',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 147

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 &&
      save_as_zip == o.save_as_zip &&
      sub_directory_name == o.sub_directory_name &&
      show_hidden_slides == o.show_hidden_slides &&
      svg_responsive_layout == o.svg_responsive_layout &&
      jpeg_quality == o.jpeg_quality &&
      pictures_compression == o.pictures_compression &&
      delete_pictures_cropped_areas == o.delete_pictures_cropped_areas &&
      slides_layout_options == o.slides_layout_options
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


167
168
169
 
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 167

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



173
174
175
 
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 173

def hash
  [default_regular_font, gradient_style, font_fallback_rules, font_subst_rules, format, save_as_zip, sub_directory_name, show_hidden_slides, svg_responsive_layout, jpeg_quality, pictures_compression, delete_pictures_cropped_areas, slides_layout_options].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



121
122
123
124
 
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 121

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



128
129
130
131
132
133
 
# File 'lib/aspose_slides_cloud/models/html_export_options.rb', line 128

def valid?
  return false if !super
  pictures_compression_validator = EnumAttributeValidator.new('String', ['Dpi330', 'Dpi220', 'Dpi150', 'Dpi96', 'Dpi72', 'DocumentResolution'])
  return false unless pictures_compression_validator.valid?(@pictures_compression)
  true
end