Items API Initialization
time
Specifies parameters related to the assessment timer such as countdown and expiry settings.
You would want to specify this option so that you can set a time limit for the assessment, for example.
This option can also be set inside sections to define the time parameters of each section.
Important Supported with rendering_type: "assess" only.
From v2026.2.LTS, learners can show or hide the main assessment timer during an assessment by clicking it, or by pressing Space or Enter when it has focus. This can help reduce test anxiety caused by a constantly updating timer display.
Note The timer can only be hidden while more than 5 minutes remain in a timed session. This threshold is not configurable.
When 5 minutes remain in a timed session, the following happens automatically regardless of learner preference:
- The timer reappears if it was hidden.
- The ability to hide the timer is disabled for the rest of the session.
- Screen readers announce the remaining time through an
aria-liveregion.
Examples
// Set various assessment timer options:
// 1. Set the maximum time for the assessment to 10 minutes
// 2. Enable the warning indicator when 60 seconds remains
// 3. Force the assessment submission when the time has run out
// 4. Show the timer counting down from the total assessment time
var initializationOptions = {
"config": {
"time": {
"max_time": 600,
"warning_time": 60,
"limit_type": "hard",
"countdown_option": true
}
}
// ...
};
Values
Attribute path config.time
Type object
Properties
-
countdown number
Set the amount of time before the learner's session ends, in the context of proctored assessments.
-
countdown_option boolean
Setting this option to
truecauses the assessment player timer to count down from themax_timevalue. -
limit_type string
Specify the action taken when the time limit
max_timeexpires. -
max_time number
The total time allowed for learners to complete the assessment, in seconds.
-
start_time object
Defines the initial commencement time of a learner's assessment.
-
warning_time number
Specifies whether to warn the learner that time is running out by showing them a visual cue (red background) in the timer element of the assessment player, when the session has reached a certain amount of seconds left.
Caveats
- If you override the time configuration for any section using the SectionObject
configoption, thistimeconfiguration will be ignored. - The automatic timer reappearance, hide restriction, and screen reader announcement behavior apply only when
max_timeis configured. - For assessments with unlimited time, learners can continue to hide or show the main assessment timer throughout the session.
- Only the main assessment timer can be hidden. The timer shown in the Submit, Pause, and Accessibility modal windows is always visible.
Related articles
- The
sectionsinitialization option, which can be used to set up sections for the assessment.