@rerun-io/web-viewer-react - npm Package Versions

0.16.0 - First configurable views - 2024-05-16

https://github.com/rerun-io/rerun/assets/3312232/475468bd-e012-4837-b2b4-b47fa9791e2c

✨ Overview & highlights

• 🟦 Customize views in code: We started exposing some view properties in the blueprint!
  • 📋 Included are:
    • Visible time ranges
      • check this new how-to guide & example that demonstrates this with plots
    • Time Series legend & y-axis configuration
    • 2D & 3D View background color
    • 2D View bounds
  • 📚 learn more on the new view blueprint doc pages
  • 🚀 …more to come in the future!
• 🕰️ Deprecated timeless in favor of new static logging
  • Except for the name change, they behave similarly in most use cases. Unlike with timeless, static data…
    • …can't be mixed with non-static data on the same component.
    • …will override previous static data and not keep old data in memory.
  • Check out our migration guide.
• 🖼️ 2D View's pan & zoom got redone, it's now a free canvas without any scroll bar
• 🤖 Added an example to use Rerun with ROS2.

As always there's a lot going on under the hood:

• 🚚 We streamlined our development processes & CI and examples.
• 🕸️ Our web page is about to switch from React to Svelte, making it a lot snappier!
• 💿 Instance key removal in 0.15.0 opened the door to major simplifications in our data store, this will make it easier for us to improve performance and implement data streaming.
• 🤗 We're making it easier to work with HuggingFace's Gradio API. Stay tuned! Most things for this already landed in this release and we'll soon build more direct support on top.

🔎 Details

🪵 Log API

• Sunset MeshProperties, introduce TriangleIndices and friends #6169
• Add a new javascript API for submitting an RRD that is stored directly as bytes #6189
• Keep Rerun viewer from dying on ctrl-c by setting sid on unix systems #6260
• Add a new CLI option / spawn options to hide the welcome screen #6262
• Make sure all log messages are sent when using .serve() #6335

🌊 C++ API

• Static-aware C & C++ SDKs #5537
• Support shared library building on Windows #6053 (thanks @traversaro!)

🐍 Python API

• Static-aware Python SDK #5536
• Make rerun-py use an embedded rerun-cli executable #5996
• Convert Python examples to proper packages #5966
• Configurable background color from Python code (POC for space view properties from code) #6068
• Codegen for space view Python blueprint classes #6100
• Allow setting view visibility from blueprint API #6108
• Expose PlotLegend and ScalarAxis (axis_y) properties on TimeSeriesView blueprint #6114
• Change background of 2D space views from code and/or UI #6116
• Set visual 2D bounds from code #6127
• Make visual time range on views a view property that can be set from Python code #6164
• Introduce new mechanism to incrementally drain from a memory_recording #6187
• Work around some issues where recording streams leaking context when used with generators #6240
• Introduce a new BinaryStreamSink that allows reading a stream of encoded bytes #6242
• Improve new time_ranges property Python API & add snippet for time series view, explaining all its options #6221
• Fix possible hang when using torch.multiprocessing #6271
• Add code examples & screenshots for all blueprint view types #6304
• Set a minimum version of pillow in rerun_py/pyproject.toml #6327
• Respect the RERUN_STRICT environment variable if not specified in rr.init #6341

🦀 Rust API

• Static-aware Rust SDK #5540
• Remove need for tokio runtime for supporting serve #6043
• Add TextDocument::from_markdown constructor #6109
• Document all public item in re_types #6146
• Fix crash on i32 overflow during arrow serialization #6285
• Revamped TimeInt #5534

🪳 Bug fixes

• Fix silently interpreting zero time range as latest-at query #6172
• Fix not being able to click suggestions in space origin selection dropdown #6200
• Fix bug in origin selection UI #6199
• Fix out-of-bounds crash in origin selection popup #6202
• Fix rare crash #6251
• Fix visual glitch when extending the time panel #6255
• Don't automatically fall back to automatic port if web socket port is already in use, only recommend using 0 instead #6296

🌁 Viewer improvements

• Request attention when Rerun Viewer is sent new recording in background #5780
• New data APIs 11: port all range-only views (plots, logs…) #5992
• New data APIs 12: port all spatial views #5993
• New data APIs 14: port everything that used to be uncached #6035
• Make visible time range UI aware of latest-at & QueryRange #6176
• Visible time ranges are now specified per timeline, not per timeline type #6204
• Send TCP protocol header to ignore non-rerun clients #6253 (thanks @gurry!)

🚀 Performance improvements

