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

    A fragment selector implementing the PDF fragment selector as specified by http://tools.ietf.org/rfc/rfc3778 PDF fragment selector example: page=10&highlight=50,50,640,480

    interface IPdfFragmentSelector {
        collapseToEnd(): IPdfFragmentSelector;
        collapseToStart(): IPdfFragmentSelector;
        createRangeSelectorTo(endSelector: ISelector): IPdfFragmentSelector;
        getFragmentSpecificationIri(): string;
        getHighlight(): DOMRect;
        getNamedDest(): string;
        getPageNumber(): number;
        getPageRects(): DOMRect[];
        getRefinementSelectors(): ISelector[];
        getType(): FRAGMENT_SELECTOR;
        getValue(): string;
        getViewRect(): DOMRect;
        isRangeSelector(): boolean;
        toJSON(): IFragmentSelectorData;
        toString(): string;
    }

    Hierarchy (View Summary)

    Implemented by

    Methods

    • 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 IPdfFragmentSelector

    • Returns the named destination component if any.

      Returns string

    • Returns the page number component if any.

      Returns number

    • Returns the colibrio-pagerects component if any.

      Returns DOMRect[]

    • Returns the view rectactangle component if any. The returned DOMRect defines the rectangle in default user space coordinate system.

      Returns DOMRect

    • 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