Class: AsposeDiagramCloud::SVGSaveOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/AsposeDiagramCloud/models/svg_save_options.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SVGSaveOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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.has_key?(:'SaveFormat')
    self.save_format = attributes[:'SaveFormat']
  end

  if attributes.has_key?(:'DefaultFont')
    self.default_font = attributes[:'DefaultFont']
  end

  if attributes.has_key?(:'Area')
    self.area = attributes[:'Area']
  end

  if attributes.has_key?(:'ExportGuideShapes')
    self.export_guide_shapes = attributes[:'ExportGuideShapes']
  end

  if attributes.has_key?(:'PageSize')
    self.page_size = attributes[:'PageSize']
  end

  if attributes.has_key?(:'IsExportComments')
    self.is_export_comments = attributes[:'IsExportComments']
  end

  if attributes.has_key?(:'ExportHiddenPage')
    self.export_hidden_page = attributes[:'ExportHiddenPage']
  end

  if attributes.has_key?(:'Quality')
    self.quality = attributes[:'Quality']
  end

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

  if attributes.has_key?(:'SVGFitToViewPort')
    self.svg_fit_to_view_port = attributes[:'SVGFitToViewPort']
  end

  if attributes.has_key?(:'ExportElementAsRectTag')
    self.export_element_as_rect_tag = attributes[:'ExportElementAsRectTag']
  end

end

Instance Attribute Details

#area ⇒ Object

Returns the value of attribute area.



22
23
24
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 22

def area
  @area
end

#default_font ⇒ Object

Returns the value of attribute default_font.



20
21
22
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 20

def default_font
  @default_font
end

#export_element_as_rect_tag ⇒ Object

Returns the value of attribute export_element_as_rect_tag.



38
39
40
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 38

def export_element_as_rect_tag
  @export_element_as_rect_tag
end

#export_guide_shapes ⇒ Object

Returns the value of attribute export_guide_shapes.



24
25
26
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 24

def export_guide_shapes
  @export_guide_shapes
end

#export_hidden_page ⇒ Object

Returns the value of attribute export_hidden_page.



30
31
32
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 30

def export_hidden_page
  @export_hidden_page
end

#is_export_comments ⇒ Object

Returns the value of attribute is_export_comments.



28
29
30
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 28

def is_export_comments
  @is_export_comments
end

#page_index ⇒ Object

Returns the value of attribute page_index.



34
35
36
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 34

def page_index
  @page_index
end

#page_size ⇒ Object

Returns the value of attribute page_size.



26
27
28
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 26

def page_size
  @page_size
end

#quality ⇒ Object

Returns the value of attribute quality.



32
33
34
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 32

def quality
  @quality
end

#save_format ⇒ Object

Returns the value of attribute save_format.



18
19
20
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 18

def save_format
  @save_format
end

#svg_fit_to_view_port ⇒ Object

Returns the value of attribute svg_fit_to_view_port.



36
37
38
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 36

def svg_fit_to_view_port
  @svg_fit_to_view_port
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 63

def self.attribute_map
  {
    :'save_format' => :'SaveFormat',
    :'default_font' => :'DefaultFont',
    :'area' => :'Area',
    :'export_guide_shapes' => :'ExportGuideShapes',
    :'page_size' => :'PageSize',
    :'is_export_comments' => :'IsExportComments',
    :'export_hidden_page' => :'ExportHiddenPage',
    :'quality' => :'Quality',
    :'page_index' => :'PageIndex',
    :'svg_fit_to_view_port' => :'SVGFitToViewPort',
    :'export_element_as_rect_tag' => :'ExportElementAsRectTag'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 80

def self.swagger_types
  {
    :'save_format' => :'String',
    :'default_font' => :'String',
    :'area' => :'RectangleF',
    :'export_guide_shapes' => :'BOOLEAN',
    :'page_size' => :'PageSize',
    :'is_export_comments' => :'BOOLEAN',
    :'export_hidden_page' => :'BOOLEAN',
    :'quality' => :'Integer',
    :'page_index' => :'Integer',
    :'svg_fit_to_view_port' => :'BOOLEAN',
    :'export_element_as_rect_tag' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      save_format == o.save_format &&
      default_font == o.default_font &&
      area == o.area &&
      export_guide_shapes == o.export_guide_shapes &&
      page_size == o.page_size &&
      is_export_comments == o.is_export_comments &&
      export_hidden_page == o.export_hidden_page &&
      quality == o.quality &&
      page_index == o.page_index &&
      svg_fit_to_view_port == o.svg_fit_to_view_port &&
      export_element_as_rect_tag == o.export_element_as_rect_tag
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



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
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 239

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 = AsposeDiagramCloud.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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 305

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 218

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?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


205
206
207
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



211
212
213
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 211

def hash
  [save_format, default_font, area, export_guide_shapes, page_size, is_export_comments, export_hidden_page, quality, page_index, svg_fit_to_view_port, export_element_as_rect_tag].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 152

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

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

  return 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



285
286
287
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 285

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



291
292
293
294
295
296
297
298
299
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 291

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



279
280
281
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 279

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



167
168
169
170
171
172
173
 
# File 'lib/AsposeDiagramCloud/models/svg_save_options.rb', line 167

def valid?
  return false if @save_format.nil?
  save_format_validator = EnumAttributeValidator.new('String', ["VDX", "VSX", "VTX", "TIFF", "PNG", "BMP", "EMF", "JPEG", "PDF", "XPS", "GIF", "HTML", "SVG", "SWF", "XAML", "VSDX", "VSTX", "VSSX", "VSDM", "VSSM", "VSTM"])
  return false unless save_format_validator.valid?(@save_format)
  return false if @area.nil?
  return true
end