class AsposePdfCloud::ImageHeader
Represents Pdf image header.
Attributes
Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top.
Gets or sets the file name.
Gets or sets image height. Setting this image allows to scale image vertically.
Gets or sets Horizontal alignment of stamp on the page.
Gets or sets left margin of stamp.
Link
to the document.
Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0.
Gets or sets right margin of stamp.
Sets or gets the rotation of stamp content according Rotation
values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation
.None.
Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle.
Gets or sets top margin of stamp.
Gets or sets image width. Setting this property allos to scal image horizontally.
Horizontal stamp coordinate, starting from the left.
Vertical stamp coordinate, starting from the bottom.
Zooming factor of the stamp. Allows to scale stamp.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/aspose_pdf_cloud/models/image_header.rb, line 75 def self.attribute_map { :'links' => :'Links', :'background' => :'Background', :'horizontal_alignment' => :'HorizontalAlignment', :'opacity' => :'Opacity', :'rotate' => :'Rotate', :'rotate_angle' => :'RotateAngle', :'x_indent' => :'XIndent', :'y_indent' => :'YIndent', :'zoom' => :'Zoom', :'file_name' => :'FileName', :'width' => :'Width', :'height' => :'Height', :'left_margin' => :'LeftMargin', :'top_margin' => :'TopMargin', :'right_margin' => :'RightMargin' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/aspose_pdf_cloud/models/image_header.rb, line 118 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?(:'Links') if (value = attributes[:'Links']).is_a?(Array) self.links = value end end if attributes.has_key?(:'Background') self.background = attributes[:'Background'] end if attributes.has_key?(:'HorizontalAlignment') self.horizontal_alignment = attributes[:'HorizontalAlignment'] end if attributes.has_key?(:'Opacity') self.opacity = attributes[:'Opacity'] end if attributes.has_key?(:'Rotate') self.rotate = attributes[:'Rotate'] end if attributes.has_key?(:'RotateAngle') self.rotate_angle = attributes[:'RotateAngle'] end if attributes.has_key?(:'XIndent') self.x_indent = attributes[:'XIndent'] end if attributes.has_key?(:'YIndent') self.y_indent = attributes[:'YIndent'] end if attributes.has_key?(:'Zoom') self.zoom = attributes[:'Zoom'] end if attributes.has_key?(:'FileName') self.file_name = attributes[:'FileName'] end if attributes.has_key?(:'Width') self.width = attributes[:'Width'] end if attributes.has_key?(:'Height') self.height = attributes[:'Height'] end if attributes.has_key?(:'LeftMargin') self.left_margin = attributes[:'LeftMargin'] end if attributes.has_key?(:'TopMargin') self.top_margin = attributes[:'TopMargin'] end if attributes.has_key?(:'RightMargin') self.right_margin = attributes[:'RightMargin'] end end
Attribute type mapping.
# File lib/aspose_pdf_cloud/models/image_header.rb, line 96 def self.swagger_types { :'links' => :'Array<Link>', :'background' => :'BOOLEAN', :'horizontal_alignment' => :'HorizontalAlignment', :'opacity' => :'Float', :'rotate' => :'Rotation', :'rotate_angle' => :'Float', :'x_indent' => :'Float', :'y_indent' => :'Float', :'zoom' => :'Float', :'file_name' => :'String', :'width' => :'Float', :'height' => :'Float', :'left_margin' => :'Float', :'top_margin' => :'Float', :'right_margin' => :'Float' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/aspose_pdf_cloud/models/image_header.rb, line 203 def ==(o) return true if self.equal?(o) self.class == o.class && links == o.links && background == o.background && horizontal_alignment == o.horizontal_alignment && opacity == o.opacity && rotate == o.rotate && rotate_angle == o.rotate_angle && x_indent == o.x_indent && y_indent == o.y_indent && zoom == o.zoom && file_name == o.file_name && width == o.width && height == o.height && left_margin == o.left_margin && top_margin == o.top_margin && right_margin == o.right_margin end
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_header.rb, line 259 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
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_header.rb, line 325 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
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_header.rb, line 238 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
@see the `==` method @param [Object] Object to be compared
# File lib/aspose_pdf_cloud/models/image_header.rb, line 225 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/aspose_pdf_cloud/models/image_header.rb, line 231 def hash [links, background, horizontal_alignment, opacity, rotate, rotate_angle, x_indent, y_indent, zoom, file_name, width, height, left_margin, top_margin, right_margin].hash end
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_header.rb, line 190 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
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_header.rb, line 311 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 string representation of the object @return [String] String presentation of the object
# File lib/aspose_pdf_cloud/models/image_header.rb, line 299 def to_s to_hash.to_s end
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_header.rb, line 197 def valid? return true end