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

    Interface ISpreadSwipeRendererOptions

    Options used with the SpreadSwipeRenderer.

    interface ISpreadSwipeRendererOptions {
        animationDurationMs?: number;
        direction?: Axis;
        disableAnimations?: boolean;
        enablePageSpreadCenterSupport?: boolean;
        goToAnimationDurationMs?: number;
        ignoreAspectRatio?: boolean;
        minMarginBetweenSpreads?: number;
        name?: string;
        pageBackgroundColor?: string;
        rubberBandElasticity?: number;
        swipeNavigationGestureThreshold?: ILength;
        useWindowDimensionsForPageContainers?: boolean;
    }

    Hierarchy (View Summary)

    Properties

    animationDurationMs?: number

    How long the animations to next/previous will be. Default is null which will use specific values dependent on the presentation mode and platform types: 'mobile', 'tablet' or 'desktop'.

    null
    direction?: Axis

    The swipe direction to use. Default value is Axis.X

    X
    disableAnimations?: boolean

    If animations should be used or not by the renderer.

    false
    enablePageSpreadCenterSupport?: boolean

    Enables support for center spread in pages

    true
    goToAnimationDurationMs?: number

    The goTo animation duration when fading in. The default value null will use platform specific duration.

    null
    ignoreAspectRatio?: boolean

    Ignore the calculated aspectRatio to take up as much of the available view space as possible.

    false

    Please use the ReaderView option contentDisplayAreaOptions instead.

    minMarginBetweenSpreads?: number

    Minimum margin between spreads in pixels.

    24
    name?: string

    The name of the Renderer. This can be used to retrieve the Renderer from the ReaderView etc.

    Defaults to generated name.

    pageBackgroundColor?: string

    A CSS color to use as default page background.

    transparent
    rubberBandElasticity?: number

    A number between 0 and 1 configuring the rubberband effect when trying to swipe before the first page or after the last page. Lower value means stronger rubberband effect.

    0.65
    swipeNavigationGestureThreshold?: ILength

    Controls the minimum swipe distance required to trigger navigation to the next or previous page. A higher value means the user must swipe farther to turn pages.

    Percentage values are based on the width of the ReaderView.

    Defaults to 20 CSS pixels.

    useWindowDimensionsForPageContainers?: boolean

    Use full window dimensions when calculating spread container sizes. This option should be true if the ReaderView element allows content to overflow.

    true
    Properties