Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes the content that a IDocumentQueryResultItem points to.

deprecated

Hierarchy

  • IDocumentQueryResultTarget

Index

Properties

charLength

charLength: number

The length of the match. such that charOffset + charLength gives the end of the matching result.

charOffset

charOffset: number

The character offset within the contentBlock.textContent defining the start of the matching result.

contentBlock

contentBlock: IContentBlockData

The target content block

documentLocator

documentLocator: Locator

The Locator to the document that contains the target content block.

publicationCanonicalUri

publicationCanonicalUri: string

The canonical URI to the publication where the result was found.

readerDocumentIndexInSpine

readerDocumentIndexInSpine: number

The index of the target ReaderDocument in the ReaderPublication spine.

Generated using TypeDoc