Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface IEpubCfiResolvedLocalPath

    interface IEpubCfiResolvedLocalPath {
        ast: IEpubCfiLocalPathNode;
        container: Node;
        documentUrl: URL;
        intendedTargetType: EpubCfiIntendedTargetType;
        isOpfDocument: boolean;
        missingXmlIdAssertions: boolean;
        offset: number;
        repairedWithXmlIdAssertions: boolean;
        resolverErrors: IEpubCfiResolverError[];
        stepsResolved: boolean;
        virtualTarget: EpubCfiVirtualTarget;
        createResolverError(
            type: EpubCfiResolverErrorType,
            node: Node,
            errorData: any,
        ): void;
        getDocument(): Document;
        getTargetElement(): Element;
        getTargetNode(): Node;
    }

    Properties

    ast: IEpubCfiLocalPathNode
    container: Node

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

    documentUrl: URL
    intendedTargetType: EpubCfiIntendedTargetType

    If this path intends to target an element or text

    isOpfDocument: boolean
    missingXmlIdAssertions: boolean

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

    offset: number

    The childNode offset into container

    repairedWithXmlIdAssertions: boolean

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

    resolverErrors: IEpubCfiResolverError[]

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

    stepsResolved: boolean

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

    virtualTarget: EpubCfiVirtualTarget

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

    Methods

    • Returns Document

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

      Returns Element

    • 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

    Properties
    Methods