Initialization Option Author API

scroll_to_top

Configuration options for the "scroll to top on Item change" functionality.

Values

Request object key config.activity_edit.player.playback.scroll_to_top

Type object

This object has the following properties which can be configured.

  • show boolean

    Controls whether the "scroll to top on Item change" option is shown.

    You would want to use this to hide the option in the assessment player settings.

    Default: true

    var initializationOptions = {
        "config": {
            "activity_edit": {
                "player": {
                    "playback": {
                        "scroll_to_top": {
                            "show": false
                        }
                    }
                }
            }
        }
    };
  • edit boolean

    Controls whether the "scroll to top on Item change" option can be changed.

    You would want to use this so that you can prevent authors from changing the option in the assessment player settings. The option will be displayed but cannot be changed.

    Default: true

    var initializationOptions = {
        "config": {
            "activity_edit": {
                "player": {
                    "playback": {
                        "scroll_to_top": {
                            "edit": false
                        }
                    }
                }
            }
        }
    };
Was this article helpful?