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

    Interface IStackRendererOptions

    Options used with the StackRenderer.

    interface IStackRendererOptions {
        animationDurationMs?: number;
        disable3dPerspective?: boolean;
        disableAnimations?: boolean;
        fixDisappearingCharactersInChromeForAndroid?: boolean;
        goToAnimationDurationMs?: number;
        ignoreAspectRatio?: boolean;
        insets?: IRectMargins;
        name?: string;
        pageBackgroundColor?: string;
        pageTurnShadowMaxOpacity?: number;
        perspectiveFactor?: number;
        rendererBackgroundShadowOpacity?: number;
        rubberBandElasticity?: number;
        showPageTurnShadow?: boolean;
        showRendererBackgroundShadow?: boolean;
        swipeNavigationGestureThreshold?: ILength;
    }

    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
    disable3dPerspective?: boolean

    Disables 3D perspective when swiping pages. This will also force showPageTurnShadow to false.

    false
    disableAnimations?: boolean

    If animations should be used or not by the renderer.

    false
    fixDisappearingCharactersInChromeForAndroid?: boolean

    Set to true to enable a bugfix for a specific bug in Chrome on Android. The bug causes content to sometimes disappear when performing pan-zoom gestures.

    The negative effect of enabling this bugfix is that zoomed-in content will appear blurry. The bug has not been observed since Chrome 90, but if it should resurface, setting this option to true should fix the problem.

    false
    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.

    insets?: IRectMargins

    Configures insets that can be used to allow the user to scroll content below system UI elements like the notch on mobile devices.

    For vertical insets (top and bottom), this adds extra space at the top or bottom of the scrolling container.

    For horizontal insets (left and right), this acts as padding that pushes the content in from the sides.

    Percentage values are based on the ReaderView's dimensions. Any value higher than 40% of the ReaderView's width or height will be clamped to 40%.

    Note: This option currently only has an effect when using scrolling renderers (e.g., ContinuousScrollRenderer or SingleDocumentScrollRenderer).

    Defaults to 0 for all sides.

    This API is experimental and might be subject to changes in future releases.

    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.

    #ffffff
    pageTurnShadowMaxOpacity?: number

    A value between 0 and 1 describing maximum amount of opacity that is used for the page turn shadow effects. Larger values will give darker shadows.

    0.5
    perspectiveFactor?: number

    Sets the perspective factor for the page turn animation. The final CSS value is calculated by multiplying this factor with the width (px) of the renderer. A larger value means the viewer is further away.

    2.0
    rendererBackgroundShadowOpacity?: number

    A value between 0 and 1, controlling the opacity for the shadow beneath the renderer.

    This option has no effect if showRendererBackgroundShadow is set to false.

    0.2
    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 less elasticity.

    0.65
    showPageTurnShadow?: boolean

    Render shadow effects when turning pages.

    true
    showRendererBackgroundShadow?: boolean

    Render shadow effects beneath the renderer.

    true
    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.

    Properties