class AsposeSlidesCloud::LineFormat

Line format.

Attributes

alignment[RW]

Alignment.

begin_arrow_head[RW]

Begin arrowhead.

cap_style[RW]

Cap style.

custom_dash_pattern[RW]

Custom dash pattern.

dash_style[RW]

Dash style.

end_arrow_head[RW]

End arrowhead.

fill_format[RW]

Fill format.

join_style[RW]

Join style.

miter_limit[RW]

Miter limit.

sketch_type[RW]

Sketch type.

style[RW]

Style.

width[RW]

Width.

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/line_format.rb, line 87
def self.attribute_map
  {
    :'alignment' => :'Alignment',
    :'cap_style' => :'CapStyle',
    :'dash_style' => :'DashStyle',
    :'join_style' => :'JoinStyle',
    :'style' => :'Style',
    :'sketch_type' => :'SketchType',
    :'begin_arrow_head' => :'BeginArrowHead',
    :'end_arrow_head' => :'EndArrowHead',
    :'custom_dash_pattern' => :'CustomDashPattern',
    :'fill_format' => :'FillFormat',
    :'miter_limit' => :'MiterLimit',
    :'width' => :'Width',
  }
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/line_format.rb, line 124
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?(:'Alignment')
    self.alignment = attributes[:'Alignment']
  end

  if attributes.has_key?(:'CapStyle')
    self.cap_style = attributes[:'CapStyle']
  end

  if attributes.has_key?(:'DashStyle')
    self.dash_style = attributes[:'DashStyle']
  end

  if attributes.has_key?(:'JoinStyle')
    self.join_style = attributes[:'JoinStyle']
  end

  if attributes.has_key?(:'Style')
    self.style = attributes[:'Style']
  end

  if attributes.has_key?(:'SketchType')
    self.sketch_type = attributes[:'SketchType']
  end

  if attributes.has_key?(:'BeginArrowHead')
    self.begin_arrow_head = attributes[:'BeginArrowHead']
  end

  if attributes.has_key?(:'EndArrowHead')
    self.end_arrow_head = attributes[:'EndArrowHead']
  end

  if attributes.has_key?(:'CustomDashPattern')
    self.custom_dash_pattern = attributes[:'CustomDashPattern']
  end

  if attributes.has_key?(:'FillFormat')
    self.fill_format = attributes[:'FillFormat']
  end

  if attributes.has_key?(:'MiterLimit')
    self.miter_limit = attributes[:'MiterLimit']
  end

  if attributes.has_key?(:'Width')
    self.width = attributes[:'Width']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_slides_cloud/models/line_format.rb, line 105
