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

    Interface IRendererOptions

    General options that can be used with all Renderers.

    interface IRendererOptions {
        disableAnimations?: boolean;
        ignoreAspectRatio?: boolean;
        insets?: IRectMargins;
        name?: string;
        pageBackgroundColor?: string;
    }

    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.

    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.

    Properties