class AsposeCellsCloud::ShadowEffect

Attributes

angle[RW]

Gets and sets the lighting angle. Range from 0 to 359.9 degrees.

blur[RW]

Gets and sets the blur of the shadow. Range from 0 to 100 points.

color[RW]

Gets and sets the color of the shadow.

distance[RW]

Gets and sets the distance of the shadow. Range from 0 to 200 points.

preset_type[RW]

Gets and sets the preset shadow type of the shadow.

size[RW]

Gets and sets the size of the shadow. Range from 0 to 2.0. Meaningless in inner shadow.

transparency[RW]

Gets and sets the degree of transparency of the shadow. Range from 0.0 (opaque) to 1.0 (clear).

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose_cells_cloud/models/shadow_effect.rb, line 50
def self.attribute_map
  {
    :'angle' => :'Angle',
    :'blur' => :'Blur',
    :'color' => :'Color',
    :'distance' => :'Distance',
    :'preset_type' => :'PresetType',
    :'size' => :'Size',
    :'transparency' => :'Transparency'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/aspose_cells_cloud/models/shadow_effect.rb, line 77
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.has_key?(:'Angle')
      self.angle = attributes[:'Angle']
  end
  if attributes.has_key?(:'Blur')
      self.blur = attributes[:'Blur']
  end
  if attributes.has_key?(:'Color')
      self.color = attributes[:'Color']
  end
  if attributes.has_key?(:'Distance')
      self.distance = attributes[:'Distance']
  end
  if attributes.has_key?(:'PresetType')
      self.preset_type = attributes[:'PresetType']
  end
  if attributes.has_key?(:'Size')
      self.size = attributes[:'Size']
  end
  if attributes.has_key?(:'Transparency')
      self.transparency = attributes[:'Transparency']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_cells_cloud/models/shadow_effect.rb, line 63
def self.swagger_types
  {
    :'angle' => :'Float',
    :'blur' => :'Float',
    :'color' => :'CellsColor',
    :'distance' => :'Float',
    :'preset_type' => :'String',
    :'size' => :'Float',
    :'transparency' => :'Float'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/aspose_cells_cloud/models/shadow_effect.rb, line 151
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      angle == o.angle &&
      blur == o.blur &&
      color == o.color &&
      distance == o.distance &&
      preset_type == o.preset_type &&
      size == o.size &&
      transparency == o.transparency 
      std_dev == o.std_dev
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_cells_cloud/models/shadow_effect.rb, line 200
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 = AsposeCellsCloud.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_cells_cloud/models/shadow_effect.rb, line 266
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_cells_cloud/models/shadow_effect.rb, line 179
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?(o) click to toggle source

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

# File lib/aspose_cells_cloud/models/shadow_effect.rb, line 166
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_cells_cloud/models/shadow_effect.rb, line 172
def hash
  [ angle , blur , color , distance , preset_type , size , transparency ].hash
end
list_invalid_properties() click to toggle source

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

# File lib/aspose_cells_cloud/models/shadow_effect.rb, line 109
def list_invalid_properties
  invalid_properties = Array.new
  if @angle.nil?
      invalid_properties.push("invalid value for 'angle', angle cannot be nil.")
  end
  if @blur.nil?
      invalid_properties.push("invalid value for 'blur', blur cannot be nil.")
  end
  if @color.nil?
      invalid_properties.push("invalid value for 'color', color cannot be nil.")
  end
  if @distance.nil?
      invalid_properties.push("invalid value for 'distance', distance cannot be nil.")
  end
  if @preset_type.nil?
      invalid_properties.push("invalid value for 'preset_type', preset_type cannot be nil.")
  end
  if @size.nil?
      invalid_properties.push("invalid value for 'size', size cannot be nil.")
  end
  if @transparency.nil?
      invalid_properties.push("invalid value for 'transparency', transparency cannot be nil.")
  end

  return invalid_properties
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_cells_cloud/models/shadow_effect.rb, line 246
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_cells_cloud/models/shadow_effect.rb, line 252
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_cells_cloud/models/shadow_effect.rb, line 240
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

# File lib/aspose_cells_cloud/models/shadow_effect.rb, line 138
def valid?
  return false if @angle.nil?
  return false if @blur.nil?
  return false if @color.nil?
  return false if @distance.nil?
  return false if @preset_type.nil?
  return false if @size.nil?
  return false if @transparency.nil?
  return true
end