FrameTrail API Docs

  • for FrameTrail Version: 0.8.1

    • Modules & Types

    Show:

    InterfaceModal Module

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

    I am the InterfaceModal module.

    I provide the most basic UI:

    • display status messages
    • display loading indicators
    • display user dialogs

    Methods

    hideLoadingScreen

    ()

    Defined in frametrail/player/modules/InterfaceModal/module.js:94

    I hide the loading screen.

    hideMessage

    (
    • delay
    )

    Defined in frametrail/player/modules/InterfaceModal/module.js:61

    I hide all messages. I do this immediatly, unless a delay is set, in which case I remove the messages after the delay in milliseconds.

    Parameters:

    setLoadingTitle

    (
    • title
    )

    Defined in frametrail/player/modules/InterfaceModal/module.js:120

    I set the loading screen title to either the hypervideo name or the project name.

    Parameters:

    showErrorMessage

    (
    • msg
    )

    Defined in frametrail/player/modules/InterfaceModal/module.js:42

    I show a error message.

    Parameters:

    showLoadingScreen

    ()

    Defined in frametrail/player/modules/InterfaceModal/module.js:82

    I show the loading screen.

    showStatusMessage

    (
    • msg
    )

    Defined in frametrail/player/modules/InterfaceModal/module.js:33

    I show a status message.

    Parameters:

    showSuccessMessage

    (
    • msg
    )

    Defined in frametrail/player/modules/InterfaceModal/module.js:51

    I show a success message.

    Parameters: