class AsposePdfCloud::ImageTemplate
Template of image.
Attributes
A path for image.
Image
type.
Public Class Methods
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 50 def self.attribute_map { :'image_path' => :'ImagePath', :'image_src_type' => :'ImageSrcType', :'left_margin' => :'LeftMargin', :'right_margin' => :'RightMargin', :'top_margin' => :'TopMargin', :'bottom_margin' => :'BottomMargin', :'page_width' => :'PageWidth', :'page_height' => :'PageHeight', :'margin_info' => :'MarginInfo' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 81 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?(:'ImagePath') self.image_path = attributes[:'ImagePath'] end if attributes.has_key?(:'ImageSrcType') self.image_src_type = attributes[:'ImageSrcType'] end if attributes.has_key?(:'LeftMargin') self.left_margin = attributes[:'LeftMargin'] end if attributes.has_key?(:'RightMargin') self.right_margin = attributes[:'RightMargin'] end if attributes.has_key?(:'TopMargin') self.top_margin = attributes[:'TopMargin'] end if attributes.has_key?(:'BottomMargin') self.bottom_margin = attributes[:'BottomMargin'] end if attributes.has_key?(:'PageWidth') self.page_width = attributes[:'PageWidth'] end if attributes.has_key?(:'PageHeight') self.page_height = attributes[:'PageHeight'] end if attributes.has_key?(:'MarginInfo') self.margin_info = attributes[:'MarginInfo'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 65 def self.swagger_types { :'image_path' => :'String', :'image_src_type' => :'ImageSrcType', :'left_margin' => :'Float', :'right_margin' => :'Float', :'top_margin' => :'Float', :'bottom_margin' => :'Float', :'page_width' => :'Float', :'page_height' => :'Float', :'margin_info' => :'MarginInfo' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 169 def ==(o) return true if self.equal?(o) self.class == o.class && image_path == o.image_path && image_src_type == o.image_src_type && left_margin == o.left_margin && right_margin == o.right_margin && top_margin == o.top_margin && bottom_margin == o.bottom_margin && page_width == o.page_width && page_height == o.page_height && margin_info == o.margin_info end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 219 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 285 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
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
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 198 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 185 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 191 def hash [image_path, image_src_type, left_margin, right_margin, top_margin, bottom_margin, page_width, page_height, margin_info].hash end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 155 def image_path=(image_path) if image_path.nil? fail ArgumentError, "image_path cannot be nil" end if image_path.to_s.length < 1 fail ArgumentError, "invalid value for 'image_path', the character length must be great than or equal to 1." end @image_path = image_path end
Custom attribute writer method with validation @param [Object] image_path
Value to be assigned
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 127 def list_invalid_properties invalid_properties = Array.new if @image_path.nil? invalid_properties.push("invalid value for 'image_path', image_path cannot be nil.") end if @image_path.to_s.length < 1 invalid_properties.push("invalid value for 'image_path', the character length must be great than or equal to 1.") end if @image_src_type.nil? invalid_properties.push("invalid value for 'image_src_type', image_src_type cannot be nil.") end return invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
Source
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 271 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 259 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/aspose_pdf_cloud/models/image_template.rb, line 146 def valid? return false if @image_path.nil? return false if @image_path.to_s.length < 1 return false if @image_src_type.nil? return true end
Check to see if the all the properties in the model are valid @return true if the model is valid