APIs

Show:

Property manager is a singleton class that manages all of the StackView element properties. If you select a block such as the Clock component, the property manager is responsible for loading the proper view stack for the selected element. Note that it is the job of the caller to populate the view stack with the appropriate data. The property manager is also capable of managing common properties which are used for blocks. For example, all blocks (QR, RSS etc) have a border color, the property value for the border will appear in the sub-panel via the BlockProperties (m_subViewStack) which co-resides inside the PropertiesView module.

Constructor

PropertiesView

(
  • i_elementID
)
Object

Parameters:

  • i_elementID String

    is the the main property HTML ID (div element).

Returns:

Object:

CompProperty instance.

Methods

_announcePanelSized

()

Announce that the side properties panel has changed in size

_listenClickSlidingPanel

()

Listen for open/close actions on properties panel that can slide in and out

_listenGlobalOpenProps

()

Open global properties button hook via popup

_reConfigPropPanelIcon

()

Change the icon of the open properties panel button so it reflects full screen vs right side panel properties inspection

_reconfigPropPanelLocation

()

Move properties panel between side panel or full screen popup panel depending on the screen size

getPropWidth

() Number

Get the property div total width which may vary, especially when in full popup mode vs left slide mode

Returns:

Number:

current width

initialize

()

Constructor

initPanel

(
  • i_panelID
)
Boolean

Init the properties panel and add it to the viewstack.

Parameters:

  • i_panelID String

    the html element id to be inserted into properties panel

Returns:

Boolean:

returns true if panel created, or false if it already existed so nothing was done.

initSettingsPanel

(
  • i_panelID
)
Boolean

Init the properties sub-panel for block settings view stack.

Parameters:

  • i_panelID String

    the html element id to be inserted into sub properties panel

Returns:

Boolean:

returns true if panel created, or false if it already existed so nothing was done

initSubPanel

(
  • i_panelID
)
Boolean

Init the properties sub-panel and add it to the view stack.

Parameters:

  • i_panelID String

    the html element id to be inserted into sub properties panel

Returns:

Boolean:

returns true if panel created, or false if it already existed so nothing was done

openPropertiesPanel

()

Open the properties panel (side or popup per screen size)

resetPropertiesView

()

Select the default properties view which is the Dashboard

viewPanel

(
  • i_panelID
)

Load the requested panel into the current viewstack (i.e.: hide all other panels).

Parameters:

  • i_panelID String

    html element id of panel to load into current viewstack.

viewSettingsPanel

(
  • i_panelID
)

Load the requested sub panel for the block settings (used mostly for JSON shared components)

Parameters:

  • i_panelID String

    html element id of sub panel to load into current view stack.

viewSubPanel

(
  • i_panelID
)

Load the requested sub panel into the current viewstack (i.e.: hide all other panels).

Parameters:

  • i_panelID String

    html element id of sub panel to load into current view stack.

Events

SIDE_PANEL_SIZED

final static

Even is fired when Side properties panel changed in size

Event Payload:

  • caller This
  • context Self

    caller

  • UNKNOWN Event