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

    Interface ViewerState

    What the viewer shows, as WebViewer.get_state reports it.

    interface ViewerState {
        active_store_id?: `Recording:${string}:${string}`;
        catalog_url?: string;
        loading: ViewerLoadingSource[];
        location: string;
        recordings: ViewerRecording[];
        servers: ViewerServer[];
        viewer_version?: string;
        views: ViewerView[];
    }
    Index
    active_store_id? catalog_url? loading location recordings servers viewer_version? views
    active_store_id?: `Recording:${string}:${string}`

    The active recording.

    catalog_url?: string

    The origin of the catalog server the viewer hosts, if any.

    loading: ViewerLoadingSource[]

    What the viewer is still loading, empty once everything has arrived.

    location: string

    Where the viewer is, for WebViewer.set_location. Empty if that has no location.

    recordings: ViewerRecording[]

    Every recording open in the viewer.

    servers: ViewerServer[]

    The servers in the viewer's left panel.

    viewer_version?: string

    The version of the viewer.

    views: ViewerView[]

    The views of the active recording's blueprint.

    Settings
    Member Visibility

    On This Page
    Properties