Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.01 KB

display-annotations.md

File metadata and controls

38 lines (24 loc) · 1.01 KB

displayAnnotations(config)

  1. Initialize the state of the Vue store based on a config object. See chapter "Configuration" below.
  2. Dispatches a fetchToken action to retrieve the token from localStorage or from the tokenEndpoint.
  3. Dispatches a fetchList action to retrieve all anotations that match the configured targetSource.
  4. Dispatches a fetchAcl action to retrieve the permissions.
  5. Install the Annotations Sidebar App ("AnnoApp") into the DOM.
  6. Returns a reference to the AnnoApp, which can be stored to use its API.

Configuration

See default config options and comments in default-config/.

Methods

startHighlighting(annoId, open)

Deprecated. Use .externalRequest('HighlightByTargetSelector', …) instead.

stopHighlighting(annoId)

Deprecated. Use .externalRequest('HighlightByTargetSelector', …) instead.

expand(annoId)

Open thread tree to reveal anno with id annoId.