Web Viewer - v0.39.0
    Preparing search index...

    Interface WebViewerOptions

    interface WebViewerOptions {
        allow_fullscreen?: boolean;
        check_for_updates_on_startup?: boolean;
        enable_history?: boolean;
        fallback_token?: string;
        height?: string;
        hide_welcome_screen?: boolean;
        login?: LoginOptions;
        manifest_url?: string;
        memory_limit?: string;
        render_backend?: Backend;
        theme?: "dark" | "light" | "system";
        video_decoder?: VideoDecoder;
        width?: string;
    }
    Index
    allow_fullscreen? check_for_updates_on_startup? enable_history? fallback_token? height? hide_welcome_screen? login? manifest_url? memory_limit? render_backend? theme? video_decoder? width?
    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.

    check_for_updates_on_startup?: boolean

    Override whether the viewer checks for newer Rerun releases on startup. Set to false to disable these checks. If not set, uses the saved user preference (enabled by default).

    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.

    login?: LoginOptions

    Enable OAuth login in the viewer.

    When set, the viewer shows login UI and uses the provided URLs for OAuth redirects.

    To use this:

    1. Host the signed-in.html and signed-out.html pages alongside your viewer. Templates can be found at:
    2. Set the URLs to those pages here.
    3. Contact your Rerun representative to have the redirect URLs and origin whitelisted in the OAuth configuration.

    When not set (default), login UI is hidden. Token-based auth still works.

    manifest_url?: string

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

    memory_limit?: string

    An upper limit on how much memory the viewer uses, e.g. "500MB" or "50%".

    When this limit is reached, the viewer drops the oldest data. A percentage is relative to the 4 GiB a Wasm process can use. The limit is capped at 2.5 GB, which is also the default. If not set, uses the limit from the viewer settings.

    render_backend?: Backend

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

    theme?: "dark" | "light" | "system"

    The color theme to use.

    If not set, the viewer uses the previously persisted theme preference or defaults to "system".

    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