Class: AsposeWordsCloud::SvgSaveOptionsData

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/svg_save_options_data.rb

Overview

Container class for svg save options.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SvgSaveOptionsData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
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
294
295
296
297
298
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
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 215

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.key?(:'AllowEmbeddingPostScriptFonts')
    self.allow_embedding_post_script_fonts = attributes[:'AllowEmbeddingPostScriptFonts']
  end

  if attributes.key?(:'CustomTimeZoneInfoData')
    self.custom_time_zone_info_data = attributes[:'CustomTimeZoneInfoData']
  end

  if attributes.key?(:'Dml3DEffectsRenderingMode')
    self.dml3_d_effects_rendering_mode = attributes[:'Dml3DEffectsRenderingMode']
  end

  if attributes.key?(:'DmlEffectsRenderingMode')
    self.dml_effects_rendering_mode = attributes[:'DmlEffectsRenderingMode']
  end

  if attributes.key?(:'DmlRenderingMode')
    self.dml_rendering_mode = attributes[:'DmlRenderingMode']
  end

  if attributes.key?(:'FileName')
    self.file_name = attributes[:'FileName']
  end

  if attributes.key?(:'FlatOpcXmlMappingOnly')
    self.flat_opc_xml_mapping_only = attributes[:'FlatOpcXmlMappingOnly']
  end

  if attributes.key?(:'ImlRenderingMode')
    self.iml_rendering_mode = attributes[:'ImlRenderingMode']
  end

  if attributes.key?(:'SaveFormat')
    self.save_format = attributes[:'SaveFormat']
  end

  if attributes.key?(:'UpdateCreatedTimeProperty')
    self.update_created_time_property = attributes[:'UpdateCreatedTimeProperty']
  end

  if attributes.key?(:'UpdateFields')
    self.update_fields = attributes[:'UpdateFields']
  end

  if attributes.key?(:'UpdateLastPrintedProperty')
    self.update_last_printed_property = attributes[:'UpdateLastPrintedProperty']
  end

  if attributes.key?(:'UpdateLastSavedTimeProperty')
    self.update_last_saved_time_property = attributes[:'UpdateLastSavedTimeProperty']
  end

  if attributes.key?(:'UpdateSdtContent')
    self.update_sdt_content = attributes[:'UpdateSdtContent']
  end

  if attributes.key?(:'ZipOutput')
    self.zip_output = attributes[:'ZipOutput']
  end

  if attributes.key?(:'ColorMode')
    self.color_mode = attributes[:'ColorMode']
  end

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

  if attributes.key?(:'MetafileRenderingOptions')
    self.metafile_rendering_options = attributes[:'MetafileRenderingOptions']
  end

  if attributes.key?(:'NumeralFormat')
    self.numeral_format = attributes[:'NumeralFormat']
  end

  if attributes.key?(:'OptimizeOutput')
    self.optimize_output = attributes[:'OptimizeOutput']
  end

  if attributes.key?(:'PageCount')
    self.page_count = attributes[:'PageCount']
  end

  if attributes.key?(:'PageIndex')
    self.page_index = attributes[:'PageIndex']
  end

  if attributes.key?(:'ExportEmbeddedImages')
    self.export_embedded_images = attributes[:'ExportEmbeddedImages']
  end

  if attributes.key?(:'FitToViewPort')
    self.fit_to_view_port = attributes[:'FitToViewPort']
  end

  if attributes.key?(:'ResourcesFolder')
    self.resources_folder = attributes[:'ResourcesFolder']
  end

  if attributes.key?(:'ResourcesFolderAlias')
    self.resources_folder_alias = attributes[:'ResourcesFolderAlias']
  end

  if attributes.key?(:'ShowPageBorder')
    self.show_page_border = attributes[:'ShowPageBorder']
  end

  if attributes.key?(:'TextOutputMode')
    self.text_output_mode = attributes[:'TextOutputMode']
  end
end

Instance Attribute Details

#allow_embedding_post_script_fontsObject

Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false..



33
34
35
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 33

def allow_embedding_post_script_fonts
  @allow_embedding_post_script_fonts
end

#color_modeObject

Gets or sets the value determining how colors are rendered. { Normal | Grayscale}.



83
84
85
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 83

def color_mode
  @color_mode
end

#custom_time_zone_info_dataObject

Gets or sets CustomTimeZoneInfo.



36
37
38
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 36

def custom_time_zone_info_data
  @custom_time_zone_info_data
end

#dml3_d_effects_rendering_modeObject

Gets or sets the value determining how 3D effects are rendered.



39
40
41
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 39

def dml3_d_effects_rendering_mode
  @dml3_d_effects_rendering_mode
end

#dml_effects_rendering_modeObject

Gets or sets the value determining how DrawingML effects are rendered. { Simplified | None | Fine }.



43
44
45
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 43

def dml_effects_rendering_mode
  @dml_effects_rendering_mode
end

#dml_rendering_modeObject

Gets or sets the option that controls how DrawingML shapes are rendered.



46
47
48
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 46

def dml_rendering_mode
  @dml_rendering_mode
end

#export_embedded_imagesObject

