Interface IEpubCfiStepNode

Describes a step in a epubcfi path. A step normally contains a stepValue identifying a target childNode relative the result of previous step.

An assertion can optionally be set on the step, with the purpose of further validating the target element/text for this step.

interface IEpubCfiStepNode {
    assertion: IEpubCfiAssertionNode;
    srcOffset?: number;
    stepValue: number;
    type: STEP_ELEMENT | STEP_TEXT;
}

Hierarchy (View Summary)

IEpubCfiNode
- IEpubCfiStepNode
  - IEpubCfiElementStepNode
  - IEpubCfiTextStepNode

Properties

assertion

assertion: IEpubCfiAssertionNode

The assertion related with this step.

`Optional`srcOffset

srcOffset?: number

The character offset within the source EPUB CFI string corresponding to this node.

stepValue

stepValue: number

The step value. Always set if this is a 'stepText' or 'stepElement'. Is never set if this is a 'stepOffset'. An even number always target an element. An odd number always target character data.

See: http://www.idpf.org/epub/linking/cfi/epub-cfi.html#sec-path-child-ref

type

type: STEP_ELEMENT | STEP_TEXT

The type of EPUB CFI node.