class AsposeCellsCloud::LineFormat

Attributes

begin_arrowhead_length[RW]

Gets and sets the begin arrow length type of the line.

begin_arrowhead_style[RW]

Gets and sets the begin arrow type of the line.

begin_arrowhead_width[RW]

Gets and sets the begin arrow width type of the line.

cap_type[RW]

Specifies the ending caps.

compound_type[RW]

Specifies the line compound type.

dash_style[RW]

Specifies the line dash type.

end_arrowhead_length[RW]

Gets and sets the end arrow length type of the line.

end_arrowhead_style[RW]

Gets and sets the end arrow type of the line.

end_arrowhead_width[RW]

Gets and sets the end arrow width type of the line.

gradient_fill[RW]
image_data[RW]
join_type[RW]

Specifies the line join type.

pattern_fill[RW]
solid_fill[RW]
texture_fill[RW]
type[RW]
weight[RW]

Gets or sets the weight of the line in unit of points.

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/line_format.rb, line 70
def self.attribute_map
  {
    :'begin_arrowhead_length' => :'BeginArrowheadLength',
    :'begin_arrowhead_style' => :'BeginArrowheadStyle',
    :'begin_arrowhead_width' => :'BeginArrowheadWidth',
    :'cap_type' => :'CapType',
    :'compound_type' => :'CompoundType',
    :'dash_style' => :'DashStyle',
    :'end_arrowhead_length' => :'EndArrowheadLength',
    :'end_arrowhead_style' => :'EndArrowheadStyle',
    :'end_arrowhead_width' => :'EndArrowheadWidth',
    :'join_type' => :'JoinType',
    :'weight' => :'Weight',
    :'type' => :'Type',
    :'solid_fill' => :'SolidFill',
    :'pattern_fill' => :'PatternFill',
    :'texture_fill' => :'TextureFill',
    :'gradient_fill' => :'GradientFill',
    :'image_data' => :'ImageData'
  }
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/line_format.rb, line 117
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?(:'BeginArrowheadLength')
      self.begin_arrowhead_length = attributes[:'BeginArrowheadLength']
  end
  if attributes.has_key?(:'BeginArrowheadStyle')
      self.begin_arrowhead_style = attributes[:'BeginArrowheadStyle']
  end
  if attributes.has_key?(:'BeginArrowheadWidth')
      self.begin_arrowhead_width = attributes[:'BeginArrowheadWidth']
  end
  if attributes.has_key?(:'CapType')
      self.cap_type = attributes[:'CapType']
  end
  if attributes.has_key?(:'CompoundType')
      self.compound_type = attributes[:'CompoundType']
  end
  if attributes.has_key?(:'DashStyle')
      self.dash_style = attributes[:'DashStyle']
  end
  if attributes.has_key?(:'EndArrowheadLength')
      self.end_arrowhead_length = attributes[:'EndArrowheadLength']
  end
  if attributes.has_key?(:'EndArrowheadStyle')
      self.end_arrowhead_style = attributes[:'EndArrowheadStyle']
  end
  if attributes.has_key?(:'EndArrowheadWidth')
      self.end_arrowhead_width = attributes[:'EndArrowheadWidth']
  end
  if attributes.has_key?(:'JoinType')
      self.join_type = attributes[:'JoinType']
  end
  if attributes.has_key?(:'Weight')
      self.weight = attributes[:'Weight']
  end
  if attributes.has_key?(:'Type')
      self.type = attributes[:'Type']
  end
  if attributes.has_key?(:'SolidFill')
      self.solid_fill = attributes[:'SolidFill']
  end
  if attributes.has_key?(:'PatternFill')
      self.pattern_fill = attributes[:'PatternFill']
  end
  if attributes.has_key?(:'TextureFill')
      self.texture_fill = attributes[:'TextureFill']
  end
  if attributes.has_key?(:'GradientFill')
      self.gradient_fill = attributes[:'GradientFill']
  end
  if attributes.has_key?(:'ImageData')
      self.image_data = attributes[:'ImageData']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_cells_cloud/models/line_format.rb, line 93
