Class: AsposeSlidesCloud::ZoomObject

Inherits:
ShapeBase show all
Defined in:
lib/aspose_slides_cloud/models/zoom_object.rb

Overview

Zoom object.

Direct Known Subclasses

SectionZoomFrame, ZoomFrame

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from ShapeBase

#alternative_text, #alternative_text_title, #effect_format, #fill_format, #height, #hidden, #hyperlink_click, #hyperlink_mouse_over, #line_format, #name, #three_d_format, #type, #width, #x, #y, #z_order_position

Attributes inherited from ResourceBase

#alternate_links, #self_uri

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ZoomObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 89

def initialize(attributes = {})
  super

  if attributes.has_key?(:'ImageType')
    self.image_type = attributes[:'ImageType']
  end

  if attributes.has_key?(:'ReturnToParent')
    self.return_to_parent = attributes[:'ReturnToParent']
  end

  if attributes.has_key?(:'ShowBackground')
    self.show_background = attributes[:'ShowBackground']
  end

  if attributes.has_key?(:'Image')
    self.image = attributes[:'Image']
  end

  if attributes.has_key?(:'TransitionDuration')
    self.transition_duration = attributes[:'TransitionDuration']
  end
end

Instance Attribute Details

#image ⇒ Object

Internal image link for zoom object



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

def image
  @image
end

#image_type ⇒ Object

Image type of a zoom object.



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

def image_type
  @image_type
end

#return_to_parent ⇒ Object

Navigation behavior in slideshow.



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

def return_to_parent
  @return_to_parent
end

#show_background ⇒ Object

Specifies whether the Zoom will use the background of the destination slide.



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

def show_background
  @show_background
end

#transition_duration ⇒ Object

Duration of the transition between Zoom and slide.



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

def transition_duration
  @transition_duration
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 66

def self.attribute_map
  super.merge({
    :'image_type' => :'ImageType',
    :'return_to_parent' => :'ReturnToParent',
    :'show_background' => :'ShowBackground',
    :'image' => :'Image',
    :'transition_duration' => :'TransitionDuration',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 77

def self.swagger_types
  super.merge({
    :'image_type' => :'String',
    :'return_to_parent' => :'BOOLEAN',
    :'show_background' => :'BOOLEAN',
    :'image' => :'ResourceUri',
    :'transition_duration' => :'Float',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 141

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 &&
      image_type == o.image_type &&
      return_to_parent == o.return_to_parent &&
      show_background == o.show_background &&
      image == o.image &&
      transition_duration == o.transition_duration
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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 217

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
    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

#_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



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 287

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



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
210
211
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 184

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


171
172
173
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 171

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



177
178
179
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 177

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, image_type, return_to_parent, show_background, image, transition_duration].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



115
116
117
118
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 115

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



267
268
269
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 267

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



273
274
275
276
277
278
279
280
281
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 273

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



261
262
263
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 261

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



122
123
124
125
126
127
 
# File 'lib/aspose_slides_cloud/models/zoom_object.rb', line 122

def valid?
  return false if !super
  image_type_validator = EnumAttributeValidator.new('String', ['Preview', 'Cover'])
  return false unless image_type_validator.valid?(@image_type)
  true
end