FrameTrail API Docs

  • for FrameTrail Version: 0.8.1

    • Modules & Types

    Show:

    Sidebar Module

    Defined in: frametrail/player/modules/Sidebar/module.js:6
    Module: Player

    I am the Sidebar. I provide the basic navigation for the user interface.

    Methods

    changeUserColor

    (
    • color
    )

    Defined in frametrail/player/modules/Sidebar/module.js:348

    I react to a change in the global state "userColor"

    Parameters:

    changeUserLogin

    (
    • loggedIn
    )

    Defined in frametrail/player/modules/Sidebar/module.js:316

    I react to a change in the global state "loggedIn"

    Parameters:

    changeViewSize

    (
    • arrayWidthAndHeight
    )

    Defined in frametrail/player/modules/Sidebar/module.js:179

    I react to a change in the global state "viewSize"

    Parameters:

    • arrayWidthAndHeight Array

    create

    ()

    Defined in frametrail/player/modules/Sidebar/module.js:141

    I am called from Interface/create() and set up all my elements.

    newUnsavedChange

    (
    • category
    )

    Defined in frametrail/player/modules/Sidebar/module.js:226

    I am called from the HypervideoModel/newUnsavedChange().

    I mark the categories (overlays, videolinks, annotations), which have unsaved changes inside them.

    Parameters:

    toggleEditMode

    (
    • editMode
    • oldEditMode
    )

    Defined in frametrail/player/modules/Sidebar/module.js:263

    I react to a change in the global state "editMode"

    Parameters:

    toggleFullscreen

    (
    • aBoolean
    )

    Defined in frametrail/player/modules/Sidebar/module.js:196

    I react to a change in the global state "fullscreen"

    Parameters:

    toggleSidebarOpen

    (
    • opened
    )

    Defined in frametrail/player/modules/Sidebar/module.js:163

    I react to a change in the global state "sidebarOpen"

    Parameters:

    toggleViewMode

    (
    • viewMode
    )

    Defined in frametrail/player/modules/Sidebar/module.js:242

    I react to a change in the global state "viewMode"

    Parameters:

    toogleUnsavedChanges

    (
    • aBoolean
    )

    Defined in frametrail/player/modules/Sidebar/module.js:208

    I react to a change in the global state "unsavedChanges"

    Parameters:

    Attributes

    ProjectDescription

    String

    Defined in frametrail/player/modules/Sidebar/module.js:398

    I am the text which should be displayed in the "Overview" tab of the sidebar.

    VideoDescription

    String

    Defined in frametrail/player/modules/Sidebar/module.js:406

    I am the text which should be displayed in the "Video" tab of the sidebar.

    width

    Number readonly

    Defined in frametrail/player/modules/Sidebar/module.js:390

    I am the width of the sidebar's DOM element.