Class: AsposeSlidesCloud::ShapeBase

Inherits:
ResourceBase show all
Defined in:
lib/aspose_slides_cloud/models/shape_base.rb

Overview

Slide shape.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from ResourceBase

#alternate_links, #self_uri

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShapeBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 143

def initialize(attributes = {})
  super

  if attributes.has_key?(:'Name')
    self.name = attributes[:'Name']
  end

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

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

  if attributes.has_key?(:'AlternativeText')
    self.alternative_text = attributes[:'AlternativeText']
  end

  if attributes.has_key?(:'AlternativeTextTitle')
    self.alternative_text_title = attributes[:'AlternativeTextTitle']
  end

  if attributes.has_key?(:'Hidden')
    self.hidden = attributes[:'Hidden']
  end

  if attributes.has_key?(:'X')
    self.x = attributes[:'X']
  end

  if attributes.has_key?(:'Y')
    self.y = attributes[:'Y']
  end

  if attributes.has_key?(:'ZOrderPosition')
    self.z_order_position = attributes[:'ZOrderPosition']
  end

  if attributes.has_key?(:'FillFormat')
    self.fill_format = attributes[:'FillFormat']
  end

  if attributes.has_key?(:'EffectFormat')
    self.effect_format = attributes[:'EffectFormat']
  end

  if attributes.has_key?(:'ThreeDFormat')
    self.three_d_format = attributes[:'ThreeDFormat']
  end

  if attributes.has_key?(:'LineFormat')
    self.line_format = attributes[:'LineFormat']
  end

  if attributes.has_key?(:'HyperlinkClick')
    self.hyperlink_click = attributes[:'HyperlinkClick']
  end

  if attributes.has_key?(:'HyperlinkMouseOver')
    self.hyperlink_mouse_over = attributes[:'HyperlinkMouseOver']
  end

  if attributes.has_key?(:'Type')
    self.type = attributes[:'Type']
  end
end

Instance Attribute Details

#alternative_text ⇒ Object

Gets or sets the alternative text.



38
39
40
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 38

def alternative_text
  @alternative_text
end

#alternative_text_title ⇒ Object

The title of alternative text associated with the shape.



41
42
43
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 41

def alternative_text_title
  @alternative_text_title
end

#effect_format ⇒ Object

Gets or sets the effect format.



59
60
61
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 59

def effect_format
  @effect_format
end

#fill_format ⇒ Object

Gets or sets the fill format.



56
57
58
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 56

def fill_format
  @fill_format
end

#height ⇒ Object

Gets or sets the height.



35
36
37
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 35

def height
  @height
end

#hidden ⇒ Object

Gets or sets a value indicating whether this ShapeBase is hidden.



44
45
46
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 44

def hidden
  @hidden
end

#hyperlink_click ⇒ Object

Hyperlink defined for mouse click.



68
69
70
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 68

def hyperlink_click
  @hyperlink_click
end

#hyperlink_mouse_over ⇒ Object

Hyperlink defined for mouse over.



71
72
73
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 71

def hyperlink_mouse_over
  @hyperlink_mouse_over
end

#line_format ⇒ Object

Gets or sets the line format.



65
66
67
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 65

def line_format
  @line_format
end

#name ⇒ Object

Gets or sets the name.



29
30
31
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 29

def name
  @name
end

#three_d_format ⇒ Object

Gets or sets the 3D format



62
63
64
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 62

def three_d_format
  @three_d_format
end

#type ⇒ Object

Returns the value of attribute type.



73
74
75
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 73

def type
  @type
end

#width ⇒ Object

Gets or sets the width.



32
33
34
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 32

def width
  @width
end

#x ⇒ Object

Gets or sets the X



47
48
49
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 47

def x
  @x
end

#y ⇒ Object

Gets or sets the Y.



50
51
52
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 50

def y
  @y
end

#z_order_position ⇒ Object

Gets z-order position of shape



53
54
55
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 53

def z_order_position
  @z_order_position
end

Class Method Details

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 98