• New data APIs 4: cached latest-at mono helpers everywhere #5606
• New data APIs 5: port data UIs to new APIs #5633
• New data APIs 9: cached range queries #5755
• New data APIs 16: introduce non-cacheable components #6037
• Remove instance keys and explicit splatting everywhere #6104

🧑‍🏫 Examples

• Update depth-guided stable diffusion example to diffusers 0.27.2 #5985 (thanks @roym899!)
• Add ROS 2 bridge example #6163 (thanks @roym899!)
• Add DROID dataset example #6149 (thanks @02alexander!)
• New example and tutorial showing how to create a live scrolling plot #6314
• Update the example in configure-viewer-through-code.md to use subclasses of SpaceView #6092 (thanks @m-decoster!)

📚 Docs

• Update Python readme and add py-wheel command #5912
• Update Python API links to getting-started and tutorial #5923 (thanks @Mxbonn!)
• Fix various links in Rust, Python and toml files #5986
• Improve type index pages, codegen now knows about doc categories #5978
• Generate doc pages for blueprint views #6121
• Clarify docs on GH release install & C++ source build, remove redundant rerun_cpp_sdk artifact #6144
• Documentation for archetype and views references each other #6319

🖼 UI improvements

• Update egui_commonmark #5864
• Update UI for static components #6101
• Allow any pan/zoom in 2D spatial views #6089
• ListItem2.0 (part 1): introduce content-generic ListItem and LabelContent legacy back-port #6161
• ListItem 2.0 (part 2): introduce PropertyContent for two-column, property-like list items #6174
• ListItem 2.0 (part 3): PropertyContent column auto-sizing #6182
• ListItem 2.0 (part 4): only allocate space for property action buttons when needed #6183
• ListItem 2.0 (part 5): deploy to the Visualizers and Overrides UIs #6184
• ListItem 2.0 (part 6): split full-span range management to a dedicated module #6211
• Add button to equalize the size of the children of a container #6194
• Use thousands separators when formatting seconds #6212
• Add space view icons to various context menus #6235
• Migrate all full-span widgets to re_ui::full_span #6248
• Improve error message when using an under-powered GPU #6252
• Improve the default UI when the welcome screen is hidden #6287
• Improve UI of various components in the selection panel #6297

🕸️ Web

• Rewrite re_ws_comms to work without async & tokio runtime #6005
• Fix: Preserve history state #6302
• Make it possible to open http-streamed RRDs in follow mode via JS API #6326

📈 Analytics

• Transmit url analytics correctly for rerun.io domains #6322
• Keep track of the RRD protocol version and display it where relevant #6324

🧑‍💻 Dev-experience

• New data APIs 6: cached archetype queries #5673
• Remove justfile & fully replace remaining commands with Pixi #5892
• Replace requirements-docs.txt with a Python doc Pixi environment #5909
• Update to Rust 1.76 #5908
• Remove all dev/ci requirements.txt and fully replace with Pixi #5939
• Markdown linter #6181

🗣 Refactors

• re_web_viewer_server no longer needs tokio, split out sync code path #6030
• Replace hyper with tiny_http to serve http files for serve functionality #6042
• New data APIs 13: sunset legacy cache crate #5994
• New data APIs 15: one query crate to rule them all #6036
• ListItem 2.0 (part 0): re_ui_example refactor #6148
• Fix: re_sdk no longer depends on rustls #6210
• Reduce number of unwrap calls and make clippy warning for it opt-out per crate #6311 (thanks @Artxiom!)

📦 Dependencies

• Wgpu update (0.19.3 -> 0.19.4) #6044

🤷‍ Other

• Static data 1: static-aware datastore, caches and queries #5535
• New data APIs 0: ClampedZip iterator machinery #5573
• New data APIs 1: uncached latest-at queries #5574
• New data APIs 2: cached latest-at queries #5581
• New data APIs 3: Send/Sync/'static Component, once and for all #5605
• New data APIs 7: RangeZip iterator machinery #5679
• New data APIs 8: uncached range queries #5687
• New data APIs 10: stats and debug tools for new caches #5990
• Validate the blueprint schema when we try to activate a blueprint sent from SDK #6283

0.15.1 - Bug fix for notebooks - 2024-04-11

• Fix timeout in notebooks by making the app_url correctly point to app.rerun.io #5877
• CMake: Allow to call find_package(rerun_sdk) two or more times #5886 (thanks @traversaro!)

0.15.0 - Blueprints from Python - 2024-04-09

