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

  • API Docs for Version: 1.5.118

    • APIs

    Show:

    StackView.ViewPort Class

    Defined in: _views\StackView.js:1

    Base class for all StackView components. StackView allows for dynamic changes of elements (show/hide) and it works with the Backbone framework, thus allowing for view control.

    Constructor

    StackView.ViewPort

    ()

    Defined in _views\StackView.js:1

    Returns:

    none instead instantiate derived classes

    Methods

    _parseView

    (
    • i_view
    )

    Defined in _views\StackView.js:73

    If view was given as an ID string, find its matching Backbone > View

    Parameters:

    • i_view Object

    addView

    (
    • i_view
    )
    String

    Defined in _views\StackView.js:22

    Add a backbone view so we can control its display mode via one of the derived classes

    Parameters:

    • i_view Object

      add a backbone view to control

    Returns:

    String:

    stack view id added

    getViewByID

    (
    • i_id
    )
    Object

    Defined in _views\StackView.js:46

    Find a registered backbone view by its id or cid

    Parameters:

    • i_id String

    Returns:

    Object:

    view object retrieved

    getViews

    () Object

    Defined in _views\StackView.js:37

    Get all registered views

    Returns:

    Object:

    registered views

    initialize

    ()

    Defined in _views\StackView.js:13

    Constructor

    selectView

    (
    • i_view
    )

    Defined in _views\StackView.js:63

    Select a view to present in the DOM, implementation varies per derived class

    Parameters:

    • i_view Object