Class: AsposeWordsCloud::DrawingObjectInsert

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

Overview

Drawing object element for insert.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DrawingObjectInsert

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
149
150
151
152
153
154
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 113

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

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

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

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

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

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

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

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

  if attributes.key?(:'AspectRatioLocked')
    self.aspect_ratio_locked = attributes[:'AspectRatioLocked']
  end
end

Instance Attribute Details

#aspect_ratio_locked ⇒ Object

Gets or sets a value indicating whether AspectRatioLocked option on or off.



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

def aspect_ratio_locked
  @aspect_ratio_locked
end

#height ⇒ Object

Gets or sets the height of the DrawingObject in points.



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

def height
  @height
end

#left ⇒ Object

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



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

def left
  @left
end

#position ⇒ Object

Gets or sets the position, where the DrawingObject will be inserted.



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

def position
  @position
end

#relative_horizontal_position ⇒ Object

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



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

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.



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

def relative_vertical_position
  @relative_vertical_position
end

#top ⇒ Object

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



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

def top
  @top
end

#width ⇒ Object

Gets or sets the width of the DrawingObjects in points.



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

def width
  @width
end

#wrap_type ⇒ Object

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



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

def wrap_type
  @wrap_type
end

Class Method Details

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 82

def self.attribute_map
  {
    :'position' => :'Position',
    :'relative_horizontal_position' => :'RelativeHorizontalPosition',
    :'left' => :'Left',
    :'relative_vertical_position' => :'RelativeVerticalPosition',
    :'top' => :'Top',
    :'width' => :'Width',
    :'height' => :'Height',
    :'wrap_type' => :'WrapType',
    :'aspect_ratio_locked' => :'AspectRatioLocked'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 97

def self.swagger_types
  {
    :'position' => :'Position',
    :'relative_horizontal_position' => :'String',
    :'left' => :'Float',
    :'relative_vertical_position' => :'String',
    :'top' => :'Float',
    :'width' => :'Float',
    :'height' => :'Float',
    :'wrap_type' => :'String',
    :'aspect_ratio_locked' => :'BOOLEAN'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 214

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



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
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 265

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
    if value[:'$type']
        type = value[:'$type'][0..-4]
    end

    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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 336

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 243

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

#collectFilesContent(resultFilesContent) ⇒ Object 



350
351
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 350

def collectFilesContent(resultFilesContent)
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


230
231
232
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 230

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



236
237
238
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 236

def hash
  [position, relative_horizontal_position, left, relative_vertical_position, top, width, height, wrap_type, aspect_ratio_locked].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



316
317
318
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 316

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



322
323
324
325
326
327
328
329
330
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 322

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



310
311
312
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 310

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



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 158

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

#validate ⇒ Object

Raises:

  • (ArgumentError) 


353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/aspose_words_cloud/models/drawing_object_insert.rb', line 353

def validate()
  raise ArgumentError, 'Property relative_horizontal_position in DrawingObjectInsert is required.' if self.relative_horizontal_position.nil?
  raise ArgumentError, 'Property left in DrawingObjectInsert is required.' if self.left.nil?
  raise ArgumentError, 'Property relative_vertical_position in DrawingObjectInsert is required.' if self.relative_vertical_position.nil?
  raise ArgumentError, 'Property top in DrawingObjectInsert is required.' if self.top.nil?
  raise ArgumentError, 'Property width in DrawingObjectInsert is required.' if self.width.nil?
  raise ArgumentError, 'Property height in DrawingObjectInsert is required.' if self.height.nil?
  raise ArgumentError, 'Property wrap_type in DrawingObjectInsert is required.' if self.wrap_type.nil?
  unless self.position.nil?
      self.position.validate
  end

end