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

  • API Docs for Version: 1.5.118

    • APIs

    Show:

    BlockScene Class

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

    BlockScene represents the Scene which resided inside a channel

    Constructor

    BlockScene

    (
    • i_placement
    • i_campaign_timeline_chanel_player_id
    )
    Object

    Defined in _controllers\_blocks\BlockScene.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

    _alphaPopulate

    ()

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

    On changes in msdb model updated UI common alpha properties

    _announceBlockChanged

    ()

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

    Override the base method so we never announce any changes on Scene block

    _applySceneBgImage

    (
    • i_image
    )

    Defined in _controllers\_blocks\BlockScene.js:327

    Add the checkers background to a scene

    Parameters:

    • i_image String

    _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\BlockScene.js:80

    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 but overwritten in _controllers\_blocks\BlockScene.js:249

    Find the background section in player_data for selected block

    Parameters:

    • i_domPlayerData Object

    Returns:

    Xml:

    xSnippet

    _findBorder

    (
    • i_domPlayerData
    )
    Xml

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

    Find the border section in player_data for selected block

    Parameters:

    • i_domPlayerData Object

    Returns:

    Xml:

    xSnippet

    _findGradientPoints

    (
    • i_domPlayerData
    )
    Xml

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

    Find the gradient blocks in player_data for selected scene block

    Parameters:

    • i_domPlayerData Object

    Returns:

    Xml:

    xSnippet

    _getBlockPlayerData

    () Object

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

    Get the XML player data of a block, depending where its placed

    Returns:

    Object:

    player data of block (aka player) parsed as DOM

    _initSubPanel

    (
    • i_panel
    )

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

    Init the sub properties panel for a block

    Parameters:

    • i_panel String

    _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

    _listenBgColorChanges

    ()

    Defined in _controllers\_blocks\BlockScene.js:108

    Listen to changes in scene background color selection

    _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

    _listenGradientChange

    ()

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

    Update a block's player_data with new gradient background

    _listenInputChange

    ()

    Defined in _controllers\_blocks\BlockScene.js:128

    When user changes a URL link for the feed, update the msdb

    Returns:

    none

    _loadBlockSpecificProps

    ()

    Defined in _controllers\_blocks\BlockScene.js:316

    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\BlockScene.js:276

    Load up property values in the common panel

    Returns:

    none

    _populateSceneBg

    ()

    Defined in _controllers\_blocks\BlockScene.js:339

    Set a scene's background color or image

    _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
    )

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

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

    Parameters:

    • i_xmlDoc Object

    _toggleBackgroundColorHandler

    (
    • e
    )

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

    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\BlockScene.js:417

    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

    getChannelBlockSceneID

    () Number

    Defined in _controllers\_blocks\BlockScene.js:404

    Get the scene id that's associated with this block given that it resides in a timeline > channel

    Returns:

    Number:

    scene_id;

    getPlayerData

    (
    • i_playerData
    )
    Number

    Defined in _controllers\_blocks\BlockScene.js:65

    set player data for a scene

    Parameters:

    • i_playerData Number

    Returns:

    Number:

    Unique clientId.

    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\BlockScene.js:33

    Constructor

    m_blockAcronym

    ()

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

    Update the title of the selected tab properties element

    setbgSceneSetPropColorPicker

    (
    • i_color
    )

    Defined in _controllers\_blocks\BlockScene.js:92

    Set the color picker color of scene background

    Parameters:

    • i_color Number

    setCanvas

    (
    • i_canvas
    • i_magneticGridMode
    )

    Defined in _controllers\_blocks\BlockScene.js:391

    Set reference to managed canvas

    Parameters:

    • i_canvas Object
    • i_magneticGridMode Number

    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_BLOCK_DIMENSIONS_CHANGE

    Defined in _controllers\_blocks\BlockScene.js:23

    event fires when scene the scene width or height modified by user

    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

    SCENE_BG_COLOR_CHANGED

    final static

    Defined in _controllers\_blocks\BlockScene.js:12

    Custom event fired when a new scene background color changed

    Event Payload:

    • caller This
    • context Self

      caller

    • color Event