digitalsignage.com - open source docs
ScreenLayoutEditorView Class
_views\ScreenLayoutEditorView.js:1
Singleton Screen Layout editor is used to create / edit an existing screen division layout (aka: template > viewers) and when done editing, create new ScreenTemplates via ScreenTemplateFactory for both Thumb and main Timeline UIs
Constructor
ScreenLayoutEditorView
()
Object
Returns:
instantiated ScreenLayoutEditorView
Item Index
Methods
- (totalViews - i)
- _canvasFactory
- _destroy
- _enforceViewerVisible
- _listenBackgroundSelected
- _listenObjectsOverlap
- _listenPushToBottomDivision
- _listenPushToTopDivision
- _listenRemoveDivision
- _listenSelectNextDivision
- _moveViewer
- _render
- _updateDimensionsInDB
- _updateZorder
- i_props
- initialize
- selectView
- selectView
- self._enforceViewerMinimums(i_viewer);
Events
- VIEWER_REMOVED static
Methods
(totalViews - i)
()
Listen to the addition of a new viewer
_canvasFactory
-
i_width -
i_height
Create the canvas to render the screen division
Parameters:
-
i_widthNumber -
i_heightNumber
_destroy
()
One exit UI destroy all members
_enforceViewerVisible
()
Make sure that at least one screen division is visible within the canvas
_listenBackgroundSelected
()
Listen to changes on selecting the background canvas
_listenObjectsOverlap
()
Listen to changes in viewer overlaps
_listenPushToBottomDivision
()
Listen to re-order of screen division, putting selected at bottom
_listenPushToTopDivision
()
Listen to re-order of screen division, putting selected on top
_listenRemoveDivision
()
Listen to the removal of an existing screen division
_listenSelectNextDivision
()
Listen to selection of next viewer
_moveViewer
-
i_props
Move the object / viewer to new set of coords
Parameters:
-
i_propsObject
_render
()
On render load default dashboard properties
_updateDimensionsInDB
-
i_props
Update Pepper with latest object dimensions
Parameters:
-
i_propsObject
_updateZorder
()
Change the z-order of viewers in pepper
i_props
()
Listen to changes in a viewer changes in cords and update pepper
initialize
()
Constructor
selectView
()
Load the editor into DOM using the StackView using animation slider
selectView
()
Unload the editor from DOM using the StackView animated slider
self._enforceViewerMinimums(i_viewer);
-
i_rect
Enforce minimum x y w h props
Parameters:
-
i_rectObject
Events
VIEWER_REMOVED
final
static
Custom event fired when a screen division / viewer has been removed
Event Payload:
-
callerThis -
contextSelfcaller
-
rssEventlink