This is a lower-level API. Lower-level APIs are not recommended for most projects, and may not be available on all plans. See our page on recommended deployment patterns for more information.
Initialization Option Annotations API


Enables the drawing module, which allows users to annotate the page with a freehand drawing tool.


Request object key drawing

Type object

This object has the following properties which can be configured.

  • colors array[string]

    By default, Learnosity provides CSS class names for the colors such as "theme_1", or "theme_2" so the highlight Items will have the classname "lrn-annotations-color--theme-1".

  • show_grid boolean

    Toggles the background grid display on and off.

Was this article helpful?