Options
All
  • Public
  • Public/Protected
  • All
Menu

The base interface for all Selectors used by the framework. Selectors are used to select partial content within resources. You can read more about Selectors in https://www.w3.org/TR/annotation-model/#selectors

Hierarchy

Index

Methods

collapseToEnd

  • If this selector is a range selector, it creates a new selector by collapsing to its end position. If this selector is not a range selector, this instance is returned.

    Returns ISelector

collapseToStart

  • If this selector is a range selector, it creates a new selector by collapsing to its start position. If this selector is not a range selector, this instance is returned.

    Returns ISelector

createRangeSelectorTo

  • Creates a new selector describing the range using this instance as startSelector and the passed value as endSelector. Returns null, if the selector implementation cannot create range selectors or if endSelector type is incompatible with this selector.

    The caller must guarantee that endSelector is after this selector. The implementation will not check that endSelector is after this selector.

    Parameters

    Returns ISelector

getRefinementSelectors

  • A Selector can optionally have a list of selectors that further refine the intended target location. Multiple Selectors should select the same content, however some Selectors will not have the same precision as others. The first selector in the array has the highest precision.

    Returns ISelector[]

getType

isRangeSelector

  • isRangeSelector(): boolean
  • Returns true if this Selector selects a range of content.

    Returns boolean

toJSON

toString

  • toString(): string
  • Get this selector as string that can be used as the fragment component of an URL. For FragmentSelectors, this will always be the value of FragmentSelector. For other selectors, the serialization algorithm defined by Selectors And States is used.

    Returns string

Generated using TypeDoc