Class: WordsRubySdk::DrawingObject
- Inherits:
-
Object
- Object
- WordsRubySdk::DrawingObject
- Defined in:
- lib/words_ruby_sdk/models/drawing_object.rb
Overview
Represents Drawing Object DTO.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#height ⇒ Object
Height of the drawing object in points.
-
#image_data_link ⇒ Object
Link to image data.
-
#left ⇒ Object
Distance in points from the origin to the left side of the image.
-
#link ⇒ Object
Link to the document.
-
#node_id ⇒ Object
Node id.
-
#ole_data_link ⇒ Object
Link to ole object.
-
#relative_horizontal_position ⇒ Object
Specifies where the distance to the image is measured from.
-
#relative_vertical_position ⇒ Object
Specifies where the distance to the image measured from.
-
#render_links ⇒ Object
A list of links that originate from this .
-
#top ⇒ Object
Distance in points from the origin to the top side of the image.
-
#width ⇒ Object
Width of the drawing objects in points.
-
#wrap_type ⇒ Object
Specifies how to wrap text around the image.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ DrawingObject
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ DrawingObject
Initializes the object
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 184 185 186 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 130 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
Height of the drawing object in points.
41 42 43 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 41 def height @height end |
#image_data_link ⇒ Object
Link to image data. Can be null if shape does not have an image.
44 45 46 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 44 def image_data_link @image_data_link end |
#left ⇒ Object
Distance in points from the origin to the left side of the image.
47 48 49 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 47 def left @left end |
#link ⇒ Object
Link to the document.
35 36 37 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 35 def link @link end |
#node_id ⇒ Object
Node id
38 39 40 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 38 def node_id @node_id end |
#ole_data_link ⇒ Object
Link to ole object. Can be null if shape does not have ole data.
50 51 52 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 50 def ole_data_link @ole_data_link end |
#relative_horizontal_position ⇒ Object
Specifies where the distance to the image is measured from.
53 54 55 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 53 def relative_horizontal_position @relative_horizontal_position end |
#relative_vertical_position ⇒ Object
Specifies where the distance to the image measured from.
56 57 58 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 56 def relative_vertical_position @relative_vertical_position end |
#render_links ⇒ Object
A list of links that originate from this .
59 60 61 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 59 def render_links @render_links end |
#top ⇒ Object
Distance in points from the origin to the top side of the image.
62 63 64 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 62 def top @top end |
#width ⇒ Object
Width of the drawing objects in points.
65 66 67 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 65 def width @width end |
#wrap_type ⇒ Object
Specifies how to wrap text around the image.
68 69 70 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 68 def wrap_type @wrap_type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 93 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.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 111 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.
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 251 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
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 342 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 305 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 = WordsRubySdk.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
372 373 374 375 376 377 378 379 380 381 382 383 384 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 372 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
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 283 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
270 271 272 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 270 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
276 277 278 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 276 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?
190 191 192 193 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 190 def list_invalid_properties invalid_properties = [] return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
352 353 354 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 352 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
358 359 360 361 362 363 364 365 366 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 358 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
346 347 348 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 346 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
197 198 199 200 201 202 203 204 205 |
# File 'lib/words_ruby_sdk/models/drawing_object.rb', line 197 def valid? relative_horizontal_position_validator = EnumAttributeValidator.new('String', %w["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', %w["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', %w["Inline", "TopBottom", "Square", "None", "Tight", "Through"]) return false unless wrap_type_validator.valid?(@wrap_type) return true end |