Initialization Option Items API

regions

The assessment player layout is split into multiple regions which can be customized with many elements and button components.

Important Supported with rendering_type: "assess" only.

Examples

// Use the "horizontal" layout preset
var initializationOptions = {
    "config": {
        "regions": "horizontal"
    }
    // ...
};

// Completely customize the assessment player
var initializationOptions = {
    "config": {
        "regions": {
            "top-left": [
                { "type": "title_element" }
            ],
            "top-right": [
                {
                    "type": "pause_button",
                    "position": "right"
                },
                { "type": "timer_element" },
                { "type": "itemcount_element" }
            ],
            "right": [
                { "type": "save_button" },
                { "type": "fullscreen_button" },
                { "type": "separator_element" },
                { "type": "accessibility_button" },
                { "type": "calculator_button" },
                { "type": "verticaltoc_element" },
                { "type": "masking_button" },
                { "type": "next_button" },
                { "type": "previous_button" }
            ],
            "items": [
                {
                    "type": "slider_element",
                    "scrollable_option": false
                },
                { "type": "progress_element" }
            ],
            "bottom-right": [
                { "type": "next_button" },
                { "type": "previous_button" }
            ]
        }
    }
    // ...
};

Values

Request object key config.regions

Default: "main"

This option can be initialized as one of the following types: string object.

  • Type string

    There are several presets available for common use cases of the assessment player.

    Possible values:
    • "main"
    • "horizontal"
    • "horizontal-fixed"
    • "items-only"
  • Type object

    Available regions that can be customized:

    • "top-left"
    • "top-right"
    • "right"
    • "items"
    • "bottom-right"

    See the code example and the Customizing the Assessment Player experience with User Interface Regions article for advanced customizations.

Related articles

Was this article helpful?