esc
Start typing to search the docs
Navigate Open

State­Timeline­View

⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible. A view for displaying state transitions over time, for use with archetypes.StateChange.

Properties

time_view

Configures the horizontal time axis of the state timeline.

  • link: How should the horizontal time axis be linked across multiple views?
  • view_range: The view range of the horizontal/X/time axis.
  • zoom_lock: If enabled, the X axis range will remain locked to the specified range when zooming.

time_ranges

Configures which range of states on each timeline is displayed, unless specified differently per entity.

This filters the displayed states without changing the axis window configured by time_view. If not specified, states are not filtered by time range. If a timeline is specified more than once, the first entry will be used.

Example

Use a blueprint to show a StateTimelineView.

# Use a blueprint to show a StateTimelineView.

import rerun as rr
import rerun.blueprint as rrb

rr.init("rerun_example_state_timeline", spawn=True)

rr.set_time("step", sequence=0)
rr.log("door", rr.StateChange(state="open"))

rr.set_time("step", sequence=1)
rr.log("door", rr.StateChange(state="closed"))

rr.set_time("step", sequence=2)
rr.log("door", rr.StateChange(state="open"))

# Create a state timeline view to display the state transitions.
blueprint = rrb.Blueprint(
    rrb.StateTimelineView(
        origin="/",
        name="State Transitions",
    ),
    collapse_panels=True,
)

rr.send_blueprint(blueprint)

Visualized archetypes