class AsposeWordsCloud::DrawingObjectInsert
Drawing object element for insert.
Attributes
Gets or sets a value indicating whether AspectRatioLocked option on or off.
Gets or sets the height of the DrawingObject
in points.
Gets or sets the distance in points from the origin to the left side of the image.
Gets or sets the position, where the DrawingObject
will be inserted.
Gets or sets the relative horizontal position, from which the distance to the image is measured.
Gets or sets the relative vertical position, from which the distance to the image is measured.
Gets or sets the distance in points from the origin to the top side of the image.
Gets or sets the width of the DrawingObjects in points.
Gets or sets the option indicating how to wrap text around the image.
Public Class Methods
Source
# File lib/aspose_words_cloud/models/drawing_object_insert.rb, line 82 def self.attribute_map { :'position' => :'Position', :'relative_horizontal_position' => :'RelativeHorizontalPosition', :'left' => :'Left', :'relative_vertical_position' => :'RelativeVerticalPosition', :'top' => :'Top', :'width' => :'Width', :'height' => :'Height', :'wrap_type' => :'WrapType', :'aspect_ratio_locked' => :'AspectRatioLocked' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/aspose_words_cloud/models/drawing_object_insert.rb, line 113 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.key?(:'Position') self.position = attributes[:'Position'] end if attributes.key?(:'RelativeHorizontalPosition') self.relative_horizontal_position = attributes[:'RelativeHorizontalPosition'] end if attributes.key?(:'Left') self.left = attributes[:'Left'] end if attributes.key?(:'RelativeVerticalPosition') self.relative_vertical_position = attributes[:'RelativeVerticalPosition'] end if attributes.key?(:'Top') self.top = attributes[:'Top'] end if attributes.key?(:'Width') self.width = attributes[:'Width'] end if attributes.key?(:'Height') self.height = attributes[:'Height'] end if attributes.key?(:'WrapType') self.wrap_type = attributes[:'WrapType'] end if attributes.key?(:'AspectRatioLocked') self.aspect_ratio_locked = attributes[:'AspectRatioLocked'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/aspose_words_cloud/models/drawing_object_insert.rb, line 97 def self.swagger_types { :'position' => :'Position', :'relative_horizontal_position' => :'String', :'left' => :'Float', :'relative_vertical_position' => :'String', :'top' => :'Float', :'width' => :'Float', :'height' => :'Float', :'wrap_type' => :'String', :'aspect_ratio_locked' => :'BOOLEAN' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/aspose_words_cloud/models/drawing_object_insert.rb, line 214 def ==(other) return true if self.equal?(other) self.class == other.class && position == other.position && relative_horizontal_position == other.relative_horizontal_position && left == other.left && relative_vertical_position == other.relative_vertical_position && top == other.top && width == other.width && height == other.height && wrap_type == other.wrap_type && aspect_ratio_locked == other.aspect_ratio_locked end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/aspose_words_cloud/models/drawing_object_insert.rb, line 265 def _deserialize(type, value) case type.to_sym when :DateTime Time.at(/\d/.match(value)[0].to_f).to_datetime when :Date Time.at(/\d/.match(value)[0].to_f).to_date 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 if value[:'$type'] type = value[:'$type'][0..-4] end temp_model = AsposeWordsCloud.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_words_cloud/models/drawing_object_insert.rb, line 336 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_words_cloud/models/drawing_object_insert.rb, line 243 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_words_cloud/models/drawing_object_insert.rb, line 350 def collectFilesContent(resultFilesContent) end
Source
# File lib/aspose_words_cloud/models/drawing_object_insert.rb, line 230 def eql?(other) self == other end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/aspose_words_cloud/models/drawing_object_insert.rb, line 236 def hash [position, relative_horizontal_position, left, relative_vertical_position, top, width, height, wrap_type, aspect_ratio_locked].hash end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
Source
# File lib/aspose_words_cloud/models/drawing_object_insert.rb, line 171 def relative_horizontal_position=(relative_horizontal_position) validator = EnumAttributeValidator.new('String', ["Margin", "Page", "Column", "Default", "Character", "LeftMargin", "RightMargin", "InsideMargin", "OutsideMargin"]) if relative_horizontal_position.to_i == 0 unless validator.valid?(relative_horizontal_position) raise ArgumentError, "invalid value for 'relative_horizontal_position', must be one of #{validator.allowable_values}." end @relative_horizontal_position = relative_horizontal_position else @relative_horizontal_position = validator.allowable_values[relative_horizontal_position.to_i] end end
Custom attribute writer method checking allowed values (enum). @param [Object] relative_horizontal_position
Object to be assigned
Source
# File lib/aspose_words_cloud/models/drawing_object_insert.rb, line 185 def relative_vertical_position=(relative_vertical_position) validator = EnumAttributeValidator.new('String', ["Margin", "TableDefault", "Page", "Paragraph", "TextFrameDefault", "Line", "TopMargin", "BottomMargin", "InsideMargin", "OutsideMargin"]) if relative_vertical_position.to_i == 0 unless validator.valid?(relative_vertical_position) raise ArgumentError, "invalid value for 'relative_vertical_position', must be one of #{validator.allowable_values}." end @relative_vertical_position = relative_vertical_position else @relative_vertical_position = validator.allowable_values[relative_vertical_position.to_i] end end
Custom attribute writer method checking allowed values (enum). @param [Object] relative_vertical_position
Object to be assigned
Source
Source
# File lib/aspose_words_cloud/models/drawing_object_insert.rb, line 322 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_words_cloud/models/drawing_object_insert.rb, line 310 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_words_cloud/models/drawing_object_insert.rb, line 158 def valid? relative_horizontal_position_validator = EnumAttributeValidator.new('String', ["Margin", "Page", "Column", "Default", "Character", "LeftMargin", "RightMargin", "InsideMargin", "OutsideMargin"]) return false unless relative_horizontal_position_validator.valid?(@relative_horizontal_position) relative_vertical_position_validator = EnumAttributeValidator.new('String', ["Margin", "TableDefault", "Page", "Paragraph", "TextFrameDefault", "Line", "TopMargin", "BottomMargin", "InsideMargin", "OutsideMargin"]) return false unless relative_vertical_position_validator.valid?(@relative_vertical_position) wrap_type_validator = EnumAttributeValidator.new('String', ["Inline", "TopBottom", "Square", "None", "Tight", "Through"]) return false unless wrap_type_validator.valid?(@wrap_type) return true end
Check to see if the all the properties in the model are valid @return true if the model is valid
Source
# File lib/aspose_words_cloud/models/drawing_object_insert.rb, line 353 def validate() raise ArgumentError, 'Property relative_horizontal_position in DrawingObjectInsert is required.' if self.relative_horizontal_position.nil? raise ArgumentError, 'Property left in DrawingObjectInsert is required.' if self.left.nil? raise ArgumentError, 'Property relative_vertical_position in DrawingObjectInsert is required.' if self.relative_vertical_position.nil? raise ArgumentError, 'Property top in DrawingObjectInsert is required.' if self.top.nil? raise ArgumentError, 'Property width in DrawingObjectInsert is required.' if self.width.nil? raise ArgumentError, 'Property height in DrawingObjectInsert is required.' if self.height.nil? raise ArgumentError, 'Property wrap_type in DrawingObjectInsert is required.' if self.wrap_type.nil? unless self.position.nil? self.position.validate end end
Source
# File lib/aspose_words_cloud/models/drawing_object_insert.rb, line 199 def wrap_type=(wrap_type) validator = EnumAttributeValidator.new('String', ["Inline", "TopBottom", "Square", "None", "Tight", "Through"]) if wrap_type.to_i == 0 unless validator.valid?(wrap_type) raise ArgumentError, "invalid value for 'wrap_type', must be one of #{validator.allowable_values}." end @wrap_type = wrap_type else @wrap_type = validator.allowable_values[wrap_type.to_i] end end
Custom attribute writer method checking allowed values (enum). @param [Object] wrap_type
Object to be assigned