Initialization Option Items API

navigation

Adds or removes interface elements (buttons, dialogs, etc.) for navigation within the assessment player.

You would want to specify this option so that you can customize the navigation experience, overriding the Learnosity default settings.

Important Supported with rendering_type: "assess" only.

Examples

var initializationOptions = {
    "config": {
        "navigation": {
            "skip_submit_confirmation": false,
            "show_intro": true,
            "intro_item": "Intro Item Reference 123",
            "show_outro": true,
            "outro_item": "Outro Item Reference 456",
            "scroll_to_top": true,
            "scroll_to_test": true
        }
    }
};

Values

Request object key config.navigation

Type object

This object has the following properties which can be configured.

  • auto_save boolean object

    Configures the automatic saving of session responses during assessment.

  • warning_on_change boolean object

    Shows a warning message when the learner navigates to another Item but has not fully attempted the Question(s) in the current Item.

  • warning_on_section_change boolean

    Displays a warning dialog informing learners that they won't be able to return to the current section when they attempt to progress into a new section.

  • enable_arrowkey_item_change boolean

    Specifies whether the keyboard arrow keys can be used for navigating forwards and backwards through Items in the assessment.

  • exit_securebrowser boolean Deprecated

    Specifies if the secure browser should be exited once the session is finished.

  • resource_items array[string]

    Specifies the Items that will be rendered in the resources panel of the assessment player.

  • intro_item boolean string object

    Specifies an Item that will be initially rendered before the learner starts the assessment.

  • outro_item boolean string object

    Specifies an Item that will be rendered at the end of the assessment, usually after the assessment has been submitted.

  • scrolling_indicator boolean

    Specifies whether to show a scrolling indicator at the bottom of the "horizontal-fixed" regions layout of the assessment player.

  • scroll_to_test boolean object

    Brings the assessment player into view by automatically scrolling the browser window so that it is aligned with the top of the assessment player when the session starts.

  • scroll_to_top boolean object

    Automatically scrolls the browser window so that it is aligned with the top of the assessment player when the learner navigates to another Item.

  • show_acknowledgements boolean

    Specifies whether to show any acknowledgement of assets owned by other organizations which were used in the assessment, for copyright purposes.

  • show_intro boolean

    Specifies whether to show an introduction page when the assessment player has loaded.

  • show_outro boolean

    Specifies whether to show an outro page when the assessment has been submitted.

  • skip_submit_confirmation boolean

    Specifies whether to show a confirmation dialog to learners before submitting the assessment.

Was this article helpful?