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

    Interface IPdfReaderPublicationOptions

    Options related to processing and presentation of PDF publications.

    interface IPdfReaderPublicationOptions {
        addColibrioSpecificFragmentSelectorData?: boolean;
        additionalLocatorUrls?: string[];
        clipboardOptions?: IReaderPublicationClipboardOptions;
        defaultLocatorUrl?: string;
        highResScaleThreshold?: number;
        includeContentLocationInPointerMoveEvents?: boolean;
        maxCanvasPixels?: number;
        preventDefaultContextMenu?: boolean;
        preventDragAndDropActions?: boolean;
        textLayerOptions?: IPdfTextLayerOptions;
    }

    Hierarchy (View Summary)

    Properties

    addColibrioSpecificFragmentSelectorData?: boolean

    When set to true, additional data will be added to fragment selectors. Such as:

    • colibrio-pagerects: A list of rectangles within page. This is for example used for representing multiple line boxes within a text selection.
    false
    additionalLocatorUrls?: string[]

    Additional locator URLs that should resolve to the ReaderPublication when calling methods with locator parameters, such as ReaderView.goTo(), ReaderViewAnnotationLayer.createAnnotation()

    This can be useful when loading Locator data such as web annotation data from third party services or other applications.

    []
    clipboardOptions?: IReaderPublicationClipboardOptions

    Options controlling clipboard actions.

    IReaderPublicationClipboardOptions
    defaultLocatorUrl?: string

    The base URL that should be used by the ReaderPublication when it creates new Locators.

    NOTE: This option can only be set when calling ReadingSystemEngine.loadPublication(). It is NOT possible to change defaultLocatorUrl using ReaderPublication.setOptions().

    If not specified, it will be generated based on the Publication's hash signature. (See IPublication.getHashSignature()) See the publication format implementation (EpubReaderPublication, PdfReaderPublication, etc) for details on how the defaultLocatorUrl is generated.

    highResScaleThreshold?: number

    The minimum amount of scaling before re-rendering the visible pages at a higher resolution.

    1.1
    includeContentLocationInPointerMoveEvents?: boolean

    If "pointermove" PointerEngineEvents should include the contentLocation property.

    Defaults to false.

    false
    maxCanvasPixels?: number

    Determines the maximum number of pixels of the canvas we render the pdf to.

    Defaults to 8M pixels for android/ios devices and 16M pixels for everything else.

    8388608
    preventDefaultContextMenu?: boolean

    If set to true, the reading system will prevent the default "right-click" and "long-press" context menus to be shown for publication content.

    In order to prevent the default "right-click" and "long-press" context menus for your app content, you need to listen on the browser contextmenu event and call event.preventDefault();

    IMPORTANT: Please note that this option does not work on iOS and iPadOS. There is no Web API available to prevent the context menu from being shown on those platforms. A workaround is to disable user content selection with ReaderView.setContentSelectionEnabled(false).

    If you are using the Colibrio Reader Framework for iOS, then please use ColibrioReadingSystemView.setAllowedCalloutActions() instead.

    false
    preventDragAndDropActions?: boolean

    Sets if users should be able to "drag-and-drop" content from the publication.

    true
    textLayerOptions?: IPdfTextLayerOptions

    Various options related to the PDF Text layer

    IPdfTextLayerOptions
    Properties