class AsposePdfCloud::ImageFragment

Represents Image Fragment DTO.

Attributes

fix_height[RW]

Gets or sets fix height of the image.

fix_width[RW]

Gets or sets fix width of the image.

horizontal_alignment[RW]

Gets or sets horizontal alignment of the image.

image_file[RW]

Gets or sets full storage path of image.

image_scale[RW]

Gets or sets ImageScale of the image.

margin[RW]

Gets or sets Margin of the image.

vertical_alignment[RW]

Gets or sets vertical alignment of the image.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose_pdf_cloud/models/image_fragment.rb, line 51
def self.attribute_map
  {
    :'image_file' => :'ImageFile',
    :'fix_width' => :'FixWidth',
    :'fix_height' => :'FixHeight',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'vertical_alignment' => :'VerticalAlignment',
    :'image_scale' => :'ImageScale',
    :'margin' => :'Margin'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/aspose_pdf_cloud/models/image_fragment.rb, line 78
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?(:'ImageFile')
    self.image_file = attributes[:'ImageFile']
  end

  if attributes.has_key?(:'FixWidth')
    self.fix_width = attributes[:'FixWidth']
  end

  if attributes.has_key?(:'FixHeight')
    self.fix_height = attributes[:'FixHeight']
  end

  if attributes.has_key?(:'HorizontalAlignment')
    self.horizontal_alignment = attributes[:'HorizontalAlignment']
  end

  if attributes.has_key?(:'VerticalAlignment')
    self.vertical_alignment = attributes[:'VerticalAlignment']
  end

  if attributes.has_key?(:'ImageScale')
    self.image_scale = attributes[:'ImageScale']
  end

  if attributes.has_key?(:'Margin')
    self.margin = attributes[:'Margin']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_pdf_cloud/models/image_fragment.rb, line 64
def self.swagger_types
  {
    :'image_file' => :'String',
    :'fix_width' => :'Float',
    :'fix_height' => :'Float',
    :'horizontal_alignment' => :'HorizontalAlignment',
    :'vertical_alignment' => :'VerticalAlignment',
    :'image_scale' => :'Float',
    :'margin' => :'MarginInfo'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/aspose_pdf_cloud/models/image_fragment.rb, line 153
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      image_file == o.image_file &&
      fix_width == o.fix_width &&
      fix_height == o.fix_height &&
      horizontal_alignment == o.horizontal_alignment &&
      vertical_alignment == o.vertical_alignment &&
      image_scale == o.image_scale &&
      margin == o.margin
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_pdf_cloud/models/image_fragment.rb, line 201
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 = AsposePdfCloud.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_pdf_cloud/models/image_fragment.rb, line 267
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_pdf_cloud/models/image_fragment.rb, line 180
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_pdf_cloud/models/image_fragment.rb, line 167
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_pdf_cloud/models/image_fragment.rb, line 173
def hash
  [image_file, fix_width, fix_height, horizontal_alignment, vertical_alignment, image_scale, margin].hash
end
image_file=(image_file) click to toggle source

Custom attribute writer method with validation @param [Object] image_file Value to be assigned

# File lib/aspose_pdf_cloud/models/image_fragment.rb, line 139
def image_file=(image_file)
  if image_file.nil?
    fail ArgumentError, "image_file cannot be nil"
  end

  if image_file.to_s.length < 1
    fail ArgumentError, "invalid value for 'image_file', the character length must be great than or equal to 1."
  end

  @image_file = image_file
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_pdf_cloud/models/image_fragment.rb, line 116
def list_invalid_properties
  invalid_properties = Array.new
  if @image_file.nil?
    invalid_properties.push("invalid value for 'image_file', image_file cannot be nil.")
  end

  if @image_file.to_s.length < 1
    invalid_properties.push("invalid value for 'image_file', the character length must be great than or equal to 1.")
  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_pdf_cloud/models/image_fragment.rb, line 247
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_pdf_cloud/models/image_fragment.rb, line 253
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_pdf_cloud/models/image_fragment.rb, line 241
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_pdf_cloud/models/image_fragment.rb, line 131
def valid?
  return false if @image_file.nil?
  return false if @image_file.to_s.length < 1
  return true
end