class AsposeSlidesCloud::GradientFill

Represents gradient fill format

Attributes

direction[RW]

Gradient style.

is_scaled[RW]

True if the gradient is scaled.

linear_angle[RW]

Gradient angle.

shape[RW]

Gradient shape.

stops[RW]

Gradient stops.

tile_flip[RW]

Gradient flipping mode.

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Calls superclass method AsposeSlidesCloud::FillFormat::new
# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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
direction=(direction) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] direction Object to be assigned

# File lib/aspose_slides_cloud/models/gradient_fill.rb, line 172
def direction=(direction)
  validator = EnumAttributeValidator.new('String', ['FromCorner1', 'FromCorner2', 'FromCorner3', 'FromCorner4', 'FromCenter', 'NotDefined'])
  unless validator.valid?(direction)
    fail ArgumentError, 'invalid value for "direction", must be one of #{validator.allowable_values}.'
  end
  @direction = direction
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/aspose_slides_cloud/models/gradient_fill.rb, line 216
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
shape=(shape) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] shape Object to be assigned

# File lib/aspose_slides_cloud/models/gradient_fill.rb, line 182
def shape=(shape)
  validator = EnumAttributeValidator.new('String', ['Linear', 'Rectangle', 'Radial', 'Path', 'NotDefined'])
  unless validator.valid?(shape)
    fail ArgumentError, 'invalid value for "shape", must be one of #{validator.allowable_values}.'
  end
  @shape = shape
end
tile_flip=(tile_flip) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] tile_flip Object to be assigned

# File lib/aspose_slides_cloud/models/gradient_fill.rb, line 192
def tile_flip=(tile_flip)
  validator = EnumAttributeValidator.new('String', ['NoFlip', 'FlipX', 'FlipY', 'FlipBoth', 'NotDefined'])
  unless validator.valid?(tile_flip)
    fail ArgumentError, 'invalid value for "tile_flip", must be one of #{validator.allowable_values}.'
  end
  @tile_flip = tile_flip
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/aspose_slides_cloud/models/gradient_fill.rb, line 308
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/aspose_slides_cloud/models/gradient_fill.rb, line 302
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

Calls superclass method AsposeSlidesCloud::FillFormat#valid?
# 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