Class: AsposeSlidesCloud::SvgExportOptions

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

Overview

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from ExportOptions

#default_regular_font, #format

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SvgExportOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 109

def initialize(attributes = {})
  super

  if attributes.has_key?(:'VectorizeText')
    self.vectorize_text = attributes[:'VectorizeText']
  end

  if attributes.has_key?(:'MetafileRasterizationDpi')
    self.metafile_rasterization_dpi = attributes[:'MetafileRasterizationDpi']
  end

  if attributes.has_key?(:'Disable3DText')
    self.disable3_d_text = attributes[:'Disable3DText']
  end

  if attributes.has_key?(:'DisableGradientSplit')
    self.disable_gradient_split = attributes[:'DisableGradientSplit']
  end

  if attributes.has_key?(:'DisableLineEndCropping')
    self.disable_line_end_cropping = attributes[:'DisableLineEndCropping']
  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?(:'ExternalFontsHandling')
    self.external_fonts_handling = attributes[:'ExternalFontsHandling']
  end
  self.format = "svg"
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)



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

def delete_pictures_cropped_areas
  @delete_pictures_cropped_areas
end

#disable3_d_text ⇒ Object

Determines whether the 3D text is disabled in SVG.



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

def disable3_d_text
  @disable3_d_text
end

#disable_gradient_split ⇒ Object

Disables splitting FromCornerX and FromCenter gradients.



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

def disable_gradient_split
  @disable_gradient_split
end

#disable_line_end_cropping ⇒ Object

SVG 1.1 lacks ability to define insets for markers. Aspose.Slides SVG writing engine has workaround for that problem: it crops end of line with arrow, so, line doesn’t overlap markers. This option switches off such behavior.



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

def disable_line_end_cropping
  @disable_line_end_cropping
end

#external_fonts_handling ⇒ Object

Determines a way of handling externally loaded fonts.



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

def external_fonts_handling
  @external_fonts_handling
end

#jpeg_quality ⇒ Object

Determines JPEG encoding quality.



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

def jpeg_quality
  @jpeg_quality
end

#metafile_rasterization_dpi ⇒ Object

Returns or sets the lower resolution limit for metafile rasterization.



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

def metafile_rasterization_dpi
  @metafile_rasterization_dpi
end

#pictures_compression ⇒ Object

Represents the pictures compression level



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

def pictures_compression
  @pictures_compression
end

#vectorize_text ⇒ Object

Determines whether the text on a slide will be saved as graphics.



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

def vectorize_text
  @vectorize_text
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 78

def self.attribute_map
  super.merge({
    :'vectorize_text' => :'VectorizeText',
    :'metafile_rasterization_dpi' => :'MetafileRasterizationDpi',
    :'disable3_d_text' => :'Disable3DText',
    :'disable_gradient_split' => :'DisableGradientSplit',
    :'disable_line_end_cropping' => :'DisableLineEndCropping',
    :'jpeg_quality' => :'JpegQuality',
    :'pictures_compression' => :'PicturesCompression',
    :'delete_pictures_cropped_areas' => :'DeletePicturesCroppedAreas',
    :'external_fonts_handling' => :'ExternalFontsHandling',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 93

def self.swagger_types
  super.merge({
    :'vectorize_text' => :'BOOLEAN',
    :'metafile_rasterization_dpi' => :'Integer',
    :'disable3_d_text' => :'BOOLEAN',
    :'disable_gradient_split' => :'BOOLEAN',
    :'disable_line_end_cropping' => :'BOOLEAN',
    :'jpeg_quality' => :'Integer',
    :'pictures_compression' => :'String',
    :'delete_pictures_cropped_areas' => :'BOOLEAN',
    :'external_fonts_handling' => :'String',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 235

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      default_regular_font == o.default_regular_font &&
      format == o.format &&
      vectorize_text == o.vectorize_text &&
      metafile_rasterization_dpi == o.metafile_rasterization_dpi &&
      disable3_d_text == o.disable3_d_text &&
      disable_gradient_split == o.disable_gradient_split &&
      disable_line_end_cropping == o.disable_line_end_cropping &&
      jpeg_quality == o.jpeg_quality &&
      pictures_compression == o.pictures_compression &&
      delete_pictures_cropped_areas == o.delete_pictures_cropped_areas &&
      external_fonts_handling == o.external_fonts_handling
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 299

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

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 365

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 266

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


253
254
255
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



259
260
261
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 259

def hash
  [default_regular_font, format, vectorize_text, metafile_rasterization_dpi, disable3_d_text, disable_gradient_split, disable_line_end_cropping, jpeg_quality, pictures_compression, delete_pictures_cropped_areas, external_fonts_handling].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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 152

def list_invalid_properties
  invalid_properties = super
  if @vectorize_text.nil?
    invalid_properties.push('invalid value for "vectorize_text", vectorize_text cannot be nil.')
  end

  if @metafile_rasterization_dpi.nil?
    invalid_properties.push('invalid value for "metafile_rasterization_dpi", metafile_rasterization_dpi cannot be nil.')
  end

  if @disable3_d_text.nil?
    invalid_properties.push('invalid value for "disable3_d_text", disable3_d_text cannot be nil.')
  end

  if @disable_gradient_split.nil?
    invalid_properties.push('invalid value for "disable_gradient_split", disable_gradient_split cannot be nil.')
  end

  if @disable_line_end_cropping.nil?
    invalid_properties.push('invalid value for "disable_line_end_cropping", disable_line_end_cropping cannot be nil.')
  end

  if @jpeg_quality.nil?
    invalid_properties.push('invalid value for "jpeg_quality", jpeg_quality cannot be nil.')
  end

  if @pictures_compression.nil?
    invalid_properties.push('invalid value for "pictures_compression", pictures_compression cannot be nil.')
  end

  if @delete_pictures_cropped_areas.nil?
    invalid_properties.push('invalid value for "delete_pictures_cropped_areas", delete_pictures_cropped_areas cannot be nil.')
  end

  if @external_fonts_handling.nil?
    invalid_properties.push('invalid value for "external_fonts_handling", external_fonts_handling cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



345
346
347
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 345

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



351
352
353
354
355
356
357
358
359
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 351

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



339
340
341
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 339

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/aspose_slides_cloud/models/svg_export_options.rb', line 195

def valid?
  return false if !super
  return false if @vectorize_text.nil?
  return false if @metafile_rasterization_dpi.nil?
  return false if @disable3_d_text.nil?
  return false if @disable_gradient_split.nil?
  return false if @disable_line_end_cropping.nil?
  return false if @jpeg_quality.nil?
  return false if @pictures_compression.nil?
  pictures_compression_validator = EnumAttributeValidator.new('String', ['Dpi330', 'Dpi220', 'Dpi150', 'Dpi96', 'Dpi72', 'DocumentResolution'])
  return false unless pictures_compression_validator.valid?(@pictures_compression)
  return false if @delete_pictures_cropped_areas.nil?
  return false if @external_fonts_handling.nil?
  external_fonts_handling_validator = EnumAttributeValidator.new('String', ['AddLinksToFontFiles', 'Embed', 'Vectorize'])
  return false unless external_fonts_handling_validator.valid?(@external_fonts_handling)
  true
end