digitalsignage.com - open source docs
BlockJsonBase Class
_controllers\_blocks\BlockJsonBase.js:10
BlockJsonBase is a Player block that is used as the base class for all JSON based components it allows for parsing of JSON data and is supported with the JSON Item inside scenes
Constructor
BlockJsonBase
()
Object
Returns:
instantiated BlockJsonBase
Example:
path: http://www.digitalsignage.com/videoTutorials/_data/videos.json json player: children[0].children json item: text
Item Index
Methods
- _listenActionURLChange
- _listenAddEvent
- _listenDropdownEvenActionSelection
- _listenIntervalChange
- _listenJsonRowEventChanged
- _listenObjectPathChange
- _listenRemoveResource
- _listenSceneDropdownChange
- _listenSceneListChange
- _listenSlideShowMode
- _listenUrlChange
- _listenVideoPlayToCompletion
- _listenVideoPlayToCompletion
- _loadBlockSpecificProps
- _populate
- _populateEventVisibility
- _populateInterval
- _populateObjectPath
- _populateObjectPlayToCompletion
- _populateRandomPlayback
- _populateSceneDropdown
- _populateSlideShow
- _populateTableEvents
- _populateUrlInput
- _setJsonBlockGlobalValidationOwner
- _showJsonPaths
- _updateTitleTab
- deleteBlock
Methods
_listenActionURLChange
()
Listen in Event Action go to dropdown selections
_listenAddEvent
()
Listen to when user wants to add new events
_listenDropdownEvenActionSelection
()
Listen in Event Action dropdown selections
_listenIntervalChange
()
Listen to changes in the scene interval control
_listenJsonRowEventChanged
()
Listen to when json row was edited
_listenObjectPathChange
()
Wire changing of campaign name through scene properties
Returns:
none
_listenRemoveResource
()
Listen to when removing a resource from list
The algorithm will uses our bootstrap-table own inject rowIndex value
and counts up to match with the order of
_listenSceneDropdownChange
()
Listen to playlist changes dropdown
_listenSceneListChange
()
Listen to the global scene list changes event so we can update the list of available scenes
_listenSlideShowMode
()
Listen to slideshow change mode
Returns:
none
_listenUrlChange
()
Wire changing of campaign name through scene properties
Returns:
none
_listenVideoPlayToCompletion
()
Listen to Video Play to completion change mode
Returns:
none
_listenVideoPlayToCompletion
()
Listen to Video Play to completion change mode
Returns:
none
_loadBlockSpecificProps
()
Populate the common block properties panel, called from base class if exists
Returns:
none
_populate
()
Load up property values in the common panel
Returns:
none
_populateEventVisibility
-
i_slideShow
Show or hide the events UI depending on slideshow mode
Parameters:
-
i_slideShowNumber
_populateInterval
-
i_interval
Populate the UI of the scene interval selector
Parameters:
-
i_intervalNumber
_populateObjectPath
-
i_objectPath
Populate Object json path using dot notation
Parameters:
-
i_objectPathString
_populateObjectPlayToCompletion
-
i_playToCompletion
Populate json object play to completion if we are pulling videos from the json path
Parameters:
-
i_playToCompletionBoolean
_populateRandomPlayback
-
i_randomPlayback
Populate json object random playback
Parameters:
-
i_randomPlaybackBoolean
_populateSceneDropdown
()
Populate the LI with all available scenes from msdb if the mimetype is empty (used for this class) we show all scenes in dropdown, but if mimetype exists (used by subclasses of this class) we filter dropdown list by matching mimetypes
_populateSlideShow
-
i_slideshow
Populate json slideshow mode
Parameters:
-
i_slideshowBoolean
_populateTableEvents
()
Load event list to block props UI
_populateUrlInput
-
i_url
Populate Url input field
Parameters:
-
i_urlString
_setJsonBlockGlobalValidationOwner
()
re-take ownership for a caller block instance and register global Validators for bootstrap-table to format data This function has to run everytime we populate the UI since it is a shared global function and we have to override it so 'this' refers to correct BlockJsonBase instance
_showJsonPaths
()
By default hide the JSON URL and JSON Object paths inputs
_updateTitleTab
()
Update the title of the selected tab properties element and also show the sub tab for Settings of Json sub components (world weather, Calendar etc...)
deleteBlock
-
i_memoryOnly
Delete this block
Parameters:
-
i_memoryOnlyBooleanif true only remove from existance but not from msdb