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

  • API Docs for Version: 1.5.118

    • APIs

    Show:

    BlockProperties Class

    Defined in: _views\BlockProperties.js:1

    Block property is a singleton Backbone view that represents shared UI view for all Blocks (Channels and Scenes blocks). It lives inside PropertiesViews

    Constructor

    BlockProperties

    () Object

    Defined in _views\BlockProperties.js:1

    Returns:

    Object:

    instantiated BlockProperties

    Methods

    _alphaSliderInit

    ()

    Defined in _views\BlockProperties.js:235

    Init alpha slider UI in the common properties

    _bgFasterQColorInit

    ()

    Defined in _views\BlockProperties.js:318

    Init the fasterq background color selector

    _bgGradientInit

    ()

    Defined in _views\BlockProperties.js:257

    Load jquery gradient component once

    _bgSceneInit

    ()

    Defined in _views\BlockProperties.js:345

    Init the scene backgroud selector

    _bgSceneInit

    ()

    Defined in _views\BlockProperties.js:291

    Init the scene background selector

    _datepickerDayDurationInit

    ()

    Defined in _views\BlockProperties.js:654

    Init the date picker duration bootstrap widget

    _fasterQInit

    ()

    Defined in _views\BlockProperties.js:705

    Init the fasterq properties

    _jsonItemFontSelectorInit

    ()

    Defined in _views\BlockProperties.js:725

    Create instance of FontSelector used in font json item block

    _labelFontSelectorInit

    ()

    Defined in _views\BlockProperties.js:749

    Create instance of FontSelector used in font property settings

    _labelFontSelectorInit

    ()

    Defined in _views\BlockProperties.js:713

    Create instance of FontSelector used in font property settings for label block

    _locationLiveInputs

    ()

    Defined in _views\BlockProperties.js:526

    Bind to location Live Inputs widgets

    _locationPriorityInit

    ()

    Defined in _views\BlockProperties.js:693

    Init the location priority widget

    _locationRadiusSliderInit

    ()

    Defined in _views\BlockProperties.js:575

    Init location radius slider in properties

    _onFasterQBgColorSelected

    (
    • i_color
    )

    Defined in _views\BlockProperties.js:371

    On fasterQ background color selected by minicolors

    Parameters:

    • i_color String

    _onSceneBgColorSelected

    (
    • i_color
    )

    Defined in _views\BlockProperties.js:402

    On scene background color selected by minicolors

    Parameters:

    • i_color String

    _onSceneBorderColorSelected

    (
    • i_color
    )

    Defined in _views\BlockProperties.js:381

    On scene block border color selected by minicolors

    Parameters:

    • i_color String

    _propLengthKnobsInit

    ()

    Defined in _views\BlockProperties.js:412

    Create the block length knobs so a user can set the length of the block with respect to timeline_channel

    Returns:

    none

    _rssFontSelectorInit

    ()

    Defined in _views\BlockProperties.js:619

    Create instance of FontSelector used in font property settings

    _rssPollTimeInit

    (
    • _rssPollTimeInit
    )

    Defined in _views\BlockProperties.js:666

    Init the poll timer spinner widget

    Parameters:

    • _rssPollTimeInit Number

    _rssSourceSelectorInit

    ()

    Defined in _views\BlockProperties.js:608

    Create instance of RSSLink used in select property settings

    _rssSourceSelectorInit

    ()

    Defined in _views\BlockProperties.js:597

    Create instance of RSSLink used in select property settings

    _timepickerDayDurationInit

    ()

    Defined in _views\BlockProperties.js:631

    Init the time picker duration bootstrap widget

    _twitterFontSelectorInit

    ()

    Defined in _views\BlockProperties.js:737

    Create instance of FontSelector used in font property settings for twitter item block

    _videoVolumeSliderInit

    ()

    Defined in _views\BlockProperties.js:504

    Init youtube volume slider in properties

    _videoVolumeSliderInit

    ()

    Defined in _views\BlockProperties.js:482

    Init video volume slider in properties

    _youtubeInit

    ()

    Defined in _views\BlockProperties.js:681

    Init the youtube properties

    collectionDatatableInit

    ()

    Defined in _views\BlockProperties.js:925

    Init the collection bootstrap datatable

    getClockFontSelector

    () Object

    Defined in _views\BlockProperties.js:845

    Returns the instance of clock font selector

    Returns:

    Object:

    m_clockFontSelector instance

    getLabelFontSelector

    () Object

    Defined in _views\BlockProperties.js:855

    Returns the instance of label font selector

    Returns:

    Object:

    font selector instance

    getLabelJsonItemFontSelector

    () Object

    Defined in _views\BlockProperties.js:865

    Returns the instance of label json item font selector

    Returns:

    Object:

    font selector instance

    getLocationPriorityMeter

    () Object

    Defined in _views\BlockProperties.js:895

    Returns the instance of location priority meter

    Returns:

    Object:

    m_locationPriorityMeter instance

    getMRssLinkSelector

    () Object

    Defined in _views\BlockProperties.js:915

    Returns the instance pf mrss link selector

    Returns:

    Object:

    m_mrssLinkSelector instance

    getRssFontSelector

    () Object

    Defined in _views\BlockProperties.js:835

    Returns the instance of rss font selector

    Returns:

    Object:

    m_rssFontSelector instance

    getRssLinkSelector

    () Object

    Defined in _views\BlockProperties.js:905

    Returns the instance pf rss link selector

    Returns:

    Object:

    m_rssLinks instance

    getTwitterItemFontSelector

    () Object

    Defined in _views\BlockProperties.js:875

    Returns the instance of twitter item font selector

    Returns:

    Object:

    font selector instance

    getYouTubeQualityMeter

    () Object

    Defined in _views\BlockProperties.js:885

    Returns the instance of youtube quality meter

    Returns:

    Object:

    m_youtubeQualityMeter instance

    initialize

    ()

    Defined in _views\BlockProperties.js:194

    Constructor

    initSettingsPanel

    ()

    Defined in _views\BlockProperties.js:779

    Bring into view the Block property Settings StackView SubPanel

    jsonEventDatatableInit

    ()

    Defined in _views\BlockProperties.js:991

    Init the json event bootstrap datatable

    locationDatatableInit

    ()

    Defined in _views\BlockProperties.js:1023

    Init the location base bootstrap datatable

    setBgScenePropColorPicker

    (
    • i_color
    )

    Defined in _views\BlockProperties.js:817

    Set the color picker color of scene background

    Parameters:

    • i_color Number

    setBorderBlockPropColorPicker

    (
    • i_color
    )

    Defined in _views\BlockProperties.js:826

    Set the color picker color of scene border

    Parameters:

    • i_color String

    setLocationLiveInput

    (
    • i_el
    • i_value
    )

    Defined in _views\BlockProperties.js:806

    Set the value for LAT/LNG/Name for Location fields using the LiveInput widget

    Parameters:

    • i_el String
    • i_value String

    showBlockProperty

    ()

    Defined in _views\BlockProperties.js:797

    Bring into view the Block property StackView SubPanel

    showBlockProperty

    ()

    Defined in _views\BlockProperties.js:788

    Bring into view the Block property StackView SubPanel

    showBlockProperty

    ()

    Defined in _views\BlockProperties.js:770

    Bring into view the Block property StackView SubPanel

    viewPanel

    ()

    Defined in _views\BlockProperties.js:761

    Bring into view the Block property StackView panel

    Events

    ALPHA_CHANGED

    Defined in _views\BlockProperties.js:73

    event fires when background alpha changed

    Event Payload:

    • this Object
    • caller Object

      the firing element

    • alpha Number

      value

    Block.ADD_LOCATION_POINT

    Defined in _views\BlockProperties.js:182

    event fires when new location point adding to google maps

    Event Payload:

    • caller This
    • selected String

      block_id

    Block.FASTERQ_BG_COLOR_CHANGE

    Defined in _views\BlockProperties.js:56

    event fires when fasterq background color changed

    Event Payload:

    • caller This
    • selected String

      block_id

    BLOCK_LENGTH_CHANGING

    Defined in _views\BlockProperties.js:64

    event fires when block length is changing (requesting a change), normally by a knob property widget

    Event Payload:

    • this Object
    • caller Object

      the firing knob element

    • value Number

      the knob's position value (hours / minutes / seconds)

    COLLECTION_EVENT_ROW_CHANGED

    Defined in _views\BlockProperties.js:136

    event fires datagrid collection event data chnaged / saved

    Event Payload:

    • this Object
    • caller Object

      the firing element

    • alpha Number

      value

    COLLECTION_ROW_CHANGED

    Defined in _views\BlockProperties.js:127

    event fires datagrid collection data changed / saved

    Event Payload:

    • this Object
    • caller Object

      the firing element

    • alpha Number

      value

    COLLECTION_ROW_DRAG

    Defined in _views\BlockProperties.js:109

    event fires datagrid collection is dragged

    Event Payload:

    • this Object
    • caller Object

      the firing element

    • alpha Number

      value

    COLLECTION_ROW_DROP

    Defined in _views\BlockProperties.js:118

    event fires datagrid collection is dropped

    Event Payload:

    • this Object
    • caller Object

      the firing element

    • alpha Number

      value

    COLOR_SELECTED

    final static

    Defined in _views\BlockProperties.js:10

    Custom event fired when a gradient color picked

    Event Payload:

    • caller This
    • context Self

      caller

    • event Event

    GRADIENT_COLOR_CLOSED

    final static

    Defined in _views\BlockProperties.js:45

    Custom event fired when gradient color selection picker closed

    Event Payload:

    • caller This
    • context Self

      caller

    • event Event

    LOCATION_LIVE_INPUT_CHANGED

    Defined in _views\BlockProperties.js:172

    event fires when location live input value chanegs such as LAT/LNG/resource names

    Event Payload:

    • this Object
    • caller Object

      the firing element

    • alpha Number

      value

    LOCATION_PRIORITY_METER_CHANGED

    final static

    Defined in _views\BlockProperties.js:33

    Custom Location priority event fired when bar meter changed event

    Event Payload:

    • caller This
    • context Self

      caller

    • UNKNOWN Event

    LOCATION_RADIUS_CHANGED

    Defined in _views\BlockProperties.js:100

    event fires when radius of location changed

    Event Payload:

    • this Object
    • caller Object

      the firing element

    • alpha Number

      value

    LOCATION_ROW_CHANGED

    Defined in _views\BlockProperties.js:163

    event fires datagrid location row data changed / saved

    Event Payload:

    • this Object
    • caller Object

      the firing element

    • alpha Number

      value

    LOCATION_ROW_DRAG

    Defined in _views\BlockProperties.js:145

    event fires datagrid location row is dragged

    Event Payload:

    • this Object
    • caller Object

      the firing element

    • alpha Number

      value

    LOCATION_ROW_DROP

    Defined in _views\BlockProperties.js:154

    event fires datagrid location row is dropped

    Event Payload:

    • this Object
    • caller Object

      the firing element

    • alpha Number

      value

    VIDEO_VOLUME_CHANGED

    Defined in _views\BlockProperties.js:82

    event fires when video volume changed

    Event Payload:

    • this Object
    • caller Object

      the firing element

    • alpha Number

      value

    YOUTUBE_METER_QUALITY_CHANGED

    final static

    Defined in _views\BlockProperties.js:21

    Custom YouTube event fired when bar meter changed event

    Event Payload:

    • caller This
    • context Self

      caller

    • UNKNOWN Event

    YOUTUBE_VOLUME_CHANGED

    Defined in _views\BlockProperties.js:91

    event fires when youtube volume changed

    Event Payload:

    • this Object
    • caller Object

      the firing element

    • alpha Number

      value