digitalsignage.com - open source docs digitalsignage.com - open source docs

  • API Docs for Version: 1.5.118

    • APIs

    Show:

    BlockCollection Class

    Extends Block
    Defined in: _controllers\_blocks\BlockCollection.js:1

    BlockCollection block resides inside a scene or timeline and manages internal playback of scenes and resoucres

    Constructor

    BlockCollection

    (
    • i_placement
    • i_campaign_timeline_chanel_player_id
    )
    Object

    Defined in _controllers\_blocks\BlockCollection.js:1

    Parameters:

    • i_placement String

      location where objects resides which can be scene or timeline

    • i_campaign_timeline_chanel_player_id String

      required and set as block id when block is inserted onto timeline_channel

    Returns:

    Object:

    Block instance

    Methods

    _addCollectionNewListItem

    (
    • e
    )

    Defined in _controllers\_blocks\BlockCollection.js:408

    Add a new collection item which can include a Scene or a resource (not a component)

    Parameters:

    • e Event

    _alphaPopulate

    ()

    Inherited from Block: _controllers\_blocks\Block.js:184

    On changes in msdb model updated UI common alpha properties

    _announceBlockChanged

    (
    • i_player_data
    )

    Inherited from Block: _controllers\_blocks\Block.js:671

    Announce that this block has changed

    Parameters:

    • i_player_data Number

    _bgPropsPopulate

    ()

    Inherited from Block: _controllers\_blocks\Block.js:219

    On changes in msdb model updated UI common gradient background properties

    _bgPropsUnpopulate

    ()

    Inherited from Block: _controllers\_blocks\Block.js:261

    Disable the gradient background UI

    _borderPropsPopulate

    ()

    Inherited from Block: _controllers\_blocks\Block.js:243

    On changes in msdb model updated UI common border properties

    _borderPropsUnpopulate

    ()

    Inherited from Block: _controllers\_blocks\Block.js:275

    Disable the border UI

    _deleteBlock

    (
    • i_memoryOnly
    )

    Inherited from Block: _controllers\_blocks\Block.js:768

    Delete block is a private method that is always called regardless if instance has been inherited or not. Used for releasing memory for garbage collector.

    Parameters:

    • i_memoryOnly Boolean

      if true only remove from existance but not from msdb

    Returns:

    none

    _enableBgSelection

    ()

    Inherited from Block but overwritten in _controllers\_blocks\Block.js:198

    Enable gradient background UI

    _fabricAlpha

    (
    • i_domPlayerData
    )

    Inherited from Block: _controllers\_blocks\Block.js:800

    Fabricate alpha to canvas

    Parameters:

    • i_domPlayerData Object

    _fabricateBorder

    (
    • i_options
    )
    Object

    Inherited from Block: _controllers\_blocks\Block.js:831

    Config the fabric block border

    Parameters:

    • i_options I_options

    Returns:

    Object:

    object literal

    _fabricateOptions

    (
    • i_top
    • i_left
    • i_width
    • i_height
    • i_angle
    )
    Object

    Inherited from Block: _controllers\_blocks\Block.js:849

    Build the options injected into a newly created fabric object

    Parameters:

    • i_top Number
    • i_left Number
    • i_width Number
    • i_height Number
    • i_angle Number

    Returns:

    Object:

    object literal

    _fabricColorPoints

    (
    • i_domPlayerData
    )

    Inherited from Block: _controllers\_blocks\Block.js:812

    Fabricate color points to canvas

    Parameters:

    • i_domPlayerData Xml

    _fabricLock

    ()

    Inherited from Block: _controllers\_blocks\Block.js:120

    On changes in msdb model updated UI common lock properties

    _fabricRect

    (
    • i_width
    • i_height
    • i_domPlayerData
    )
    Object

    Inherited from Block: _controllers\_blocks\Block.js:879

    Fabricate color points to canvas

    Parameters:

    • i_width Number
    • i_height Number
    • i_domPlayerData Xml

    Returns:

    Object:

    r fabric js rectangular

    _findBackground

    (
    • i_domPlayerData
    )
    Xml

    Inherited from Block: _controllers\_blocks\Block.js:446

    Find the background section in player_data for selected block

    Parameters:

    • i_domPlayerData Object

    Returns:

    Xml:

    xSnippet

    _findBorder

    (
    • i_domPlayerData
    )
    Xml

    Inherited from Block: _controllers\_blocks\Block.js:458

    Find the border section in player_data for selected block

    Parameters:

    • i_domPlayerData Object

    Returns:

    Xml:

    xSnippet

    _findGradientPoints

    (
    • i_domPlayerData
    )
    Xml

    Inherited from Block: _controllers\_blocks\Block.js:469

    Find the gradient blocks in player_data for selected block

    Parameters:

    • i_domPlayerData Object

    Returns:

    Xml:

    xSnippet

    _getBlockPlayerData

    () Object

    Inherited from Block: _controllers\_blocks\Block.js:721

    Get the XML player data of a block, depending where its placed If you like to view XML raw data, be sure to debug domPlayerData.children[0].outerHTML

    Returns:

    Object:

    player data of block (aka player) parsed as DOM

    _getCollectionPageNames

    ()

    Defined in _controllers\_blocks\BlockCollection.js:514

    Get all the collection pages names for current collection block this is called against the last block instance that registered the global function of setCollectionBlockGlobalValidationOwner

    _initSubPanel

    (
    • i_panel
    )

    Inherited from Block: _controllers\_blocks\Block.js:100

    Init the sub properties panel for a block

    Parameters:

    • i_panel String

    _listenAddEvent

    ()

    Defined in _controllers\_blocks\BlockCollection.js:339

    Listen to when user wants to add new events (i.e. when in Kiosk mode)

    _listenAddResource

    ()

    Defined in _controllers\_blocks\BlockCollection.js:307

    Listen to when AddBlockListView announced that a new resource or scene needs to be added and if this collection block is selected, go ahead and create one in Bootstrap-table and msdb

    _listenAlphaChange

    ()

    Inherited from Block: _controllers\_blocks\Block.js:165

    Listen to changes in Alpha UI properties selection and update msdb

    _listenBackgroundStateChange

    ()

    Inherited from Block but overwritten in _controllers\_blocks\Block.js:360

    Listen to change in background enable / disable states

    _listenBlockSelected

    ()

    Inherited from Block: _controllers\_blocks\Block.js:481

    Notify this object that it has been selected so it can populate it's own the properties box etc The function triggers from the BLOCK_SELECTED event.

    Returns:

    none

    _listenBorderColorChange

    ()

    Inherited from Block: _controllers\_blocks\Block.js:415

    Update a block's player_data with new border background

    _listenCollectionRowChanged

    ()

    Defined in _controllers\_blocks\BlockCollection.js:67

    Listen to when collection row was edited

    _listenCollectionRowEventChanged

    ()

    Defined in _controllers\_blocks\BlockCollection.js:94

    Listen to when collection row was edited

    _listenDropdownEvenActionGoToSelection

    ()

    Defined in _controllers\_blocks\BlockCollection.js:139

    Listen in Event Action go to dropdown selections

    _listenDropdownEvenActionSelection

    ()

    Defined in _controllers\_blocks\BlockCollection.js:115

    Listen in Event Action dropdown selections

    _listenGradientChange

    ()

    Inherited from Block but overwritten in _controllers\_blocks\Block.js:382

    Update a block's player_data with new gradient background

    _listenModeChange

    ()

    Defined in _controllers\_blocks\BlockCollection.js:270

    Listen to mode change between Kiosk and Slideshow modes

    _listenRemoveResource

    ()

    Defined in _controllers\_blocks\BlockCollection.js:382

    Listen to when removing a resource from collection list The algorithm will uses our bootstrap-table own inject rowIndex value and counts up to match with the order of in msdb collection, once matched against same value we delete the proper ordered collection item from msdb and refresh the entire table

    _listenRemoveResource

    ()

    Defined in _controllers\_blocks\BlockCollection.js:357

    Listen to when removing a resource from collection list The algorithm will uses our bootstrap-table own inject rowIndex value and counts up to match with the order of in msdb collection, once matched against same value we delete the proper ordered collection item from msdb and refresh the entire table

    _listenVolumeChange

    ()

    Defined in _controllers\_blocks\BlockCollection.js:53

    Listen to changes in volume control

    _listenVolumeChange

    ()

    Defined in _controllers\_blocks\BlockCollection.js:163

    Listen to changes in volume control

    _loadBlockSpecificProps

    ()

    Defined in _controllers\_blocks\BlockCollection.js:456

    Populate the common block properties panel, called from base class if exists

    Returns:

    none

    _onBlockLengthChanged

    ()

    Inherited from Block: _controllers\_blocks\Block.js:617

    Take action when block length has changed which is triggered by the BLOCK_LENGTH_CHANGING event

    Returns:

    none

    _onBlockSelected

    ()

    Inherited from Block: _controllers\_blocks\Block.js:499

    When a block is selected, find out where is it placed (scene/ channel) and change props accordingly

    _populate

    ()

    Defined in _controllers\_blocks\BlockCollection.js:183

    Load up property values in the common panel

    Returns:

    none

    _populateModeSliderUI

    (
    • i_status
    )

    Defined in _controllers\_blocks\BlockCollection.js:289

    Render the checkbox slider according to current Kiosk mode for block

    Parameters:

    • i_status Boolean

    _populateTableCollection

    (
    • i_domPlayerData
    )

    Defined in _controllers\_blocks\BlockCollection.js:204

    Load event list to the UI

    Parameters:

    • i_domPlayerData Object

    _populateTableEvents

    ()

    Defined in _controllers\_blocks\BlockCollection.js:236

    Load event list to block props UI

    _selfDestruct

    ()

    Inherited from Block: _controllers\_blocks\Block.js:750

    bug fix: backward comparability with player_data that includes deleted resources this was already fixed but we live _selfDestruct for backwards compatability

    _setBlockPlayerData

    (
    • i_xmlDoc
    • [i_noNotify]
    • [i_xmlIsString]
    )

    Inherited from Block: _controllers\_blocks\Block.js:681

    Update the msdb for the block with new values inside its player_data

    Parameters:

    • i_xmlDoc Object

      the dom object to save to local msdb

    • [i_noNotify] String optional

      if set, fire event announcing data saved

    • [i_xmlIsString] Boolean optional

      if set, bypass serializeToString since already in string format

    _setCollectionBlockGlobalValidationOwner

    ()

    Defined in _controllers\_blocks\BlockCollection.js:467

    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 BlockCollection instance

    _toggleBackgroundColorHandler

    (
    • e
    )

    Inherited from Block but overwritten in _controllers\_blocks\Block.js:288

    Toggle block background on UI checkbox selection

    Parameters:

    • e Event

    _toggleLock

    ()

    Inherited from Block: _controllers\_blocks\Block.js:144

    Toggle lock status

    _updateBlockDimensions

    ()

    Inherited from Block: _controllers\_blocks\Block.js:596

    Update the position of the block when placed inside a scene

    _updateBlockLength

    ()

    Inherited from Block: _controllers\_blocks\Block.js:570

    Update the length properties of the block with respect to position on the timeline_channel

    Returns:

    none

    _updateTitle

    ()

    Inherited from Block: _controllers\_blocks\Block.js:546

    Update the title of the block inside the assigned element.

    Returns:

    none

    _viewSubPanel

    (
    • i_panel
    )

    Inherited from Block: _controllers\_blocks\Block.js:110

    Bring into view a sub properties panel of this block

    Parameters:

    • i_panel String

    deleteBlock

    (
    • i_memoryOnly
    )

    Inherited from Block but overwritten in _controllers\_blocks\BlockCollection.js:530

    Delete this block

    Parameters:

    • i_memoryOnly Boolean

      if true only remove from existance but not from msdb

    fabricateBlock

    ()

    Inherited from Block: _controllers\_blocks\Block.js:901

    Convert the block into a fabric js compatible object, called externally on creation of block

    getBlockData

    () Object

    Inherited from Block: _controllers\_blocks\Block.js:946

    Get block data as a json formatted object literal and return to caller

    Returns:

    Object:

    data The entire block data members which can be made public

    getZindex

    (
    • i_index
    )

    Inherited from Block: _controllers\_blocks\Block.js:980

    Get a block's z-index

    Parameters:

    • i_index Number

    initialize

    ()

    Inherited from Block but overwritten in _controllers\_blocks\BlockCollection.js:14

    Constructor

    m_blockAcronym

    ()

    Inherited from Block: _controllers\_blocks\Block.js:556

    Update the title of the selected tab properties element

    setZindex

    (
    • i_index
    )

    Inherited from Block: _controllers\_blocks\Block.js:969

    Set a block's z-index in case we know it (i.e.: it is going to be a re-render of a previous block that was removed from the canvas)

    Parameters:

    • i_index Number

    Events

    Block.BLOCK_BORDER_CHANGE

    Inherited from Block: _controllers\_blocks\Block.js:29

    event fires when block border changed so scene needs to be re-rendered

    Event Payload:

    • caller This
    • selected String

      block_id

    Block.BLOCK_SELECTED

    Inherited from Block: _controllers\_blocks\Block.js:46

    event fires when block is selected

    Event Payload:

    • caller This
    • selected String

      block_id

    Block.SCENE_BLOCK_CHANGE

    Inherited from Block: _controllers\_blocks\Block.js:21

    event fires when scene block was changed so scene needs to be re-rendered

    Event Payload:

    • caller This
    • selected String

      block_id

    Block.SCENE_BLOCKS_RENDERED

    Inherited from Block: _controllers\_blocks\Block.js:37

    event fires when scene blocks freshly re-rendered onto the scene canvas so we need to update the UI of ALL blocks normally occurs after a Block.SCENE_BLOCK_CHANGE event

    Event Payload:

    • caller This
    • selected String

      block_id