annotationsApp - Annotations API

annotationsApp

These methods are for general interactions with the Annotations API. Use module() to access further methods for working with individual modules.

  • module function

    Returns the specified module with facade object, or if no module is specified, returns an array of all the modules that have been enabled, for example ["notepad", "stickynote"].

  • on function

    Binds an event handler (callback) that will be invoked whenever an event is triggered.

  • once function

    Just like on(), but causes the bound callback to only fire once before being removed.

  • off function

    Removes the event handler for a bound callback.

  • reset function

    Reset current annotationsApp instance.

  • safeToUnload function

    Check if there are any unsaved annotations.

  • save function

    Save all annotations data into DB.

  • showAnnotations function

    Show all the enabled annotation tools, including highlights, drawings, sticky notes and the notepad.

  • hideAnnotations function

    Hide all the enabled annotation tools, including highlights, drawings, sticky notes and the notepad.

Was this article helpful?

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