@rerun-io/web-viewer

Rerun Web Viewer

Embed the Rerun web viewer within your app.

This package is framework-agnostic. A React wrapper is available at https://www.npmjs.com/package/@rerun-io/web-viewer-react.

Install

$ npm i @rerun-io/web-viewer

ℹ️ Note: The package version is equal to the supported rerun SDK version. This means that @rerun-io/web-viewer@0.10.0 can only connect to a data source (.rrd file, websocket connection, etc.) that originates from a rerun SDK with version 0.10.0!

Usage

The web viewer is an object which manages a canvas element:

import { WebViewer } from "@rerun-io/web-viewer";

const rrd = "…";
const parentElement = document.body;

const viewer = new WebViewer();
await viewer.start(rrd, parentElement);
// …
viewer.stop();

The rrd in the snippet above should be a URL pointing to either:

• A hosted .rrd file, such as https://app.rerun.io/version/0.14.0/examples/dna.rrd
• A WebSocket connection to the SDK opened via the serve API

If rrd is not set, the viewer will display the same welcome screen as https://app.rerun.io.

For a full example, see https://github.com/rerun-io/web-viewer-example. You can open the example via CodeSandbox: https://codesandbox.io/s/github/rerun-io/web-viewer-example

ℹ️ Note: This package only targets recent versions of browsers. If your target browser does not support Wasm imports or top-level await, you may need to install additional plugins for your bundler.

Development

$ npm run build

Changelog

0.14.0 - "Unlimited" point clouds & lines, quality of life improvements, bugfixes - 2024-02-28

https://github.com/rerun-io/rerun/assets/1220815/beb50081-2dff-4535-b133-4dc4a5a24be0

✨ Overview & highlights

Originally, we planned to do only a bugfix release, but we got an unexpected amount of goodies amassed already. We're still ramping up for programmable blueprints (soon!), but meanwhile enjoy these improvements in 0.14!

• 📈 Limits for number of points & lines per space view lifted.
• 🖱️ Added context menu (right-click) actions for items on the Blueprint panel. (Only getting started on this, more actions in future releases!)
• 🚀 Speed improvements for scenes with many transforms and large point clouds.
• 🔺 Built-in STL mesh support.
• 🎥 First-person camera.
• 🐛 Fixes regressions in Space View spawn heuristics from 0.13, and many more bugfixes.
• 🧑‍🏫 Two new examples: Gesture Recognition & RRT* Pathfinding

🔎 Details

🪵 Log API

• Add helpers for perspective cameras #5238
• Fix spawn starting the Viewer even if logging is disabled #5284

🐍 Python API

• Add missing Python docs for disable_timeline & reset_time #5269
• Fix missing error message when passing from_parent + Rerun transform type to rerun.Transform3D #5270

🦀 Rust API

• Fix using rerun crate as a dependency on CI #5170

🪳 Bug fixes

• Enforce the rule: heuristics should never add a new view that would be completely covered by an existing view #5164
• Remove log spam when quickly resizing the Viewer #5189
• Fix incorrect minimum supported Rust version mentioned in docs and examples #5195
• Less restrictive visualizability constraints of 2D entities, improved space view generation heuristics #5188
• Fix ugly UI for some Arrow data #5235
• Fix missing redraw upon resetting blueprint #5262
• Fix non-deterministic redundancy check for space view spawning heuristic #5266
• Fix resetting vertical axis when using non-uniform zoom on Time Series #5287

🌁 Viewer improvements

• Clear all blueprints in RAM and on disk when clicking "Reset Viewer" #5199
• Improve the orbit eye to always maintain an up-axis #5193
• Focus on current bounding-box when resetting camera-eye on a 3D space view (double click it) #5209
• Add STL mesh support #5244
• Add first person 3D eye-camera #5249

🚀 Performance improvements

• More robust handling of maximum texture size for non-color data, slight perf improvements for large point clouds #5229
• Cached transforms & disconnected spaces for faster scenes with many transforms #5221
• Optimized cpu time for 3D point clouds (once again!) #5273
• Only compute store/caching stats when the memory panel is opened #5274
• Increase the max WebSocket frame limit for the native client #5282

🧑‍🏫 Examples

• Add Gesture Recognition example #5241 (thanks @andreasnaoum!)
• Add example visualizing RRT* #5214 (thanks @02alexander!)

📚 Docs

• Fix broken link in the installing-viewer documentation #5236 (thanks @BirgerMoell!)

🖼 UI improvements

• Context Menu 1: Basic scaffolding and simple actions #5163
• Context menu 2: add support for multiple selection #5205
• Context menu 3: add "Move to new container" context menu action #5210
• Context menu 4: add "Clone space view" action #5265
• Context menu 5: refactor into multiple files #5289
• Clickable path parts in selection-panel #5220
• Don't show the blueprint section when selecting recordings #5245
• Use the same icon for recordings everywhere #5246

🎨 Renderer improvements

• Lift point cloud size limitations #5192
• Lift line vertex/strip count limitations #5207
• Fix banding artifacts of 3D space view's skybox #5279

📦 Dependencies

• Bump maturin to 1.14.0 #5197
• Update tungstenite to remove RUSTSEC warning #5200
• Lock the web-sys version to 0.3.67 #5211