Gets or sets a value indicating whether images should be embedded into SVG document as base64.



106
107
108
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 106

def export_embedded_images
  @export_embedded_images
end

#file_nameObject

Gets or sets the name of destination file.



49
50
51
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 49

def file_name
  @file_name
end

#fit_to_view_portObject

Gets or sets a value indicating whether the output SVG should fill the available viewport area (browser window or container). When set to true width and height of output SVG are set to 100%.



109
110
111
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 109

def fit_to_view_port
  @fit_to_view_port
end

#flat_opc_xml_mapping_onlyObject

Gets or sets value determining which document formats are allowed to be mapped by Aspose.Words.Markup.StructuredDocumentTag.XmlMapping. By default only Aspose.Words.LoadFormat.FlatOpc document format is allowed to be mapped.



53
54
55
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 53

def flat_opc_xml_mapping_only
  @flat_opc_xml_mapping_only
end

#iml_rendering_modeObject

Gets or sets the value determining how ink (InkML) objects are rendered.



56
57
58
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 56

def iml_rendering_mode
  @iml_rendering_mode
end

#jpeg_qualityObject

Gets or sets the quality of the JPEG images inside PDF document.



86
87
88
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 86

def jpeg_quality
  @jpeg_quality
end

#metafile_rendering_optionsObject

Gets or sets the metafile rendering options.



89
90
91
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 89

def metafile_rendering_options
  @metafile_rendering_options
end

#numeral_formatObject

Gets or sets the symbol set, that is used to represent numbers while rendering to fixed page formats.



92
93
94
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 92

def numeral_format
  @numeral_format
end

#optimize_outputObject

Gets or sets a value indicating whether it is required to optimize output of XPS. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true.. The default value is false.



97
98
99
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 97

def optimize_output
  @optimize_output
end

#page_countObject

Gets or sets the number of pages to render.



100
101
102
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 100

def page_count
  @page_count
end

#page_indexObject

Gets or sets the 0-based index of the first page to render.



103
104
105
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 103

def page_index
  @page_index
end

#resources_folderObject

Gets or sets the physical folder where resources (images) are saved when exporting.



112
113
114
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 112

def resources_folder
  @resources_folder
end

#resources_folder_aliasObject

Gets or sets the name of the folder used to construct image URIs.



115
116
117
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 115

def resources_folder_alias
  @resources_folder_alias
end

#save_formatObject

Gets or sets the format of save.



59
60
61
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 59

def save_format
  @save_format
end

#show_page_borderObject

Gets or sets a value indicating whether to show or hide page stepper.



118
119
120
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 118

def show_page_border
  @show_page_border
end

#text_output_modeObject

Gets or sets the option that controls how text should be rendered.



121
122
123
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 121

def text_output_mode
  @text_output_mode
end

#update_created_time_propertyObject

Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving. Default value is false.



63
64
65
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 63

def update_created_time_property
  @update_created_time_property
end

#update_fieldsObject

Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true.



66
67
68
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 66

def update_fields
  @update_fields
end

#update_last_printed_propertyObject

Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving.



69
70
71
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 69

def update_last_printed_property
  @update_last_printed_property
end

#update_last_saved_time_propertyObject

Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving.



72
73
74
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 72

def update_last_saved_time_property
  @update_last_saved_time_property
end

#update_sdt_contentObject

Gets or sets a value indicating whether content of StructuredDocumentTag is updated before saving.



75
76
77
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 75

def update_sdt_content
  @update_sdt_content
end

#zip_outputObject

Gets or sets a value indicating whether to zip output or not. The default value is false.



79
80
81
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 79

def zip_output
  @zip_output
end

Class Method Details

.attribute_mapObject

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



146
147
148
149
150
151
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
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 146

def self.attribute_map
  {
    :'allow_embedding_post_script_fonts' => :'AllowEmbeddingPostScriptFonts',
    :'custom_time_zone_info_data' => :'CustomTimeZoneInfoData',
    :'dml3_d_effects_rendering_mode' => :'Dml3DEffectsRenderingMode',
    :'dml_effects_rendering_mode' => :'DmlEffectsRenderingMode',
    :'dml_rendering_mode' => :'DmlRenderingMode',
    :'file_name' => :'FileName',
    :'flat_opc_xml_mapping_only' => :'FlatOpcXmlMappingOnly',
    :'iml_rendering_mode' => :'ImlRenderingMode',
    :'save_format' => :'SaveFormat',
    :'update_created_time_property' => :'UpdateCreatedTimeProperty',
    :'update_fields' => :'UpdateFields',
    :'update_last_printed_property' => :'UpdateLastPrintedProperty',
    :'update_last_saved_time_property' => :'UpdateLastSavedTimeProperty',
    :'update_sdt_content' => :'UpdateSdtContent',
    :'zip_output' => :'ZipOutput',
    :'color_mode' => :'ColorMode',
    :'jpeg_quality' => :'JpegQuality',
    :'metafile_rendering_options' => :'MetafileRenderingOptions',
    :'numeral_format' => :'NumeralFormat',
    :'optimize_output' => :'OptimizeOutput',
    :'page_count' => :'PageCount',
    :'page_index' => :'PageIndex',
    :'export_embedded_images' => :'ExportEmbeddedImages',
    :'fit_to_view_port' => :'FitToViewPort',
    :'resources_folder' => :'ResourcesFolder',
    :'resources_folder_alias' => :'ResourcesFolderAlias',
    :'show_page_border' => :'ShowPageBorder',
    :'text_output_mode' => :'TextOutputMode'
  }
