ContextQMD
Back to Rerun

Migrating from 0.16 to 0.17

docs/content/reference/migration/migration-0-17.md

0.31.43.9 KB
Original Source

⚠️ Breaking changes

  • HalfSizes2D has been renamed to HalfSize2D
  • HalfSizes3D has been renamed to HalfSize3D
  • .rrd files from older versions won't load in Rerun 0.17

New integrated visualizer and component override UI

The visualizer and component override UI of the timeseries views has been unified and overhauled. It is also now used for all view kinds (it was previously only available for timeseries views).

In 0.16.1 and earlier:

<picture style="zoom: 0.5"> <source media="(max-width: 480px)" srcset="https://static.rerun.io/vizcomp-ui-before/ec7c0b88cdb54420665de32aaf2096dfd3dc05ea/480w.png"> </picture>

In 0.17.0:

<picture style="zoom: 0.5"> <source media="(max-width: 480px)" srcset="https://static.rerun.io/vizcomp-ui-after/86f74d239e8b77bc3df00e61cfc35eb9f4c07989/480w.png"> </picture>

See Visualizers and Overrides for more information.

New blueprint API to specify component overrides, visualizer overrides, and component defaults

This release introduces new Python APIs to set component overrides, visualizer overrides, and component defaults from code. Depending on your use-case, these new APIs become the preferred way of styling views.

For example, setting color and enabling the SeriesPoints visualizer was previously done using rr.log():

python
rr.log("data", rr.SeriesPoints(colors=[255, 255, 0]), static=True)

for t in range(1000):
    rr.set_time_sequence("frame_nr", t)
    (rr.log("data", rr.Scalar(get_data(t))),)

rr.send_blueprint(rr.blueprint.TimeSeriesView(origin="data"))

Now the override can be specified from the blueprint, removing the need to include styling information in the data store:

python
for t in range(1000):
    rr.set_time_sequence("frame_nr", t)
    (rr.log("data", rr.Scalar(get_data(t))),)

rr.send_blueprint(
    rr.blueprint.TimeSeriesView(
        origin="data",
        overrides={"data": [rr.blueprint.VisualizerOverrides("SeriesPoints"), rr.components.Color([255, 255, 0])]},
    )
)

The Plots example has been updated to showcase the new APIs. See Visualizers and Overrides for more information.

New and changed components

  • New ImagePlaneDistance to allow configuring the size of the Pinhole frustum visualization.
  • New AxisLength to allow configuring the axis length of the transform visualization.
  • New components for the DepthImage and SegmentationImage archetypes:
    • Opacity is used to configure transparency.
      • Note: layered Image are no longer made automatically transparent
    • FillRatio is used for setting the point radius on DepthImage in 3D views.
    • Colormap is used for setting DepthImage colormap.
    • AggregationPolicy is used for setting aggregation policy on line plots.
  • Radius component can now optionally specify radius in UI points
  • Renamed HalfSize2D and HalfSize3D. They were previously in plural form. All our components now are in singular form.