class Shotstack::HtmlAsset
The HtmlAsset
clip type lets you create text based layout and formatting using HTML and CSS. You can also set the height and width of a bounding box for the HTML content to sit within. Text and elements will wrap within the bounding box.
Attributes
Apply a background color behind the HTML bounding box using. Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.
The CSS text string to apply styling to the HTML. See list of [support CSS properties](shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
Set the width of the HTML asset bounding box in pixels. Text and elements will be masked if they exceed the height of the bounding box.
The HTML text string. See list of [supported HTML tags](shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
Place the HTML in one of nine predefined positions within the HTML area. <ul> <li>`top` - top (center)</li> <li>`topRight` - top right</li> <li>`right` - right (center)</li> <li>`bottomRight` - bottom right</li> <li>`bottom` - bottom (center)</li> <li>`bottomLeft` - bottom left</li> <li>`left` - left (center)</li> <li>`topLeft` - top left</li> <li>`center` - center</li> </ul>
The type of asset - set to `html` for HTML.
Set the width of the HTML asset bounding box in pixels. Text will wrap to fill the bounding box.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/shotstack/models/html_asset.rb, line 77 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/shotstack/models/html_asset.rb, line 64 def self.attribute_map { :'type' => :'type', :'html' => :'html', :'css' => :'css', :'width' => :'width', :'height' => :'height', :'background' => :'background', :'position' => :'position' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/shotstack/models/html_asset.rb, line 214 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/shotstack/models/html_asset.rb, line 102 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Shotstack::HtmlAsset` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Shotstack::HtmlAsset`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'type') self.type = attributes[:'type'] else self.type = 'html' end if attributes.key?(:'html') self.html = attributes[:'html'] end if attributes.key?(:'css') self.css = attributes[:'css'] end if attributes.key?(:'width') self.width = attributes[:'width'] end if attributes.key?(:'height') self.height = attributes[:'height'] end if attributes.key?(:'background') self.background = attributes[:'background'] else self.background = 'transparent' end if attributes.key?(:'position') self.position = attributes[:'position'] else self.position = 'center' end end
List of attributes with nullable: true
# File lib/shotstack/models/html_asset.rb, line 95 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/shotstack/models/html_asset.rb, line 82 def self.openapi_types { :'type' => :'String', :'html' => :'String', :'css' => :'String', :'width' => :'Integer', :'height' => :'Integer', :'background' => :'String', :'position' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/shotstack/models/html_asset.rb, line 187 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && html == o.html && css == o.css && width == o.width && height == o.height && background == o.background && position == o.position 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/shotstack/models/html_asset.rb, line 244 def _deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = Shotstack.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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/shotstack/models/html_asset.rb, line 315 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/shotstack/models/html_asset.rb, line 221 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that 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 end self end
@see the `==` method @param [Object] Object to be compared
# File lib/shotstack/models/html_asset.rb, line 201 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/shotstack/models/html_asset.rb, line 207 def hash [type, html, css, width, height, background, position].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/shotstack/models/html_asset.rb, line 152 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @html.nil? invalid_properties.push('invalid value for "html", html cannot be nil.') end invalid_properties end
Custom attribute writer method checking allowed values (enum). @param [Object] position Object to be assigned
# File lib/shotstack/models/html_asset.rb, line 177 def position=(position) validator = EnumAttributeValidator.new('String', ["top", "topRight", "right", "bottomRight", "bottom", "bottomLeft", "left", "topLeft", "center"]) unless validator.valid?(position) fail ArgumentError, "invalid value for \"position\", must be one of #{validator.allowable_values}." end @position = position end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/shotstack/models/html_asset.rb, line 297 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/shotstack/models/html_asset.rb, line 285 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/shotstack/models/html_asset.rb, line 167 def valid? return false if @type.nil? return false if @html.nil? position_validator = EnumAttributeValidator.new('String', ["top", "topRight", "right", "bottomRight", "bottom", "bottomLeft", "left", "topLeft", "center"]) return false unless position_validator.valid?(@position) true end