end

.swagger_typesObject

Attribute type mapping.



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 180

def self.swagger_types
  {
    :'allow_embedding_post_script_fonts' => :'BOOLEAN',
    :'custom_time_zone_info_data' => :'TimeZoneInfoData',
    :'dml3_d_effects_rendering_mode' => :'String',
    :'dml_effects_rendering_mode' => :'String',
    :'dml_rendering_mode' => :'String',
    :'file_name' => :'String',
    :'flat_opc_xml_mapping_only' => :'BOOLEAN',
    :'iml_rendering_mode' => :'String',
    :'save_format' => :'String',
    :'update_created_time_property' => :'BOOLEAN',
    :'update_fields' => :'BOOLEAN',
    :'update_last_printed_property' => :'BOOLEAN',
    :'update_last_saved_time_property' => :'BOOLEAN',
    :'update_sdt_content' => :'BOOLEAN',
    :'zip_output' => :'BOOLEAN',
    :'color_mode' => :'String',
    :'jpeg_quality' => :'Integer',
    :'metafile_rendering_options' => :'MetafileRenderingOptionsData',
    :'numeral_format' => :'String',
    :'optimize_output' => :'BOOLEAN',
    :'page_count' => :'Integer',
    :'page_index' => :'Integer',
    :'export_embedded_images' => :'BOOLEAN',
    :'fit_to_view_port' => :'BOOLEAN',
    :'resources_folder' => :'String',
    :'resources_folder_alias' => :'String',
    :'show_page_border' => :'BOOLEAN',
    :'text_output_mode' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 367

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      allow_embedding_post_script_fonts == other.allow_embedding_post_script_fonts &&
      custom_time_zone_info_data == other.custom_time_zone_info_data &&
      dml3_d_effects_rendering_mode == other.dml3_d_effects_rendering_mode &&
      dml_effects_rendering_mode == other.dml_effects_rendering_mode &&
      dml_rendering_mode == other.dml_rendering_mode &&
      file_name == other.file_name &&
      flat_opc_xml_mapping_only == other.flat_opc_xml_mapping_only &&
      iml_rendering_mode == other.iml_rendering_mode &&
      save_format == other.save_format &&
      update_created_time_property == other.update_created_time_property &&
      update_fields == other.update_fields &&
      update_last_printed_property == other.update_last_printed_property &&
      update_last_saved_time_property == other.update_last_saved_time_property &&
      update_sdt_content == other.update_sdt_content &&
      zip_output == other.zip_output &&
      color_mode == other.color_mode &&
      jpeg_quality == other.jpeg_quality &&
      metafile_rendering_options == other.metafile_rendering_options &&
      numeral_format == other.numeral_format &&
      optimize_output == other.optimize_output &&
      page_count == other.page_count &&
      page_index == other.page_index &&
      export_embedded_images == other.export_embedded_images &&
      fit_to_view_port == other.fit_to_view_port &&
      resources_folder == other.resources_folder &&
      resources_folder_alias == other.resources_folder_alias &&
      show_page_border == other.show_page_border &&
      text_output_mode == other.text_output_mode
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



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 437

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Time.at(/\d/.match(value)[0].to_f).to_datetime
  when :Date
    Time.at(/\d/.match(value)[0].to_f).to_date
  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 = AsposeWordsCloud.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



504
505
506
507
508
509
510
511
512
513
514
515
516
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 504

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



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 415

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    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 attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


402
403
404
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 402

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



408
409
410
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 408

def hash
  [allow_embedding_post_script_fonts, custom_time_zone_info_data, dml3_d_effects_rendering_mode, dml_effects_rendering_mode, dml_rendering_mode, file_name, flat_opc_xml_mapping_only, iml_rendering_mode, save_format, update_created_time_property, update_fields, update_last_printed_property, update_last_saved_time_property, update_sdt_content, zip_output, color_mode, jpeg_quality, metafile_rendering_options, numeral_format, optimize_output, page_count, page_index, export_embedded_images, fit_to_view_port, resources_folder, resources_folder_alias, show_page_border, text_output_mode].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons



336
337
338
339
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 336

def list_invalid_properties
  invalid_properties = []
  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



484
485
486
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 484

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



490
491
492
493
494
495
496
497
498
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 490

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



478
479
480
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 478

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



343
344
345
346
347
348
# File 'lib/aspose_words_cloud/models/svg_save_options_data.rb', line 343

def valid?
  dml3_d_effects_rendering_mode_validator = EnumAttributeValidator.new('String', ["Basic", "Advanced"])
  return false unless dml3_d_effects_rendering_mode_validator.valid?(@dml3_d_effects_rendering_mode)

  return true
end