Web Viewer - v0.24.0-alpha.1+dev
    Preparing search index...

    Interface WebViewerOptions

    interface WebViewerOptions {
        allow_fullscreen?: boolean;
        enable_history?: boolean;
        fallback_token?: string;
        height?: string;
        hide_welcome_screen?: boolean;
        manifest_url?: string;
        render_backend?: Backend;
        video_decoder?: VideoDecoder;
        width?: string;
    }
    Index

    Properties

    allow_fullscreen? enable_history? fallback_token? height? hide_welcome_screen? manifest_url? render_backend? video_decoder? width?

    Properties

    allow_fullscreen?: boolean

    Allow the viewer to handle fullscreen mode. This option sets canvas style so is not recommended if you are doing anything custom, or are embedding the viewer in an iframe.

    Defaults to false.

    enable_history?: boolean

    Enable the history feature of the viewer.

    This is only relevant when hide_welcome_screen is false, as it's currently only used to allow going between the welcome screen and examples.

    Defaults to false.

    fallback_token?: string

    The fallback token to use, if any.

    The fallback token behaves similarly to the REDAP_TOKEN env variable. If set in the enclosing notebook environment, it should be used to set the fallback token.

    height?: string

    The CSS height of the canvas.

    hide_welcome_screen?: boolean

    If set to true, hides the welcome screen, which contains our examples. Defaults to false.

    manifest_url?: string

    Url to the example manifest. Unused if hide_welcome_screen is set to true.

    render_backend?: Backend

    The render backend used by the viewer. Either "webgl" or "webgpu". Prefers "webgpu".

    video_decoder?: VideoDecoder

    Video decoder config used by the viewer. Either "auto", "prefer_software" or "prefer_hardware".

    width?: string

    The CSS width of the canvas.

    Settings

    Member Visibility

    On This Page

    Properties