class AsposeSlidesCloud::Legend

Represents a chart legend

Attributes

effect_format[RW]

Get or sets the effect format.

fill_format[RW]

Get or sets the fill format.

height[RW]

Height

line_format[RW]

Get or sets the line format.

overlay[RW]

true if other elements are allowed to overlay the legend

position[RW]

position

width[RW]

Width

x[RW]

the X location

y[RW]

the Y location

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/legend.rb, line 78
def self.attribute_map
  {
    :'position' => :'Position',
    :'x' => :'X',
    :'y' => :'Y',
    :'width' => :'Width',
    :'height' => :'Height',
    :'overlay' => :'Overlay',
    :'fill_format' => :'FillFormat',
    :'effect_format' => :'EffectFormat',
    :'line_format' => :'LineFormat',
  }
end
new(attributes = {}) click to toggle source

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

# File lib/aspose_slides_cloud/models/legend.rb, line 109
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?(:'Position')
    self.position = attributes[:'Position']
  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?(:'Width')
    self.width = attributes[:'Width']
  end

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

  if attributes.has_key?(:'Overlay')
    self.overlay = attributes[:'Overlay']
  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?(:'LineFormat')
    self.line_format = attributes[:'LineFormat']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_slides_cloud/models/legend.rb, line 93
def self.swagger_types
  {
    :'position' => :'String',
    :'x' => :'Float',
    :'y' => :'Float',
    :'width' => :'Float',
    :'height' => :'Float',
    :'overlay' => :'BOOLEAN',
    :'fill_format' => :'FillFormat',
    :'effect_format' => :'EffectFormat',
    :'line_format' => :'LineFormat',
  }
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/legend.rb, line 179
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      position == o.position &&
      x == o.x &&
      y == o.y &&
      width == o.width &&
      height == o.height &&
      overlay == o.overlay &&
      fill_format == o.fill_format &&
      effect_format == o.effect_format &&
      line_format == o.line_format
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/legend.rb, line 241
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) 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/legend.rb, line 311
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/legend.rb, line 208
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) click to toggle source

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

# File lib/aspose_slides_cloud/models/legend.rb, line 195
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/legend.rb, line 201
def hash
  [position, x, y, width, height, overlay, fill_format, effect_format, line_format].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/legend.rb, line 154
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
position=(position) click to toggle source

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

# File lib/aspose_slides_cloud/models/legend.rb, line 169
def position=(position)
  validator = EnumAttributeValidator.new('String', ['Bottom', 'Left', 'Right', 'Top', 'TopRight'])
  unless validator.valid?(position)
    fail ArgumentError, 'invalid value for "position", must be one of #{validator.allowable_values}.'
  end
  @position = position
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/legend.rb, line 291
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/legend.rb, line 297
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/legend.rb, line 285
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_slides_cloud/models/legend.rb, line 161
def valid?
  position_validator = EnumAttributeValidator.new('String', ['Bottom', 'Left', 'Right', 'Top', 'TopRight'])
  return false unless position_validator.valid?(@position)
  true
end