The biggest news is the ability to create a blueprint via the Python logging API. Check out our associated blog post for more information.

import rerun.blueprint as rrb

blueprint = rrb.Blueprint(
    rrb.Vertical(
        rrb.Spatial3DView(name="3D", origin="/"),
        rrb.Horizontal(
            rrb.TextDocumentView(name="README", origin="/description"),
            rrb.Spatial2DView(name="Camera", origin="/camera/image"),
            rrb.TimeSeriesView(origin="/plot"),
        ),
        row_shares=[3, 2],
    )
    rrb.BlueprintPanel(expanded=True),
    rrb.SelectionPanel(expanded=False),
    rrb.TimePanel(expanded=False),
)

The blueprint can then be sent to the Viewer with

rr.send_blueprint(blueprint)

Or stored to a file, and then later opened in the viewer:

blueprint.save("my_nice_dashboard.rbl")

In this case, the results looks something like this:

Blueprints are currently only supported in the Python API, with C++ and Rust support coming later.

✨ Overview & highlights

• 🟦 Configure the layout and content of space views from Python (docs)
• 🖧 More powerful and flexible data loaders (docs)
• 🖵 Improved UI for managing recordings and applications
• 💾 Save and load blueprint files in the viewer
• 🎨 Configurable background color for 3D Space Views #5443
• 💪 Linux ARM64 support #5489 #5503 #5511
• 🖼️ Show examples in the welcome page
• 🖱️ Improve context-menu when right-clicking items in the blueprint panel and streams tree
• ❌ Remove InstanceKey from our logging APIs #5395 (migration guide)
• ❌ Remove groups from blueprints panel #5326

🔎 Details

🪵 Log API

• Replace MarkerShape with code-generated enum type #5336
• Key-less data model 1: scrap InstanceKey from public logging APIs #5395
• Remove the check for WrongNumberOfInstances #5399
• Control panel expanded state via blueprint APIs #5484
• Remove deprecated TimeSeriesScalar #5604
• Customizable data loaders #5327 #5328 #5330 #5337 #5351 #5355 #5379 #5361 #5388

🌊 C++ API

• Fix Arrow libraries from download & build not being found in some cases #5366
• CMake: Add RERUN_INSTALL_RERUN_C option to disable installation of rerun_c library #5374 (thanks @traversaro!)
• CMake: Fix install not finding external arrow for dynamic linking #5375 (thanks @traversaro!)
• Make pinhole.hpp robust against min/max preprocessor macros (typically from windows.h) #5432
• Build C++ SDK for Linux ARM64 #5489
• Generate fewer .cpp files: Inline forward serialization of transparent components to their respective datatypes #5544
• Fix RERUN_C_BUILD_ARTIFACT path value if CARGO_BUILD_TARGET env variable is set #5547 (thanks @traversaro!)

🐍 Python API

• All Python components that wrap a bool now implement __bool__ #5400
• Add the remaining space views and name them consistently #5498
• Add option to include blueprint in an .rrd when calling .save(…) #5572
• Allow naming space view containers #5626

🦀 Rust API

🪳 Bug fixes

• Sort text log space view on currently selected timeline #5348
• Fix parents of queried paths getting visualized, fix 2D objects not showing at all in 3D if their camera parent is not included #5424
• Fix: allow creating 3D space views for pinhole-only 3D scenes #5563
• Fix depth cloud bounding boxes for depth cloud visualizations with transforms #5578
• Fix image view not handling images with extra leading dimensions of size 1 #5579
• Fix web viewer crash on invalid url parameter #5631
• Be consistent in how items are removed from selection #5643
• Fix layout issue on welcome screen for narrow window, triggering debug assertion #5650
• Fix broken 2D space view heuristics in Python Notebooks #5674
• Avoid a hang on Linux by always create the renderer, even when we have no store_view #5724
• Fix crash/freeze when zooming out too far in a plot #5737
• Fix draw_order not working #5794

🌁 Viewer improvements

• Remove groups from blueprints panel #5326
• Improved tracking of which space views were generated by a heuristic #5419
• Configurable background color for 3D Space Views #5443
• Save recordings from web viewer #5488
• Support loading .rbl blueprint files #5513
• Tensor space view can now show images #5567
• Entity path query now shows simple statistics and warns if nothing is displayed #5693
• Go back to example page with browser Back-button #5750
• On Web, implement navigating back/forward with mouse buttons #5792
• Support displaying 1D tensors #5837

🧑‍🏫 Examples

