Text Highlight Module

The following methods are available for the text highlight module.

• applyHighlight function

  Highlights certain text based on provided information.

• enterHighlightMode function

  Enters keyboard highlight mode.

• exitHighlightMode function

  Exits keyboard highlight mode.

• hide function

  Hides all the highlighted text.

• isHighlightModeActive function

  Checks whether keyboard highlight mode is active.

• render function

  Renders stored highlights.

• setBlackListIds function

  You can define what sort of id prefix Annotations API should not store.

• setFormatRenderResult function

  Each time a texthighlight is created, you can optimize the highlight information to suit your needs.

• show function

  Show all the highlighted text.

• utils.deserializePath function

  Retrieves the DOM node based on the provided path, textNodeOffset and context element.

• utils.getPath function

  Retrieves the path (similar to startContainerPath/endContainerPath) based on the provided DOM node element and context.