Class: LWS::DigitalSignage::Layout::Element

Inherits:
Generic::Model
  • Object
show all
Defined in:
lib/lws/apps/digital_signage.rb

Overview

Note:

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

Attributes inherited from Generic::Model

#created_at, #id, #updated_at, #url, #url_html

Method Summary

Methods inherited from Generic::Model

#dig, #reload, #rollback, #save

Instance Attribute Details

#asset_storage_idsArray<String>

Returns the storage IDs of the assets of the layout element.

Returns:

  • (Array<String>)

    the storage IDs of the assets of the layout element



589
# File 'lib/lws/apps/digital_signage.rb', line 589

attribute :asset_storage_ids

#asset_urlsArray<Hash{String => String}>

This is a list of mappings of the asset filename (key “filename”) to the asset URL (key “url”).

Returns:

  • (Array<Hash{String => String}>)

    the assets of the layout element



596
# File 'lib/lws/apps/digital_signage.rb', line 596

attribute :asset_urls

#customizablesArray<Layout::Element::Customizable>

Returns the customizable properties of the layout element.

Returns:



601
# File 'lib/lws/apps/digital_signage.rb', line 601

has_many :customizables, class_name: "LWS::DigitalSignage::Layout::Element::Customizable"

#indexInteger?

Returns the index of the element within the list of layout elements of the associated layout version.

Returns:

  • (Integer, nil)

    the index of the element within the list of layout elements of the associated layout version



606
# File 'lib/lws/apps/digital_signage.rb', line 606

attribute :index

#klassString

Returns the class of the layout element.

Returns:

  • (String)

    the class of the layout element



610
# File 'lib/lws/apps/digital_signage.rb', line 610

attribute :klass

#parentLayout?

Returns the parent of the layout element.

Returns:

  • (Layout, nil)

    the parent of the layout element



615
616
# File 'lib/lws/apps/digital_signage.rb', line 615

belongs_to :parent, class_name: "LWS::DigitalSignage::Layout::Element",
foreign_key: :parent_id

#parent_idInteger?

Returns the ID of the parent of the layout element.

Returns:

  • (Integer, nil)

    the ID of the parent of the layout element



620
# File 'lib/lws/apps/digital_signage.rb', line 620

attribute :parent_id

#propertiesArray<Layout::Element::Property>

Returns the properties of the layout element.

Returns:



625
# File 'lib/lws/apps/digital_signage.rb', line 625

has_many :properties, class_name: "LWS::DigitalSignage::Layout::Element::Property"

#versionLayout::Verion

Returns the layout version that contains the element.

Returns:

  • (Layout::Verion)

    the layout version that contains the element



630
631
# File 'lib/lws/apps/digital_signage.rb', line 630

belongs_to :version, class_name: "LWS::DigitalSignage::Layout::Version",
foreign_key: :layout_version_id