Class: LWS::DigitalSignage::Layout::Element
- Inherits:
-
Generic::Model
- Object
- Spyke::Base
- Generic::Model
- LWS::DigitalSignage::Layout::Element
- Defined in:
- lib/lws/apps/digital_signage.rb
Overview
This class is only used within the context of the Version class.
The layout element class
Defined Under Namespace
Classes: Customizable, Property
Instance Attribute Summary collapse
-
#asset_storage_ids ⇒ Array<String>
The storage IDs of the assets of the layout element.
-
#asset_urls ⇒ Array<Hash{String => String}>
This is a list of mappings of the asset filename (key “filename”) to the asset URL (key “url”).
-
#customizables ⇒ Array<Layout::Element::Customizable>
The customizable properties of the layout element.
-
#definition ⇒ Hash
The (plugin) component definition of the layout element.
-
#index ⇒ Integer?
The index of the element within the list of layout elements of the associated layout version.
-
#klass ⇒ String
The class of the layout element.
-
#parent ⇒ Layout?
The parent of the layout element.
-
#parent_id ⇒ Integer?
The ID of the parent of the layout element.
-
#properties ⇒ Array<Layout::Element::Property>
The properties of the layout element.
-
#title ⇒ String?
The title of the layout element.
-
#version ⇒ Layout::Verion
The layout version that contains the element.
Attributes inherited from Generic::Model
#created_at, #id, #updated_at, #url, #url_html
Method Summary
Methods inherited from Generic::Model
#deep_dup, #dig, #reload, #rollback, #save
Instance Attribute Details
#asset_storage_ids ⇒ Array<String>
Returns the storage IDs of the assets of the layout element.
647 |
# File 'lib/lws/apps/digital_signage.rb', line 647 attribute :asset_storage_ids |
#asset_urls ⇒ Array<Hash{String => String}>
This is a list of mappings of the asset filename (key “filename”) to the asset URL (key “url”).
654 |
# File 'lib/lws/apps/digital_signage.rb', line 654 attribute :asset_urls |
#customizables ⇒ Array<Layout::Element::Customizable>
Returns the customizable properties of the layout element.
659 |
# File 'lib/lws/apps/digital_signage.rb', line 659 has_many :customizables, class_name: "LWS::DigitalSignage::Layout::Element::Customizable" |
#definition ⇒ Hash
This attribute is only available if the token is of an account with sysadmin permissions
Returns the (plugin) component definition of the layout element.
665 |
# File 'lib/lws/apps/digital_signage.rb', line 665 attribute :definition |
#index ⇒ Integer?
Returns the index of the element within the list of layout elements of the associated layout version.
670 |
# File 'lib/lws/apps/digital_signage.rb', line 670 attribute :index |
#klass ⇒ String
Returns the class of the layout element.
674 |
# File 'lib/lws/apps/digital_signage.rb', line 674 attribute :klass |
#parent ⇒ Layout?
Returns the parent of the layout element.
679 680 |
# File 'lib/lws/apps/digital_signage.rb', line 679 belongs_to :parent, class_name: "LWS::DigitalSignage::Layout::Element", foreign_key: :parent_id |
#parent_id ⇒ Integer?
Returns the ID of the parent of the layout element.
684 |
# File 'lib/lws/apps/digital_signage.rb', line 684 attribute :parent_id |
#properties ⇒ Array<Layout::Element::Property>
Returns the properties of the layout element.
689 |
# File 'lib/lws/apps/digital_signage.rb', line 689 has_many :properties, class_name: "LWS::DigitalSignage::Layout::Element::Property" |
#title ⇒ String?
Returns the title of the layout element.
693 |
# File 'lib/lws/apps/digital_signage.rb', line 693 attribute :title |
#version ⇒ Layout::Verion
Returns the layout version that contains the element.
698 699 |
# File 'lib/lws/apps/digital_signage.rb', line 698 belongs_to :version, class_name: "LWS::DigitalSignage::Layout::Version", foreign_key: :layout_version_id |