class AsposePdfCloud::PolygonAnnotation
Provides PolygonAnnotation
.
Attributes
Color
of the annotation.
Get the annotation content.
The date and time when the annotation was created.
Gets or sets the style of second line ending.
Gets Flags of the annotation.
Gets HorizontalAlignment
of the annotation.
Gets ID of the annotation.
Gets or sets the intent of the polygon or polyline annotation.
Gets or sets the interior color with which to fill the annotation’s line endings.
Link
to the document.
The date and time when the annotation was last modified.
Gets Name of the annotation.
Gets PageIndex of the annotation.
Gets Rect of the annotation.
Get the annotation RichText.
Gets or sets the style of first line ending.
Get the annotation subject.
Get the annotation title.
Gets VerticalAlignment
of the annotation.
Gets or sets an array of points representing the horizontal and vertical coordinates of each vertex.
Gets ZIndex of the annotation.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/aspose_pdf_cloud/models/polygon_annotation.rb, line 93 def self.attribute_map { :'links' => :'Links', :'color' => :'Color', :'contents' => :'Contents', :'modified' => :'Modified', :'id' => :'Id', :'flags' => :'Flags', :'name' => :'Name', :'rect' => :'Rect', :'page_index' => :'PageIndex', :'z_index' => :'ZIndex', :'horizontal_alignment' => :'HorizontalAlignment', :'vertical_alignment' => :'VerticalAlignment', :'creation_date' => :'CreationDate', :'subject' => :'Subject', :'title' => :'Title', :'rich_text' => :'RichText', :'interior_color' => :'InteriorColor', :'starting_style' => :'StartingStyle', :'ending_style' => :'EndingStyle', :'intent' => :'Intent', :'vertices' => :'Vertices' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/aspose_pdf_cloud/models/polygon_annotation.rb, line 148 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?(:'Color') self.color = attributes[:'Color'] end if attributes.has_key?(:'Contents') self.contents = attributes[:'Contents'] end if attributes.has_key?(:'Modified') self.modified = attributes[:'Modified'] end if attributes.has_key?(:'Id') self.id = attributes[:'Id'] end if attributes.has_key?(:'Flags') if (value = attributes[:'Flags']).is_a?(Array) self.flags = value end end if attributes.has_key?(:'Name') self.name = attributes[:'Name'] end if attributes.has_key?(:'Rect') self.rect = attributes[:'Rect'] end if attributes.has_key?(:'PageIndex') self.page_index = attributes[:'PageIndex'] end if attributes.has_key?(:'ZIndex') self.z_index = attributes[:'ZIndex'] 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?(:'CreationDate') self.creation_date = attributes[:'CreationDate'] end if attributes.has_key?(:'Subject') self.subject = attributes[:'Subject'] end if attributes.has_key?(:'Title') self.title = attributes[:'Title'] end if attributes.has_key?(:'RichText') self.rich_text = attributes[:'RichText'] end if attributes.has_key?(:'InteriorColor') self.interior_color = attributes[:'InteriorColor'] end if attributes.has_key?(:'StartingStyle') self.starting_style = attributes[:'StartingStyle'] end if attributes.has_key?(:'EndingStyle') self.ending_style = attributes[:'EndingStyle'] end if attributes.has_key?(:'Intent') self.intent = attributes[:'Intent'] end if attributes.has_key?(:'Vertices') if (value = attributes[:'Vertices']).is_a?(Array) self.vertices = value end end end
Attribute type mapping.
# File lib/aspose_pdf_cloud/models/polygon_annotation.rb, line 120 def self.swagger_types { :'links' => :'Array<Link>', :'color' => :'Color', :'contents' => :'String', :'modified' => :'String', :'id' => :'String', :'flags' => :'Array<AnnotationFlags>', :'name' => :'String', :'rect' => :'Rectangle', :'page_index' => :'Integer', :'z_index' => :'Integer', :'horizontal_alignment' => :'HorizontalAlignment', :'vertical_alignment' => :'VerticalAlignment', :'creation_date' => :'String', :'subject' => :'String', :'title' => :'String', :'rich_text' => :'String', :'interior_color' => :'Color', :'starting_style' => :'LineEnding', :'ending_style' => :'LineEnding', :'intent' => :'PolyIntent', :'vertices' => :'Array<Point>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/aspose_pdf_cloud/models/polygon_annotation.rb, line 271 def ==(o) return true if self.equal?(o) self.class == o.class && links == o.links && color == o.color && contents == o.contents && modified == o.modified && id == o.id && flags == o.flags && name == o.name && rect == o.rect && page_index == o.page_index && z_index == o.z_index && horizontal_alignment == o.horizontal_alignment && vertical_alignment == o.vertical_alignment && creation_date == o.creation_date && subject == o.subject && title == o.title && rich_text == o.rich_text && interior_color == o.interior_color && starting_style == o.starting_style && ending_style == o.ending_style && intent == o.intent && vertices == o.vertices 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/polygon_annotation.rb, line 333 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/polygon_annotation.rb, line 399 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/polygon_annotation.rb, line 312 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/polygon_annotation.rb, line 299 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/aspose_pdf_cloud/models/polygon_annotation.rb, line 305 def hash [links, color, contents, modified, id, flags, name, rect, page_index, z_index, horizontal_alignment, vertical_alignment, creation_date, subject, title, rich_text, interior_color, starting_style, ending_style, intent, vertices].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/polygon_annotation.rb, line 248 def list_invalid_properties invalid_properties = Array.new if @rect.nil? invalid_properties.push("invalid value for 'rect', rect cannot be nil.") end if @vertices.nil? invalid_properties.push("invalid value for 'vertices', vertices cannot be nil.") end 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/polygon_annotation.rb, line 385 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/polygon_annotation.rb, line 373 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/polygon_annotation.rb, line 263 def valid? return false if @rect.nil? return false if @vertices.nil? return true end