Annotations API Methods

This article details methods the host page can use to interact with Annotations API.

annotationsApp

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

• module()
• on()
• once()
• off()
• reset()
• safeToUnload()
• save()
• showAnnotations()
• hideAnnotations()

Drawing Module

• addDrawingArea()
• enterDrawingMode()
• exitDrawingMode()
• getAllDrawingAreas()
• getDrawingTool()
• hide()
• isDrawingModeActive()
• isVisible()
• removeDrawingArea()
• setDrawingTool()
• show()
• toggleGrid()

Notepad Module

• collapse()
• expand()
• hide()
• show()
• toggle()
• isVisible()
• maximize()
• minimize()
• resize()
• setContent()

Sticky Note Module

• addNote()
• render()
• getNote()
• getAllNotes()
• expandAllNotes()
• collapseAllNotes()
• showAllNotes()
• show()
• hideAllNotes()
• hide()
• showOnlyCollectionId()

Sticky Note Getters

These public methods can be used to operate on individual instances of a Sticky Note.

• getId()
• getCollectionId()
• getContent()
• getDimensions()
• getPosition()
• isVisible()
• isExpanded()

Sticky Note Setters

These public methods can be used to operate on individual instances of a Sticky Note.

• setCollectionId()
• setContent()
• setPosition()
• expand()
• collapse()
• show()
• hide()
• resize()
• remove()

Text Highlight Module

• applyHighlight()
• render()
• setFormatRenderResult()
• show()
• hide()
• utils.setBlackListIds()
• utils.getPath()
• utils.deserializePath()