class AsposeCellsCloud::TextOptions

Attributes

color[RW]
double_size[RW]
fill[RW]

Represents fill format.

is_bold[RW]
is_italic[RW]
is_strikeout[RW]
is_subscript[RW]
is_superscript[RW]
kerning[RW]

Represents kerning.

name[RW]
outline[RW]

Represents outline format.

shadow[RW]

Represents shadow effect.

size[RW]
spacing[RW]

Represents spacing.

underline[RW]
underline_color[RW]

Represents under line color.

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/text_options.rb, line 68
def self.attribute_map
  {
    :'fill' => :'Fill',
    :'kerning' => :'Kerning',
    :'outline' => :'Outline',
    :'shadow' => :'Shadow',
    :'spacing' => :'Spacing',
    :'underline_color' => :'UnderlineColor',
    :'color' => :'Color',
    :'double_size' => :'DoubleSize',
    :'is_bold' => :'IsBold',
    :'is_italic' => :'IsItalic',
    :'is_strikeout' => :'IsStrikeout',
    :'is_subscript' => :'IsSubscript',
    :'is_superscript' => :'IsSuperscript',
    :'name' => :'Name',
    :'size' => :'Size',
    :'underline' => :'Underline'
  }
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/text_options.rb, line 113
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?(:'Fill')
      self.fill = attributes[:'Fill']
  end
  if attributes.has_key?(:'Kerning')
      self.kerning = attributes[:'Kerning']
  end
  if attributes.has_key?(:'Outline')
      self.outline = attributes[:'Outline']
  end
  if attributes.has_key?(:'Shadow')
      self.shadow = attributes[:'Shadow']
  end
  if attributes.has_key?(:'Spacing')
      self.spacing = attributes[:'Spacing']
  end
  if attributes.has_key?(:'UnderlineColor')
      self.underline_color = attributes[:'UnderlineColor']
  end
  if attributes.has_key?(:'Color')
      self.color = attributes[:'Color']
  end
  if attributes.has_key?(:'DoubleSize')
      self.double_size = attributes[:'DoubleSize']
  end
  if attributes.has_key?(:'IsBold')
      self.is_bold = attributes[:'IsBold']
  end
  if attributes.has_key?(:'IsItalic')
      self.is_italic = attributes[:'IsItalic']
  end
  if attributes.has_key?(:'IsStrikeout')
      self.is_strikeout = attributes[:'IsStrikeout']
  end
  if attributes.has_key?(:'IsSubscript')
      self.is_subscript = attributes[:'IsSubscript']
  end
  if attributes.has_key?(:'IsSuperscript')
      self.is_superscript = attributes[:'IsSuperscript']
  end
  if attributes.has_key?(:'Name')
      self.name = attributes[:'Name']
  end
  if attributes.has_key?(:'Size')
      self.size = attributes[:'Size']
  end
  if attributes.has_key?(:'Underline')
      self.underline = attributes[:'Underline']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_cells_cloud/models/text_options.rb, line 90
def self.swagger_types
  {
    :'fill' => :'FillFormat',
    :'kerning' => :'Float',
    :'outline' => :'LineFormat',
    :'shadow' => :'ShadowEffect',
    :'spacing' => :'Float',
    :'underline_color' => :'CellsColor',
    :'color' => :'Color',
    :'double_size' => :'Float',
    :'is_bold' => :'BOOLEAN',
    :'is_italic' => :'BOOLEAN',
    :'is_strikeout' => :'BOOLEAN',
    :'is_subscript' => :'BOOLEAN',
    :'is_superscript' => :'BOOLEAN',
    :'name' => :'String',
    :'size' => :'Integer',
    :'underline' => :'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/text_options.rb, line 250
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      fill == o.fill &&
      kerning == o.kerning &&
      outline == o.outline &&
      shadow == o.shadow &&
      spacing == o.spacing &&
      underline_color == o.underline_color &&
      color == o.color &&
      double_size == o.double_size &&
      is_bold == o.is_bold &&
      is_italic == o.is_italic &&
      is_strikeout == o.is_strikeout &&
      is_subscript == o.is_subscript &&
      is_superscript == o.is_superscript &&
      name == o.name &&
      size == o.size &&
      underline == o.underline 
      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/text_options.rb, line 308
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/text_options.rb, line 374
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/text_options.rb, line 287
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/text_options.rb, line 274
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/text_options.rb, line 280
def hash
  [ fill , kerning , outline , shadow , spacing , underline_color , color , double_size , is_bold , is_italic , is_strikeout , is_subscript , is_superscript , name , size , underline ].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/text_options.rb, line 172
def list_invalid_properties
  invalid_properties = Array.new
  if @fill.nil?
      invalid_properties.push("invalid value for 'fill', fill cannot be nil.")
  end
  if @kerning.nil?
      invalid_properties.push("invalid value for 'kerning', kerning cannot be nil.")
  end
  if @outline.nil?
      invalid_properties.push("invalid value for 'outline', outline cannot be nil.")
  end
  if @shadow.nil?
      invalid_properties.push("invalid value for 'shadow', shadow cannot be nil.")
  end
  if @spacing.nil?
      invalid_properties.push("invalid value for 'spacing', spacing cannot be nil.")
  end
  if @underline_color.nil?
      invalid_properties.push("invalid value for 'underline_color', underline_color cannot be nil.")
  end
  if @color.nil?
      invalid_properties.push("invalid value for 'color', color cannot be nil.")
  end
  if @double_size.nil?
      invalid_properties.push("invalid value for 'double_size', double_size cannot be nil.")
  end
  if @is_bold.nil?
      invalid_properties.push("invalid value for 'is_bold', is_bold cannot be nil.")
  end
  if @is_italic.nil?
      invalid_properties.push("invalid value for 'is_italic', is_italic cannot be nil.")
  end
  if @is_strikeout.nil?
      invalid_properties.push("invalid value for 'is_strikeout', is_strikeout cannot be nil.")
  end
  if @is_subscript.nil?
      invalid_properties.push("invalid value for 'is_subscript', is_subscript cannot be nil.")
  end
  if @is_superscript.nil?
      invalid_properties.push("invalid value for 'is_superscript', is_superscript cannot be nil.")
  end
  if @name.nil?
      invalid_properties.push("invalid value for 'name', name cannot be nil.")
  end
  if @size.nil?
      invalid_properties.push("invalid value for 'size', size cannot be nil.")
  end
  if @underline.nil?
      invalid_properties.push("invalid value for 'underline', underline 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/text_options.rb, line 354
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/text_options.rb, line 360
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/text_options.rb, line 348
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/text_options.rb, line 228
def valid?
  return false if @fill.nil?
  return false if @kerning.nil?
  return false if @outline.nil?
  return false if @shadow.nil?
  return false if @spacing.nil?
  return false if @underline_color.nil?
  return false if @color.nil?
  return false if @double_size.nil?
  return false if @is_bold.nil?
  return false if @is_italic.nil?
  return false if @is_strikeout.nil?
  return false if @is_subscript.nil?
  return false if @is_superscript.nil?
  return false if @name.nil?
  return false if @size.nil?
  return false if @underline.nil?
  return true
end