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

  • API Docs for Version: 1.5.118

    • APIs

    Show:

    SequencerView Class

    Defined in: _views\SequencerView.js:1

    The sequencer module is responsible for management and order of playback of each timeline within each campaign

    Constructor

    SequencerView

    (
    • i_container
    )
    Object

    Defined in _views\SequencerView.js:1

    Parameters:

    • i_container String

      element that CompCampaignNavigator inserts itself into

    Returns:

    Object:

    instantiated CompCampaignNavigator

    Methods

    _createSortable

    (
    • i_selector
    )

    Defined in _views\SequencerView.js:142

    Create a sortable channel list

    Parameters:

    • i_selector Element

    _deleteSequencedTimeline

    (
    • i_campaign_timeline_id
    )

    Defined in _views\SequencerView.js:101

    Delete a timeline from the Sequencer UI, as well as from the local member m_timelines.

    Parameters:

    • i_campaign_timeline_id Number

    Returns:

    none

    _deleteTimelineThumbUI

    (
    • i_campaign_timeline_id
    )

    Defined in _views\SequencerView.js:116

    Remove the element's UI thumb of a template layout

    Parameters:

    • i_campaign_timeline_id Number

    _listenContextMenu

    ()

    Defined in _views\SequencerView.js:31

    Listen to any canvas right click

    _listenReset

    ()

    Defined in _views\SequencerView.js:129

    Listen to reset of when switching to different campaign so we forget current state

    _onContentMenuSelection

    (
    • i_command
    )

    Defined in _views\SequencerView.js:51

    On Scene right click context menu selection command

    Parameters:

    • i_command String

    _sortableDrag

    ()

    Defined in _views\SequencerView.js:207

    Sortable drag channel list

    _sortableDragStart

    ()

    Defined in _views\SequencerView.js:199

    Sortable drag channel list on press

    _sortablePress

    ()

    Defined in _views\SequencerView.js:184

    Sortable channel list on press

    _sortableSnap

    ()

    Defined in _views\SequencerView.js:236

    snap channels to set rounder values

    createTimelineThumbnailUI

    (
    • i_screenProps
    )

    Defined in _views\SequencerView.js:271

    Create the timeline template (a.k.a timeline thumbnail) via the ScreenTemplateFactory and insert it into the sequencer UI. We proceed by activating the newly created timeline thumbnail via the ScreenTemplateFactory public methods.

    Parameters:

    • i_screenProps Object

    getOwner

    () Object

    Defined in _views\SequencerView.js:372

    Return this instance.

    Returns:

    Object:

    this

    initialize

    ()

    Defined in _views\SequencerView.js:14

    Constructor Init the instance and enable drag and drop operation. We also wire the open properties UI so we can populate a selected timeline through the properties panel.

    reSequenceTimelines

    () Array

    Defined in _views\SequencerView.js:354

    Reorder the timeline in the local msdb to match the UI order of the timeline thumbnails in the Sequencer

    Returns:

    Array:

    order of timelines ids

    selectFirstTimeline

    ()

    Defined in _views\SequencerView.js:247

    Select the first timeline in the Sequencer

    selectTimeline

    (
    • i_campaign_timeline_id
    )
    Number

    Defined in _views\SequencerView.js:381

    Find the campaign_timeline_id within the Sequencer and trigger a click event on it so it gets selected.

    Parameters:

    • i_campaign_timeline_id Number

    Returns:

    Number:

    i_campaign_timeline_id or -1

    selectViewer

    (
    • i_timeline_id
    • i_viewer_id
    )

    Defined in _views\SequencerView.js:260

    Select a viewer

    Parameters:

    • i_timeline_id Number
    • i_viewer_id Number