Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ITransientHighlightManager

description

Provides a way to add/remove highlight sets and terms from the viewer with no persistence

Hierarchy

  • ITransientHighlightManager

Index

Methods

Methods

addHighlight

createSet

  • createSet(): string

  • Creates a Highlight Set to store terms

    Returns string

disableAutoHighlight

  • disableAutoHighlight(): void

  • Turn off auto highlighting

    Returns void

enableAutoHighlight

  • Enable highlighting based on user input for the set with the given id Auto highlighting will remain active until disableAutoHighlight is called

    Parameters

    • setId: string

      The SetID to add the highlights to

    • Optional highlightConfig: PartialHighlightConfig

      Optional - theh highlight config to use

    Returns void

getSelectedAnnotations

  • Returns the currently selected annotations

    Returns HighlightMemento[]

    An array of the selected annotations represented as HighlightMementos

offadd

  • Unregister previously registered onadd listener from set with given ID

    Parameters

    • setId: string

      ID of the set to register event against

    • addCallback: IHighlightSetListenerAdd

      Event listener to unregister

    Returns void

offmove

  • Unregister previously registered onmove listener from set with given ID

    Parameters

    Returns void

offremove

  • Unregister previously registered onremove listener from set with given ID

    Parameters

    Returns void

onadd

  • Register an event listener that will be called when a highlight is added to the set with the given ID

    Parameters

    • setId: string

      ID of the set to register event against

    • addCallback: IHighlightSetListenerAdd

      Event listener to register

    Returns void

onmove

  • Register an event listener that will be called when a highlight in the set with the given ID is moved

    Parameters

    Returns void

onremove

  • Register an event listener that will be called when a highlight is removed from the set with the given ID

    Parameters

    Returns void

removeHighlight

  • removeHighlight(setId: string, highlightId: string): void

  • Removes a highlight from a given Set

    Parameters

    • setId: string

      The SetID to remove the Highlight from

    • highlightId: string

      The TermID to remove from the Highlight set

    Returns void

serialize

  • Returns the Highlight Set object based on SetID

    Parameters

    • setId: any

      the SetID to get object data from

    Returns HighlightSetMemento