Class: AsposeWordsCloud::DrawingObject

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

Overview

DTO container with a DrawingObject.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DrawingObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
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
178
179
180
181
182
183
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 128

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

  if attributes.key?(:'NodeId')
    self.node_id = attributes[:'NodeId']
  end

  if attributes.key?(:'Height')
    self.height = attributes[:'Height']
  end

  if attributes.key?(:'ImageDataLink')
    self.image_data_link = attributes[:'ImageDataLink']
  end

  if attributes.key?(:'Left')
    self.left = attributes[:'Left']
  end

  if attributes.key?(:'OleDataLink')
    self.ole_data_link = attributes[:'OleDataLink']
  end

  if attributes.key?(:'RelativeHorizontalPosition')
    self.relative_horizontal_position = attributes[:'RelativeHorizontalPosition']
  end

  if attributes.key?(:'RelativeVerticalPosition')
    self.relative_vertical_position = attributes[:'RelativeVerticalPosition']
  end

  if attributes.key?(:'RenderLinks')
    if (value = attributes[:'RenderLinks']).is_a?(Array)
      self.render_links = value
    end
  end

  if attributes.key?(:'Top')
    self.top = attributes[:'Top']
  end

  if attributes.key?(:'Width')
    self.width = attributes[:'Width']
  end

  if attributes.key?(:'WrapType')
    self.wrap_type = attributes[:'WrapType']
  end
end

Instance Attribute Details

#height ⇒ Object

Gets or sets the height of the DrawingObject in points.



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

def height
  @height
end

#image_data_link ⇒ Object

Gets or sets the link to image data. Can be null if shape does not have an image.



42
43
44
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 42

def image_data_link
  @image_data_link
end

#left ⇒ Object

Gets or sets the distance in points from the origin to the left side of the image.



45
46
47
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 45

def left
  @left
end

#link ⇒ Object

Gets or sets the link to the document.



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

def link
  @link
end

#node_id ⇒ Object

Gets or sets the node id.



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

def node_id
  @node_id
end

#ole_data_link ⇒ Object

Gets or sets the link to OLE object. Can be null if shape does not have OLE data.



48
49
50
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 48

def ole_data_link
  @ole_data_link
end

#relative_horizontal_position ⇒ Object

Gets or sets the relative horizontal position, from which the distance to the image is measured.



51
52
53
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 51

def relative_horizontal_position
  @relative_horizontal_position
end

#relative_vertical_position ⇒ Object

Gets or sets the relative vertical position, from which the distance to the image is measured.



54
55
56
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 54

def relative_vertical_position
  @relative_vertical_position
end

#render_links ⇒ Object

Gets or sets the list of links that originate from this DrawingObjectDto.



57
58
59
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 57

def render_links
  @render_links
end

#top ⇒ Object

Gets or sets the distance in points from the origin to the top side of the image.



60
61
62
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 60

def top
  @top
end

#width ⇒ Object

Gets or sets the width of the DrawingObjects in points.



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

def width
  @width
end

#wrap_type ⇒ Object

Gets or sets the option that controls how to wrap text around the image.



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

def wrap_type
  @wrap_type
end

Class Method Details

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 91

def self.attribute_map
  {
    :'link' => :'Link',
    :'node_id' => :'NodeId',
    :'height' => :'Height',
    :'image_data_link' => :'ImageDataLink',
    :'left' => :'Left',
    :'ole_data_link' => :'OleDataLink',
    :'relative_horizontal_position' => :'RelativeHorizontalPosition',
    :'relative_vertical_position' => :'RelativeVerticalPosition',
    :'render_links' => :'RenderLinks',
    :'top' => :'Top',
    :'width' => :'Width',
    :'wrap_type' => :'WrapType'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 109

def self.swagger_types
  {
    :'link' => :'WordsApiLink',
    :'node_id' => :'String',
    :'height' => :'Float',
    :'image_data_link' => :'WordsApiLink',
    :'left' => :'Float',
    :'ole_data_link' => :'WordsApiLink',
    :'relative_horizontal_position' => :'String',
    :'relative_vertical_position' => :'String',
    :'render_links' => :'Array<WordsApiLink>',
    :'top' => :'Float',
    :'width' => :'Float',
    :'wrap_type' => :'String'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 250

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      link == other.link &&
      node_id == other.node_id &&
      height == other.height &&
      image_data_link == other.image_data_link &&
      left == other.left &&
      ole_data_link == other.ole_data_link &&
      relative_horizontal_position == other.relative_horizontal_position &&
      relative_vertical_position == other.relative_vertical_position &&
      render_links == other.render_links &&
      top == other.top &&
      width == other.width &&
      wrap_type == other.wrap_type
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



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
336
337
338
339
340
341
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 304

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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 371

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 282

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


269
270
271
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 269

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



275
276
277
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 275

def hash
  [link, node_id, height, image_data_link, left, ole_data_link, relative_horizontal_position, relative_vertical_position, render_links, top, width, wrap_type].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



187
188
189
190
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 187

def list_invalid_properties
  invalid_properties = []
  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



351
352
353
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 351

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



357
358
359
360
361
362
363
364
365
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 357

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



345
346
347
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 345

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



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/aspose_words_cloud/models/drawing_object.rb', line 194

def valid?
  relative_horizontal_position_validator = EnumAttributeValidator.new('String', ["Margin", "Page", "Column", "Default", "Character", "LeftMargin", "RightMargin", "InsideMargin", "OutsideMargin"])
  return false unless relative_horizontal_position_validator.valid?(@relative_horizontal_position)
  relative_vertical_position_validator = EnumAttributeValidator.new('String', ["Margin", "TableDefault", "Page", "Paragraph", "TextFrameDefault", "Line", "TopMargin", "BottomMargin", "InsideMargin", "OutsideMargin"])
  return false unless relative_vertical_position_validator.valid?(@relative_vertical_position)
  wrap_type_validator = EnumAttributeValidator.new('String', ["Inline", "TopBottom", "Square", "None", "Tight", "Through"])
  return false unless wrap_type_validator.valid?(@wrap_type)

  return true
end