Class: AsposeSlidesCloud::GradientFill

Inherits:
FillFormat
  • Object
show all
Defined in:
lib/aspose_slides_cloud/models/gradient_fill.rb

Overview

Represents gradient fill format

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from FillFormat

#type

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GradientFill

Initializes the object

Parameters:

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

    Model attributes in the form of hash



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/aspose_slides_cloud/models/gradient_fill.rb', line 94

def initialize(attributes = {})
  super

  if attributes.has_key?(:'Direction')
    self.direction = attributes[:'Direction']
  end

  if attributes.has_key?(:'Shape')
    self.shape = attributes[:'Shape']
  end

  if attributes.has_key?(:'Stops')
    if (value = attributes[:'Stops']).is_a?(Array)
      self.stops = value
    end
  end

  if attributes.has_key?(:'LinearAngle')
    self.linear_angle = attributes[:'LinearAngle']
  end

  if attributes.has_key?(:'IsScaled')
    self.is_scaled = attributes[:'IsScaled']
  end

  if attributes.has_key?(:'TileFlip')
    self.tile_flip = attributes[:'TileFlip']
  end
  self.type = "Gradient"
end

Instance Attribute Details

#directionObject

Gradient style.



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

def direction
  @direction
end

#is_scaledObject

True if the gradient is scaled.



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

def is_scaled
  @is_scaled
end

#linear_angleObject

Gradient angle.



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

def linear_angle
  @linear_angle
end

#shapeObject

Gradient shape.



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

def shape
  @shape
end

#stopsObject

Gradient stops.



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

def stops
  @stops
end

#tile_flipObject

Gradient flipping mode.



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

def tile_flip
  @tile_flip
end

Class Method Details

.attribute_mapObject

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



69
70
71
72
73
74
75
76
77
78
# File 'lib/aspose_slides_cloud/models/gradient_fill.rb', line 69

def self.attribute_map
  super.merge({
    :'direction' => :'Direction',
    :'shape' => :'Shape',
    :'stops' => :'Stops',
    :'linear_angle' => :'LinearAngle',
    :'is_scaled' => :'IsScaled',
    :'tile_flip' => :'TileFlip',
  })
end

.swagger_typesObject

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
# File 'lib/aspose_slides_cloud/models/gradient_fill.rb', line 81

def self.swagger_types
  super.merge({
    :'direction' => :'String',
    :'shape' => :'String',
    :'stops' => :'Array<GradientFillStop>',
    :'linear_angle' => :'Float',
    :'is_scaled' => :'BOOLEAN',
    :'tile_flip' => :'String',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



202
203
204
205
206
207
208
209
210
211
212
# File 'lib/aspose_slides_cloud/models/gradient_fill.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      direction == o.direction &&
      shape == o.shape &&
      stops == o.stops &&
      linear_angle == o.linear_angle &&
      is_scaled == o.is_scaled &&
      tile_flip == o.tile_flip
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



262
263
264
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
# File 'lib/aspose_slides_cloud/models/gradient_fill.rb', line 262

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



328
329
330
331
332
333
334
335
336
337
338
339
340
# File 'lib/aspose_slides_cloud/models/gradient_fill.rb', line 328

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



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

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


216
217
218
# File 'lib/aspose_slides_cloud/models/gradient_fill.rb', line 216

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



222
223
224
# File 'lib/aspose_slides_cloud/models/gradient_fill.rb', line 222

def hash
  [type, direction, shape, stops, linear_angle, is_scaled, tile_flip].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/aspose_slides_cloud/models/gradient_fill.rb', line 127

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

  if @shape.nil?
    invalid_properties.push('invalid value for "shape", shape cannot be nil.')
  end

  if @linear_angle.nil?
    invalid_properties.push('invalid value for "linear_angle", linear_angle cannot be nil.')
  end

  if @is_scaled.nil?
    invalid_properties.push('invalid value for "is_scaled", is_scaled cannot be nil.')
  end

  if @tile_flip.nil?
    invalid_properties.push('invalid value for "tile_flip", tile_flip cannot be nil.')
  end

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



308
309
310
# File 'lib/aspose_slides_cloud/models/gradient_fill.rb', line 308

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



314
315
316
317
318
319
320
321
322
# File 'lib/aspose_slides_cloud/models/gradient_fill.rb', line 314

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



302
303
304
# File 'lib/aspose_slides_cloud/models/gradient_fill.rb', line 302

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/aspose_slides_cloud/models/gradient_fill.rb', line 154

def valid?
  return false if !super
  return false if @direction.nil?
  direction_validator = EnumAttributeValidator.new('String', ['FromCorner1', 'FromCorner2', 'FromCorner3', 'FromCorner4', 'FromCenter', 'NotDefined'])
  return false unless direction_validator.valid?(@direction)
  return false if @shape.nil?
  shape_validator = EnumAttributeValidator.new('String', ['Linear', 'Rectangle', 'Radial', 'Path', 'NotDefined'])
  return false unless shape_validator.valid?(@shape)
  return false if @linear_angle.nil?
  return false if @is_scaled.nil?
  return false if @tile_flip.nil?
  tile_flip_validator = EnumAttributeValidator.new('String', ['NoFlip', 'FlipX', 'FlipY', 'FlipBoth', 'NotDefined'])
  return false unless tile_flip_validator.valid?(@tile_flip)
  true
end