def self.swagger_types
  {
    :'begin_arrowhead_length' => :'String',
    :'begin_arrowhead_style' => :'String',
    :'begin_arrowhead_width' => :'String',
    :'cap_type' => :'String',
    :'compound_type' => :'String',
    :'dash_style' => :'String',
    :'end_arrowhead_length' => :'String',
    :'end_arrowhead_style' => :'String',
    :'end_arrowhead_width' => :'String',
    :'join_type' => :'String',
    :'weight' => :'Float',
    :'type' => :'String',
    :'solid_fill' => :'SolidFill',
    :'pattern_fill' => :'PatternFill',
    :'texture_fill' => :'TextureFill',
    :'gradient_fill' => :'GradientFill',
    :'image_data' => :'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_cells_cloud/models/line_format.rb, line 261
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      begin_arrowhead_length == o.begin_arrowhead_length &&
      begin_arrowhead_style == o.begin_arrowhead_style &&
      begin_arrowhead_width == o.begin_arrowhead_width &&
      cap_type == o.cap_type &&
      compound_type == o.compound_type &&
      dash_style == o.dash_style &&
      end_arrowhead_length == o.end_arrowhead_length &&
      end_arrowhead_style == o.end_arrowhead_style &&
      end_arrowhead_width == o.end_arrowhead_width &&
      join_type == o.join_type &&
      weight == o.weight &&
      type == o.type &&
      solid_fill == o.solid_fill &&
      pattern_fill == o.pattern_fill &&
      texture_fill == o.texture_fill &&
      gradient_fill == o.gradient_fill &&
      image_data == o.image_data 
      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/line_format.rb, line 320
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/line_format.rb, line 386
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/line_format.rb, line 299
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/line_format.rb, line 286
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/line_format.rb, line 292
def hash
  [ begin_arrowhead_length , begin_arrowhead_style , begin_arrowhead_width , cap_type , compound_type , dash_style , end_arrowhead_length , end_arrowhead_style , end_arrowhead_width , join_type , weight , type , solid_fill , pattern_fill , texture_fill , gradient_fill , image_data ].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/line_format.rb, line 179
def list_invalid_properties
  invalid_properties = Array.new
  if @begin_arrowhead_length.nil?
      invalid_properties.push("invalid value for 'begin_arrowhead_length', begin_arrowhead_length cannot be nil.")
  end
  if @begin_arrowhead_style.nil?
      invalid_properties.push("invalid value for 'begin_arrowhead_style', begin_arrowhead_style cannot be nil.")
  end
  if @begin_arrowhead_width.nil?
      invalid_properties.push("invalid value for 'begin_arrowhead_width', begin_arrowhead_width cannot be nil.")
  end
  if @cap_type.nil?
      invalid_properties.push("invalid value for 'cap_type', cap_type cannot be nil.")
  end
  if @compound_type.nil?
      invalid_properties.push("invalid value for 'compound_type', compound_type cannot be nil.")
  end
  if @dash_style.nil?
      invalid_properties.push("invalid value for 'dash_style', dash_style cannot be nil.")
  end
  if @end_arrowhead_length.nil?
      invalid_properties.push("invalid value for 'end_arrowhead_length', end_arrowhead_length cannot be nil.")
  end
  if @end_arrowhead_style.nil?
      invalid_properties.push("invalid value for 'end_arrowhead_style', end_arrowhead_style cannot be nil.")
  end
  if @end_arrowhead_width.nil?
      invalid_properties.push("invalid value for 'end_arrowhead_width', end_arrowhead_width cannot be nil.")
  end
  if @join_type.nil?
      invalid_properties.push("invalid value for 'join_type', join_type cannot be nil.")
  end
  if @weight.nil?
      invalid_properties.push("invalid value for 'weight', weight cannot be nil.")
  end
  if @type.nil?
      invalid_properties.push("invalid value for 'type', type cannot be nil.")
  end
  if @solid_fill.nil?
      invalid_properties.push("invalid value for 'solid_fill', solid_fill cannot be nil.")
  end
  if @pattern_fill.nil?
      invalid_properties.push("invalid value for 'pattern_fill', pattern_fill cannot be nil.")
  end
  if @texture_fill.nil?
      invalid_properties.push("invalid value for 'texture_fill', texture_fill cannot be nil.")
  end
  if @gradient_fill.nil?
      invalid_properties.push("invalid value for 'gradient_fill', gradient_fill cannot be nil.")
  end
  if @image_data.nil?
      invalid_properties.push("invalid value for 'image_data', image_data 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/line_format.rb, line 366
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/line_format.rb, line 372
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/line_format.rb, line 360
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/line_format.rb, line 238
def valid?
  return false if @begin_arrowhead_length.nil?
  return false if @begin_arrowhead_style.nil?
  return false if @begin_arrowhead_width.nil?
  return false if @cap_type.nil?
  return false if @compound_type.nil?
  return false if @dash_style.nil?
  return false if @end_arrowhead_length.nil?
  return false if @end_arrowhead_style.nil?
  return false if @end_arrowhead_width.nil?
  return false if @join_type.nil?
  return false if @weight.nil?
  return false if @type.nil?
  return false if @solid_fill.nil?
  return false if @pattern_fill.nil?
  return false if @texture_fill.nil?
  return false if @gradient_fill.nil?
  return false if @image_data.nil?
  return true
end