Optionalallow_OptionalallowAllow 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.
Optionalcheck_OptionalcheckOverride 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).
Optionalenable_OptionalenableEnable the history feature of the viewer.
This is only relevant when hideWelcomeScreen is false,
as it's currently only used to allow going between the welcome screen and examples.
Defaults to false.
Optionalfallback_OptionalfallbackThe 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.
OptionalheightThe CSS height of the canvas.
Optionalhide_OptionalhideIf set to true, hides the welcome screen, which contains our examples. Defaults to false.
OptionalloginEnable OAuth login in the viewer.
When set, the viewer shows login UI and uses the provided URLs for OAuth redirects.
To use this:
signed-in.html and signed-out.html pages alongside your viewer.
Templates can be found at:
When not set (default), login UI is hidden. Token-based auth still works.
Optionalmanifest_OptionalmanifestUrl to the example manifest. Unused if hideWelcomeScreen is set to true.
Optionalmemory_OptionalmemoryAn 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.
Optionalrender_OptionalrenderThe render backend used by the viewer. Either "webgl" or "webgpu". Prefers "webgpu".
OptionalthemeThe color theme to use.
If not set, the viewer uses the previously persisted theme preference or defaults to "system".
Optionalvideo_OptionalvideoVideo decoder config used by the viewer. Either "auto", "prefer_software" or "prefer_hardware".
OptionalwidthThe CSS width of the canvas.
Used By