Adding Annotations to Assessments

Annotations can be added to assessments via the Annotations API, which is a visual layer that allows learners and content creators to mark up the page using visual tools, leading to better collaboration and learning outcomes.

The key features of Annotations API are described below.

Learners can select this tool and then apply the highlighted color to text on the page.

texthighlight-new-example.png
Figure 1: The text highlighting tool in Annotations API.

The learners can use this tool to highlight significant text passages as they compose their answers.

From v2026.2.LTS, learners can also enter into the "Keyboard highlight mode" where they can use the keyboard to select and highlight text.

Highlighting rollover content

From v2026.3.LTS, the text highlighting tool supports rollover content, allowing learners to highlight both the original content and its alternative version.

The visibility of highlights depends on where they are applied:

  • Content outside rollover regions: Highlights remain visible when learners switch between the original and alternative content.
  • Original content within rollover regions: Highlights are visible only when the original content is displayed.
  • Alternative content within rollover regions: Highlights are visible only when the rollover content is displayed.

Note: Switching between the original and alternative content does not remove existing highlights. Highlights associated with each version are displayed only when that version is active.

Highlights applied outside rollover content (yellow) remain visible in both versions.png
Figure 2: Highlights applied outside rollover content (yellow) remain visible in both versions. Highlights applied to the original content within rollover regions (pink) are visible only when rollover content is not displayed.
Highlights applied to rollover content (green) are visible when the alternative version is displayed..png
Figure 3: Highlights applied to rollover content (green) are visible when the alternative version is displayed. Highlights applied to the original content within the rollover region (pink) are visible only when rollover content is not displayed.

For more information about creating alternative content, see Adding rollover content to assessment content.

Learners can select this tool and then place colored squares onto the page, which can contain typed text.

pythagoras updated stickynotes.png
Figure 4: The sticky note tool in Annotations API.

The learners can use the sticky note on the page as a location-centric reminder for them to execute another task and return.

Learners can open this tool and type any information they want into the Notepad window. They may be gathering their thoughts, composing a draft, or making a list of things to do, all within the assessment.

3.png
Figure 5: The notepad tool in Annotations API.

The context of the notepad extends across multiple Items, and is more readily available throughout the assessment compared to sticky notes, which only appear when their parent Question or Item is visible on the page. The notepad has a default maximum of 2,000 characters.

Learners can select this tool and then perform freehand drawing on top of the page. They can use this to draw attention to certain areas, visually mark a boundary, or indicate things to be removed.

Figure 6: The drawing tool in Annotations API.

Learners are able to sketch ideas or proposed answers onto the visual interaction space.
Note: Drawing tool is not compatible with scrolling for long content.

For more information on using Annotations API, see the developer reference documentation on this topic.

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.