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

    The interface used for parsed EPUB CFI selectors.

    interface IEpubCfiSelector {
        collapseToEnd(): ISelector;
        collapseToStart(): ISelector;
        createRangeSelectorTo(endSelector: ISelector): ISelector;
        getFragmentSpecificationIri(): string;
        getRefinementSelectors(): ISelector[];
        getRootNode(): IEpubCfiRootNode;
        getType(): FRAGMENT_SELECTOR;
        getValue(): string;
        isRangeSelector(): boolean;
        toJSON(): IFragmentSelectorData;
        toString(): string;
    }

    Hierarchy (View Summary)

    Implemented by

    Methods

    • If this selector is a range selector, it creates a new selector by collapsing to its end position. If this selector is not a range selector, this instance is returned.

      Returns ISelector

    • If this selector is a range selector, it creates a new selector by collapsing to its start position. If this selector is not a range selector, this instance is returned.

      Returns ISelector

    • Creates a new selector describing the range using this instance as startSelector and the passed value as endSelector. Returns null, if the selector implementation cannot create range selectors or if endSelector type is incompatible with this selector.

      The caller must guarantee that endSelector is after this selector. The implementation will not check that endSelector is after this selector.

      Parameters

      Returns ISelector

    • Get this selector as string that can be used as the fragment component of an URL. For FragmentSelectors, this will always be the value of FragmentSelector. For other selectors, the serialization algorithm defined by Selectors And States is used.

      See https://www.w3.org/TR/selectors-states/#frags

      Returns string