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

    Interface IReaderViewOptions

    Options for changing the behavior and appearance of a ReaderView.

    interface IReaderViewOptions {
        constrainEngineEventsToReaderView?: boolean;
        contentDisplayAreaOptions?: ContentDisplayAreaOptions;
        defaultPageProgressionDirection?: ReaderViewPageProgressionDirection;
        defaultStartPageSpreadSlot?: LEFT | RIGHT | AUTO;
        emitPointerMoveEventsOnHover?: boolean;
        forcePageProgressionDirection?: ReaderViewPageProgressionDirection;
        gestureOptions?: IReaderViewGestureOptions;
        name?: string;
        pageContainerOptions?: IPageContainerOptions;
        pageProgressionTimelineOptions?: IPageProgressionTimelineOptions;
        publicationStyleOptions?: IPublicationStyleOptions;
        refreshDelayMs?: number;
        rendererTransitionAnimationDurationMs?: number;
        rendererTransitionTimeoutMs?: number;
        transformManagerOptions?: IReaderViewTransformManagerOptions;
    }

    Properties

    constrainEngineEventsToReaderView?: boolean

    If true, engine events will be emitted for DOM events targeting the ReaderView element or any descendant. If false, engine events will be emitted for all DOM events within the global window scope.

    true
    contentDisplayAreaOptions?: ContentDisplayAreaOptions

    Options controlling how Content Display Areas (CDA) are calculated.

    CDAs are the areas within the ReaderView Element used for displaying publication content.

    ICalculatedContentDisplayAreaOptions
    defaultPageProgressionDirection?: ReaderViewPageProgressionDirection

    The default page progression direction to use if not defined by the publication.

    LTR
    defaultStartPageSpreadSlot?: LEFT | RIGHT | AUTO

    The default PageSpreadSlot to use for the first content document in publications if the publication does not define it. This option has no effect if the publication defines a SpreadSlot for the first content document, or when the activeRenderer cannot display spreads.

    Possible values:

    • PageSpreadSlot.LEFT: The first content document of the publication will render into the left side in the spread.
    • PageSpreadSlot.RIGHT: The first content document of the publication will render into the right slot in the spread.
    • PageSpreadSlot.AUTO: Use PageSpreadSlot.RIGHT if PageProgressionDirection is LTR (left-to-right), otherwise use PageSpreadSlot.LEFT.
    AUTO
    emitPointerMoveEventsOnHover?: boolean

    If set to false, "pointermove" events are only emitted between "pointerdown" and "pointerup" events. If set to true, all "pointermove" events will be emitted, for example when moving the mouse without pressing any button.

    false
    forcePageProgressionDirection?: ReaderViewPageProgressionDirection

    Force a specific page progression direction to be used.

    null
    gestureOptions?: IReaderViewGestureOptions

    Options related to gestures (such as pan-zoom) in the ReaderView.

    IReaderViewGestureOptions
    name?: string

    The unique name of this ReaderView. You can fetch a ReaderView by name from the ReadingSystemEngine object.

    pageContainerOptions?: IPageContainerOptions

    Options related with the page container elements used for displaying publication content.

    IPageContainerOptions
    pageProgressionTimelineOptions?: IPageProgressionTimelineOptions

    Options related with the PageProgressionTimeline.

    IPageProgressionTimelineOptions
    publicationStyleOptions?: IPublicationStyleOptions

    Allows to set various styling options when rendering the publication such as fonts and color palettes.

    IPublicationStyleOptions
    refreshDelayMs?: number

    The delay in milliseconds until a call to refresh() will actually cause a refresh. Multiple calls to refresh() within this delay will be merged into a single refresh call.

    Note: When performing a forced refresh using refresh(true), this value is ignored. The refresh will occur on next tick.

    200
    rendererTransitionAnimationDurationMs?: number

    A renderer transition happens when the activeRenderer changes, or a refresh() call requires the activeRenderer to re-layout its content. Normally the renderer transition will start when visible content has finished rendering.

    This option controls the duration of the fade-in animation.

    Default is null which will use values specific to the platform type: 'mobile', 'tablet' or 'desktop'. Setting this value to 0 disables the animation.

    null
    rendererTransitionTimeoutMs?: number

    A renderer transition happens when the activeRenderer changes, or a refresh() call requires the activeRenderer to re-layout its content. Normally the renderer transition will start when visible content has finished rendering.

    This option controls the maximum time to wait for visible content to render before starting the renderer transition anyway. Setting this to 0 will cause the renderer transition to start immediately and will cause loaders to show until pages have rendered.

    To change the loader animation you can use ReaderView.setContentOnLoading().

    500
    transformManagerOptions?: IReaderViewTransformManagerOptions

    Options related to the transform manager.

    IReaderViewTransformManagerOptions
    Properties