Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IEpubCfiResolvedLocalPath

Index

Properties

ast

container

container: Node

The parent node that contains the target. This can be a document node if the root element is the target node.

documentUrl

documentUrl: URL

intendedTargetType

intendedTargetType: EpubCfiIntendedTargetType

If this path intends to target an element or text

isOpfDocument

isOpfDocument: boolean

missingXmlIdAssertions

missingXmlIdAssertions: boolean

Number of XML ids encountered on elements that were not defined in the AST/epubcfi.

offset

offset: number

The childNode offset into container

repairedWithXmlIdAssertions

repairedWithXmlIdAssertions: boolean

Number of XML id assertions used to get to the intended location.

resolverErrors

resolverErrors: IEpubCfiResolverError[]

A list of errors that occured while this path was resolved.

stepsResolved

stepsResolved: boolean

If all steps could be resolved with their step value and offset, or repaired with their assertion.

virtualTarget

virtualTarget: EpubCfiVirtualTarget

If this path uses a virtual target, targeting the first or the last child.

Methods

createResolverError

getDocument

  • getDocument(): Document
  • Returns Document

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

Generated using TypeDoc