FrameTrail API Docs

  • for FrameTrail Version: 0.8.1

    • Modules & Types

    Show:

    RouteNavigation Module

    Defined in: frametrail/_shared/modules/RouteNavigation/module.js:6
    Module: Shared

    I am the RouteNavigation.

    I parse the query and the hash fragment of the current URL, and expose those parameters to the app. Also, I listen to changes in the hash fragment, and can call callbacks for them.

    Methods

    checkEnvironment

    () private

    Defined in frametrail/_shared/modules/RouteNavigation/module.js:98

    I return an object with various info about the execution environment.

    Returns:

    Object

    getHashVariable

    (
    • variable
    )
    private

    Defined in frametrail/_shared/modules/RouteNavigation/module.js:76

    I return the value of a hash parameter.

    Parameters:

    Returns:

    String

    getQueryVariable

    (
    • variable
    )
    private

    Defined in frametrail/_shared/modules/RouteNavigation/module.js:54

    I return the value of a query parameter.

    Parameters:

    Returns:

    String

    getResourceURL

    (
    • src
    )

    Defined in frametrail/_shared/modules/RouteNavigation/module.js:33

    I return a complete path (or URL) for a resource file based on the src attribute of a resource object.

    Parameters:

    Returns:

    String

    routeHasChanged

    () private

    Defined in frametrail/_shared/modules/RouteNavigation/module.js:154

    I update the application state, when the hash fragment has changed.

    Currently, I am only listing to changes of the parameter "annotations" and "t" (hashTime).

    setHashVariable

    (
    • id
    )
    private

    Defined in frametrail/_shared/modules/RouteNavigation/module.js:115

    I set the hypervideo id (in case it changes while the application is running).

    Parameters:

    setHashVariable

    (
    • key
    • value
    )
    private

    Defined in frametrail/_shared/modules/RouteNavigation/module.js:128

    I change the value of a hash parameter.

    Parameters:

    Attributes

    hashTime

    String

    Defined in frametrail/_shared/modules/RouteNavigation/module.js:262

    I get or set the hashTime (#t=) fragment

    hypervideoID

    String readonly

    Defined in frametrail/_shared/modules/RouteNavigation/module.js:227

    The hypervideoID, as parsed from the query part of the URL.

    id

    String

    Defined in frametrail/_shared/modules/RouteNavigation/module.js:235

    Manually set the hypervideo id.

    onAnnotationChange

    Function

    Defined in frametrail/_shared/modules/RouteNavigation/module.js:252

    NOT USED YET

    Will be called, when the hash fragment's annotationID changes.

    onHashTimeChange

    Function

    Defined in frametrail/_shared/modules/RouteNavigation/module.js:276

    Will be called, when the hashTime (#t=) fragment changes.

    projectID

    String readonly

    Defined in frametrail/_shared/modules/RouteNavigation/module.js:218

    The projectID, as parsed from the query part of the URL.