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

    Interface IEpubCfiRootNode

    The root node of the EPUB CFI AST (Abstract Syntax Tree).

    interface IEpubCfiRootNode {
        errors: IEpubCfiParserError[];
        parentPath: IEpubCfiPathNode;
        rangeEndPath: IEpubCfiPathNode;
        rangeStartPath: IEpubCfiPathNode;
        src: string;
        srcModified: boolean;
        srcOffset?: number;
        type: ROOT;
    }

    Hierarchy (View Summary)

    Properties

    errors: IEpubCfiParserError[]
    parentPath: IEpubCfiPathNode

    If the EPUB CFI selects a position, it contains the full path from the OCF document to the target node and offset. If the EPUB CFI is a range, it contains the path common for the start and end positions.

    rangeEndPath: IEpubCfiPathNode

    If set, it is the path that selects the end point of the range, starting from the end of parentPath.

    rangeStartPath: IEpubCfiPathNode

    If set, it is the path that selects the start point of the range, starting from the end of parentPath.

    src: string

    The source EPUB CFI string.

    srcModified: boolean

    If src was modified due to invalid syntax.

    srcOffset?: number

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

    type: ROOT

    The type of EPUB CFI node.

    Properties