Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IEpubCfiResolvedPath

Index

Properties

ast

The AST used to resolve this path.

characterOffsetOutOfBounds

characterOffsetOutOfBounds: boolean

container

container: Node

The container node for the "target", where "target" can be a node in the DOM tree or a character offset. The container can be a Element, Text, Document or DocumentFragment node.

documentUrl

documentUrl: URL

The file path to the document

elementCharacterOffset

elementCharacterOffset: number

Set if intended target type is 'element' and there was a character offset defined. Used for referencing the "alt" text in elements.

indirectionsResolved

indirectionsResolved: boolean

If all indirections were resolved successfully.

intendedTargetType

intendedTargetType: EpubCfiIntendedTargetType

If the epubcfi intended to target a characters or an element. This depends if the terminal step in this path was odd or even.

localPaths

All local paths that were resolved in this path.

offset

offset: number

The childNode offset into container

sideBias

sideBias: EpubCfiSideBias

Will be set if the terminal step of the path contained the assertion parameter 's' with a valid value.

spatialOffset

spatialOffset: IEpubCfiSpatialOffset

The spatial offset if any.

stepsResolved

stepsResolved: boolean

If steps were resolved, i.e. the steps pointed to existing or virtual nodes, or were recovered using assertions. Will be false if any indirection failed to resolve.

temporalOffset

temporalOffset: IEpubCfiTemporalOffset

The temporal offset if any,

virtualTarget

virtualTarget: EpubCfiVirtualTarget

If this path uses a virtual target, targeting 'firstChild' or the 'lastChild'. This will be set if the epubcfi ends with a step of 0 or N+2 where N is the last valid element step. If a step was larger than N+2, virtualTarget will be set to 'lastChild' and stepsResolved to false.

Methods

addResolvedLocalPath

getDocument

  • getDocument(): Document
  • Returns Document

getResolverErrors

getTargetElement

  • getTargetElement(): Element
  • Get the target Element, if the intended target was en element and it is not the virtual first or virtual last element.

    Returns Element

getTargetNode

  • getTargetNode(): Node
  • Get the target node for this local path, unless the target is a virtual Target in which case the container is returned instead.

    Returns Node

getTerminalLocalPath

isMissingXmlIdAssertions

  • isMissingXmlIdAssertions(): boolean
  • Returns boolean

isRepairedWithXmlIdAssertions

  • isRepairedWithXmlIdAssertions(): boolean
  • Returns boolean

isTargetingOpfDocument

  • isTargetingOpfDocument(): boolean
  • Returns boolean

Generated using TypeDoc