digitalsignage.com - open source docs
StorylineView Class
_views\StorylineView.js:1
StoryLineView module manages the Timeline > Channels UI while displaying the visual length over time for each block on the selected channel
Constructor
StorylineView
-
UNKNOWN
Parameters:
-
UNKNOWNString
Returns:
instantiated StorylineView
Item Index
Methods
- _addBlockSelection
- _addChannelSelection
- _blockSelected
- _blockSelected
- _delayedRender
- _deselection
- _listenAppResized
- _listenBlockSelection
- _listenContextMenu
- _listenExitPreview
- _listenReset
- _listenSelections
- _listenStackViewSelected
- _listenTimelineBlockRemoved
- _listenTimelineChanged
- _listenTimelineSelected
- _listenToggleStorylineCollapsible
- _onContentMenuSelection
- _populateBlocks
- _populateChannels
- _populateScala
- _removeBlockSelection
- _removeChannelSelection
- _render
- _updateWidth
- collapseStoryLine
- initialize
- selectNextChannel
Events
- STORYLINE_BLOCK_SELECTED static
Methods
_addBlockSelection
-
i_blockID
Add block selection by marking it on the storyline and remembering selection
Parameters:
-
i_blockIDNumber
_addChannelSelection
-
i_selectedChannel
Add channel selection by marking it on the storyline and remembering selection
Parameters:
-
i_selectedChannelNumber
_blockSelected
-
e
When a block is selected within a channel, get the resource element so we can select it and fire the BLOCK_SELECTED event
Parameters:
-
eEvent
_blockSelected
-
e
When a block is selected within a channel, get the resource element so we can select it and fire the BLOCK_SELECTED event
Parameters:
-
eEvent
_delayedRender
()
Delayed render of stoeyboard
_deselection
()
Forget all current selections
_listenAppResized
()
Listen to when the app is resized so we can re-render
_listenBlockSelection
()
Listen for block selection
_listenContextMenu
()
Listen to any canvas right click
_listenExitPreview
()
Re-render the storyboard upon live preview exit
_listenReset
()
Listen to reset of when switching to different campaign so we forget current state
_listenSelections
()
Listen to channel selection so we can re-render storyline
_listenStackViewSelected
()
Anytime the containing StackView is selected, re-render the Storyline as resources or scenes could have been removed while we were gone
_listenTimelineBlockRemoved
-
e
Listen to when a timeline block is removed
Parameters:
-
eObject
_listenTimelineChanged
()
Listen to changes in the timeline (channel, block length etc) so we can re-render the storyline
_listenTimelineSelected
()
Listen to a new timeline selection so we can re-render the storyline
_listenToggleStorylineCollapsible
()
Toggle the arrow of the collapsible storyline UI widget
_onContentMenuSelection
-
i_command
On Scene right click context menu selection command
Parameters:
-
i_commandString
_populateBlocks
-
i_campaign_timeline_chanel_id
Populate UI blocks
Parameters:
-
i_campaign_timeline_chanel_idNumber
_populateChannels
()
Populate UI channels
_populateScala
()
Build the UI for the top seconds / minutes scala of the storyline
_removeBlockSelection
()
Remove currently selected block by removing selection as well forgetting it
_removeChannelSelection
()
Remove currently selected channel by removing selection as well forgetting it
_render
()
Draw a fresh storyline for current timeline
_updateWidth
()
Compute the storyline UI width total width
collapseStoryLine
()
Collapse the storyline bootstrap panel and title
initialize
()
Constructor
selectNextChannel
()
Select next channel
Events
STORYLINE_BLOCK_SELECTED
final
static
Custom event fired when a block is selected on the storyline
Event Payload:
-
callerThis -
contextSelfcaller
-
UNKNOWNEvent