def self.attribute_map
  super.merge({
    :'name' => :'Name',
    :'width' => :'Width',
    :'height' => :'Height',
    :'alternative_text' => :'AlternativeText',
    :'alternative_text_title' => :'AlternativeTextTitle',
    :'hidden' => :'Hidden',
    :'x' => :'X',
    :'y' => :'Y',
    :'z_order_position' => :'ZOrderPosition',
    :'fill_format' => :'FillFormat',
    :'effect_format' => :'EffectFormat',
    :'three_d_format' => :'ThreeDFormat',
    :'line_format' => :'LineFormat',
    :'hyperlink_click' => :'HyperlinkClick',
    :'hyperlink_mouse_over' => :'HyperlinkMouseOver',
    :'type' => :'Type',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 120

def self.swagger_types
  super.merge({
    :'name' => :'String',
    :'width' => :'Float',
    :'height' => :'Float',
    :'alternative_text' => :'String',
    :'alternative_text_title' => :'String',
    :'hidden' => :'BOOLEAN',
    :'x' => :'Float',
    :'y' => :'Float',
    :'z_order_position' => :'Integer',
    :'fill_format' => :'FillFormat',
    :'effect_format' => :'EffectFormat',
    :'three_d_format' => :'ThreeDFormat',
    :'line_format' => :'LineFormat',
    :'hyperlink_click' => :'Hyperlink',
    :'hyperlink_mouse_over' => :'Hyperlink',
    :'type' => :'String',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 244

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      self_uri == o.self_uri &&
      alternate_links == o.alternate_links &&
      name == o.name &&
      width == o.width &&
      height == o.height &&
      alternative_text == o.alternative_text &&
      alternative_text_title == o.alternative_text_title &&
      hidden == o.hidden &&
      x == o.x &&
      y == o.y &&
      z_order_position == o.z_order_position &&
      fill_format == o.fill_format &&
      effect_format == o.effect_format &&
      three_d_format == o.three_d_format &&
      line_format == o.line_format &&
      hyperlink_click == o.hyperlink_click &&
      hyperlink_mouse_over == o.hyperlink_mouse_over &&
      type == o.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



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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 315

def _deserialize(type, value)
  if value.nil?
    nil
  else
    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
      registry_type = AsposeSlidesCloud::TypeRegistry.get_type(type.to_s, value)
      if registry_type
        type = registry_type
      end
      temp_model = AsposeSlidesCloud.const_get(type).new
      temp_model.build_from_hash(value)
    end
  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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 389

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
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 282

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    mapKey = self.class.attribute_map[key]
    if !mapKey.nil?
      val = attributes[mapKey]
      if val.nil?
        mapKeyString = mapKey.to_s
        mapKeyString[0] = mapKeyString[0].downcase
        mapKey = mapKeyString.to_sym
        val = attributes[mapKey]
      end
      if !val.nil?
        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 val.is_a?(Array)
            self.send("#{key}=", val.map { |v| _deserialize($1, v) })
          end
        else
          self.send("#{key}=", _deserialize(type, val))
        end
      end
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


269
270
271
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



275
276
277
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 275

def hash
  [self_uri, alternate_links, name, width, height, alternative_text, alternative_text_title, hidden, x, y, z_order_position, fill_format, effect_format, three_d_format, line_format, hyperlink_click, hyperlink_mouse_over, type].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



213
214
215
216
217
218
219
220
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 213

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

  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



369
370
371
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 369

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



375
376
377
378
379
380
381
382
383
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 375

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



363
364
365
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 363

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



224
225
226
227
228
229
230
 
# File 'lib/aspose_slides_cloud/models/shape_base.rb', line 224

def valid?
  return false if !super
  return false if @z_order_position.nil?
  type_validator = EnumAttributeValidator.new('String', ['Shape', 'Chart', 'Table', 'PictureFrame', 'VideoFrame', 'AudioFrame', 'SmartArt', 'OleObjectFrame', 'GroupShape', 'GraphicalObject', 'Connector', 'SmartArtShape', 'ZoomFrame', 'SectionZoomFrame', 'SummaryZoomFrame', 'SummaryZoomSection'])
  return false unless type_validator.valid?(@type)
  true
end