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

    Interface ISingleDocumentScrollRendererOptions

    Options specific for the SingleDocumentScrollRenderer.

    interface ISingleDocumentScrollRendererOptions {
        disableAnimations?: boolean;
        ignoreAspectRatio?: boolean;
        insets?: IRectMargins;
        maxWidth?: ILength;
        name?: string;
        pageBackgroundColor?: string;
        readingAreaOffsetBottom?: ILength;
        readingAreaOffsetTop?: ILength;
        scrollAnimationDurationMs?: number;
        scrollAnimationMaxDistance?: ILength;
        scrollbarPosition?: ScrollRendererScrollbarPosition;
        swipeNavigationGestureThreshold?: ILength;
    }

    Hierarchy (View Summary)

    Properties

    disableAnimations?: boolean

    If animations should be used or not by the renderer.

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

    maxWidth?: ILength

    Sets the maximum width of the renderer.

    If a PERCENTAGE value is used, it will be based on the width of the ReaderView.

    If a larger number than 100% of the ReaderView's width is passed, the ReaderView's width will be used.

    Defaults to 100%

    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
    readingAreaOffsetBottom?: ILength

    This option describes how far from the bottom of the renderer's visible area the Reading Area will end.

    The Reading Area defines the part of the renderer's visible area that will be used for calculations related to Reading Positions. If a SyncMediaPlayer is attached to the ReaderView and managed ReaderView synchronization is enabled, the Reading Area also has an impact on how the renderer synchronizes its visible content with the SyncMediaPlayer.

    After a navigation using ReaderView.goTo(), or after scrolling so that the old Reading Position is outside the visible range, the new Reading Position will match the top of the Reading Area.

    When SyncMediaPlayer playback causes the Reading Position to change, the renderer will, if necessary, automatically scroll to keep the Reading Position inside the Reading Area.

    Any values lower than 0 will be treated as 0, and any values higher than 30% will be treated as 30%. If a PERCENTAGE value is set, the value will be a percentage of the renderer element's clientHeight.

    Defaults to 20%

    This option is experimental and may be subject to change in future releases.

    readingAreaOffsetTop?: ILength

    This option describes how far from the top of the renderer's visible area the Reading Area will start.

    The Reading Area defines the part of the renderer's visible area that will be used for calculations related to Reading Positions. If a SyncMediaPlayer is attached to the ReaderView and managed ReaderView synchronization is enabled, the Reading Area also has an impact on how the renderer synchronizes its visible content with the SyncMediaPlayer.

    After a navigation using ReaderView.goTo(), or after scrolling so that the old Reading Position is outside the visible range, the new Reading Position will match the top of the Reading Area.

    When SyncMediaPlayer playback causes the Reading Position to change, the renderer will, if necessary, automatically scroll to keep the Reading Position inside the Reading Area.

    Any values lower than 0 will be treated as 0, and any values higher than 30% will be treated as 30%. If a PERCENTAGE value is set, the value will be a percentage of the renderer element's clientHeight.

    Defaults to 10%

    This option is experimental and may be subject to change in future releases.

    scrollAnimationDurationMs?: number

    The maximum amount of time to spend on scrolling animations. The duration will be shorter for scrolls shorter than one screen height down to a minimum of 50ms for very short scrolls.

    Default is null which will use specific values dependent on the presentation mode and platform types: 'mobile', 'tablet' or 'desktop'.

    null
    scrollAnimationMaxDistance?: ILength

    Sets the maximum scroll distance that will result in an animation. Scroll navigations longer than this distance will instead jump directly to the target location.

    If a PERCENTAGE value is used, it will be based on the height of the ReaderView.

    Defaults to 200%

    scrollbarPosition?: ScrollRendererScrollbarPosition

    Controls where the vertical scrollbar is placed.

    DOCUMENT
    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 40 CSS pixels.

    Properties