def self.swagger_types
  {
    :'alignment' => :'String',
    :'cap_style' => :'String',
    :'dash_style' => :'String',
    :'join_style' => :'String',
    :'style' => :'String',
    :'sketch_type' => :'String',
    :'begin_arrow_head' => :'ArrowHeadProperties',
    :'end_arrow_head' => :'ArrowHeadProperties',
    :'custom_dash_pattern' => :'CustomDashPattern',
    :'fill_format' => :'FillFormat',
    :'miter_limit' => :'Float',
    :'width' => :'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_slides_cloud/models/line_format.rb, line 266
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      alignment == o.alignment &&
      cap_style == o.cap_style &&
      dash_style == o.dash_style &&
      join_style == o.join_style &&
      style == o.style &&
      sketch_type == o.sketch_type &&
      begin_arrow_head == o.begin_arrow_head &&
      end_arrow_head == o.end_arrow_head &&
      custom_dash_pattern == o.custom_dash_pattern &&
      fill_format == o.fill_format &&
      miter_limit == o.miter_limit &&
      width == o.width
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/line_format.rb, line 331
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/line_format.rb, line 397
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
alignment=(alignment) click to toggle source

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

# File lib/aspose_slides_cloud/models/line_format.rb, line 206
def alignment=(alignment)
  validator = EnumAttributeValidator.new('String', ['Center', 'Inset', 'NotDefined'])
  unless validator.valid?(alignment)
    fail ArgumentError, 'invalid value for "alignment", must be one of #{validator.allowable_values}.'
  end
  @alignment = alignment
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/line_format.rb, line 298
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
cap_style=(cap_style) click to toggle source

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

# File lib/aspose_slides_cloud/models/line_format.rb, line 216
def cap_style=(cap_style)
  validator = EnumAttributeValidator.new('String', ['Round', 'Square', 'Flat', 'NotDefined'])
  unless validator.valid?(cap_style)
    fail ArgumentError, 'invalid value for "cap_style", must be one of #{validator.allowable_values}.'
  end
  @cap_style = cap_style
end
dash_style=(dash_style) click to toggle source

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

# File lib/aspose_slides_cloud/models/line_format.rb, line 226
def dash_style=(dash_style)
  validator = EnumAttributeValidator.new('String', ['Solid', 'Dot', 'Dash', 'LargeDash', 'DashDot', 'LargeDashDot', 'LargeDashDotDot', 'SystemDash', 'SystemDot', 'SystemDashDot', 'SystemDashDotDot', 'Custom', 'NotDefined'])
  unless validator.valid?(dash_style)
    fail ArgumentError, 'invalid value for "dash_style", must be one of #{validator.allowable_values}.'
  end
  @dash_style = dash_style
end
eql?(o) click to toggle source

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

# File lib/aspose_slides_cloud/models/line_format.rb, line 285
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/line_format.rb, line 291
def hash
  [alignment, cap_style, dash_style, join_style, style, sketch_type, begin_arrow_head, end_arrow_head, custom_dash_pattern, fill_format, miter_limit, width].hash
end
join_style=(join_style) click to toggle source

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

# File lib/aspose_slides_cloud/models/line_format.rb, line 236
def join_style=(join_style)
  validator = EnumAttributeValidator.new('String', ['Round', 'Bevel', 'Miter', 'NotDefined'])
  unless validator.valid?(join_style)
    fail ArgumentError, 'invalid value for "join_style", must be one of #{validator.allowable_values}.'
  end
  @join_style = join_style
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/line_format.rb, line 181
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
sketch_type=(sketch_type) click to toggle source

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

# File lib/aspose_slides_cloud/models/line_format.rb, line 256
def sketch_type=(sketch_type)
  validator = EnumAttributeValidator.new('String', ['None', 'Curved', 'Freehand', 'Scribble', 'NotDefined'])
  unless validator.valid?(sketch_type)
    fail ArgumentError, 'invalid value for "sketch_type", must be one of #{validator.allowable_values}.'
  end
  @sketch_type = sketch_type
end
style=(style) click to toggle source

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

# File lib/aspose_slides_cloud/models/line_format.rb, line 246
def style=(style)
  validator = EnumAttributeValidator.new('String', ['Single', 'ThinThin', 'ThinThick', 'ThickThin', 'ThickBetweenThin', 'NotDefined'])
  unless validator.valid?(style)
    fail ArgumentError, 'invalid value for "style", must be one of #{validator.allowable_values}.'
  end
  @style = style
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/line_format.rb, line 377
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/line_format.rb, line 383
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/line_format.rb, line 371
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/line_format.rb, line 188
def valid?
  alignment_validator = EnumAttributeValidator.new('String', ['Center', 'Inset', 'NotDefined'])
  return false unless alignment_validator.valid?(@alignment)
  cap_style_validator = EnumAttributeValidator.new('String', ['Round', 'Square', 'Flat', 'NotDefined'])
  return false unless cap_style_validator.valid?(@cap_style)
  dash_style_validator = EnumAttributeValidator.new('String', ['Solid', 'Dot', 'Dash', 'LargeDash', 'DashDot', 'LargeDashDot', 'LargeDashDotDot', 'SystemDash', 'SystemDot', 'SystemDashDot', 'SystemDashDotDot', 'Custom', 'NotDefined'])
  return false unless dash_style_validator.valid?(@dash_style)
  join_style_validator = EnumAttributeValidator.new('String', ['Round', 'Bevel', 'Miter', 'NotDefined'])
  return false unless join_style_validator.valid?(@join_style)
  style_validator = EnumAttributeValidator.new('String', ['Single', 'ThinThin', 'ThinThick', 'ThickThin', 'ThickBetweenThin', 'NotDefined'])
  return false unless style_validator.valid?(@style)
  sketch_type_validator = EnumAttributeValidator.new('String', ['None', 'Curved', 'Freehand', 'Scribble', 'NotDefined'])
  return false unless sketch_type_validator.valid?(@sketch_type)
  true
end