• New incremental_logging example #5462
• New standalone example showing blueprint configuration of some stock #5603
• New example visualizing KISS-ICP #5546 (thanks @02alexander!)
• Remove car example #5576
• Add blueprint to arkit_scenes example, leveraging the viewer's ability to re-project 3D->2D #5510
• Add blueprint to nuscenes example #5556
• Add blueprint to Face Tracking example #5616
• Add blueprint to Gesture Detection example #5619
• Add blueprint to Human Pose Tracking example #5612
• Add blueprint to Live Camera Edge Detection example #5613
• Add blueprint to LLM Embedding Ner example #5614
• Add blueprint to Objectron example #5617
• Add blueprint to Signed Distance Fields example #5635
• Add blueprint to the RGBD example #5623
• ARFlow Example Page #5320 (thanks @YiqinZhao!)
• Fix controlnet example for current controlnet package version and add blueprint #5634
• Fix RRT-Star example not showing up on website or rerun.io/viewer #5628
• Fix not logging 3D gesture z component correctly in Gesture Detection example #5630 (thanks @andreasnaoum!)
• Updated READMEs for examples: LLM Embedding-Based Named Entity Recognition, nuScenes, Objectron, Open Photogrammetry Format, Raw Mesh #5653 (thanks @andreasnaoum!)
• Updated READMEs for the examples - Batch 1 #5620 (thanks @andreasnaoum!)

📚 Docs

• Docs: improve discoverability of image compression #5675
• Improve getting started doc section #5689
• Update web viewer links #5738
• Update docs with guides and tutorials for blueprint #5641
• Update README and description of arkit_scenes example #5711 (thanks @BirgerMoell!)
• Improve readme of depth_guided_stable_diffusion example #5593 (thanks @BirgerMoell!)

🖼 UI improvements

• New timezone option: seconds since unix epoch #5450 (thanks @murgeljm!)
• Always enable entity path filter editor #5331
• Add icons for entities and components, and use them everywhere #5318
• Add support for context menu for viewport tab title and selected container's children list #5321
• Fix ListItem indentation so icons are properly aligned #5340
• Blueprint tree always starts at the origin now, "projected" paths are called out explicitly #5342
• Merge example page into welcome screen #5329
• ListItem's collapsing triangle is now styled consistently with the rest of the item #5354
• Add helpers to enable stable and controllable collapsed state in hierarchical lists #5362
• Different icon for empty entity paths #5338
• Merge quick start guides #5378
• Update welcome screen panel illustrations #5394
• More context menu in blueprint and streams tree:
  • Refactor #5392
  • Add support to show/hide DataResults #5397
  • Add support for removing DataResult from a space view #5407
  • Create a new space view with selected entities #5411
  • Add context menu to streams tree #5422
  • Add "Expand/Collapse all" actions #5433
  • Cleanup #5456
• Automatically expand and scroll the blueprint tree when focusing on an item #5482
• Save blueprint to file #5491
• Add new design guidelines for title casing etc #5501
• Automatically expand and scroll the streams tree when focusing on an item #5494
• Reduce the height of the tab bars and side panel titles #5609
• Support toggling item visibility on touch screens #5624
• Select active recording if nothing else is selected #5627
• Enable selecting data sources and blueprints and recordings in them #5646
• Warn user when a software rasterizer is used #5655
• Improve spacing and alignment of menus #5680
• Simplify Welcome Screen and use card-based layout for examples #5699
• Make selection history global instead of per recordings #5739
• Improve formatting of numbers on plot Y axis #5753
• Show all loaded applications in recordings panel #5766
• Wider selection panel by default #5777
• Tighter UI for tensor, annotation-context, view coordinates, recording #5782
• Always show welcome screen, but sometimes fade it in #5787

🕸️ Web

• Support loading multiple recordings and/or blueprints in web-viewer #5548
• Build release .wasm with debug symbols #5708

🧑‍💻 Dev-experience

• Build wheels for Linux ARM64 #5511

📦 Dependencies

• Update wgpu to 0.19.3 #5409
• Update h2 to 0.3.26 to address RUSTSEC-2024-0332 #5775

🤷‍ Other

• Build CLI for Linux ARM64 #5503
• Allow hiding/showing entity subtrees under shown/hidden parent tree #5508
• Introduce basic support for $origin substitution in EntityPathFilter #5517
• Introduce rr.notebook_show() to simplify notebook experience #5715
• Also remove nested inclusions when removing a subtree #5720
• Prevent gratuitous blueprint saves by not garbage collecting when the blueprint hasn't changed #5793
• Refactor Selection using IndexMap and make it more encapsulated #5569