Skip to content

APIs

rerun.blueprint

BlueprintPart = Union[ContainerLike, BlueprintPanel, SelectionPanel, TimePanel] module-attribute

The types that make up a blueprint.

ContainerLike = Union[Container, SpaceView] module-attribute

A type that can be converted to a container.

These types all implement a to_container() method that wraps them in the necessary helper classes.

class Blueprint

The top-level description of the viewer blueprint.

def __init__(*parts, auto_layout=None, auto_space_views=None, collapse_panels=False)

Construct a new blueprint from the given parts.

Each BlueprintPart can be one of the following:

It is an error to provide more than one of instance of any of the panel types.

Blueprints only have a single top-level "root" container that defines the viewport. If you provide multiple ContainerLike instances, they will be combined under a single root Tab container.

PARAMETER DESCRIPTION
*parts

The parts of the blueprint.

TYPE: BlueprintPart DEFAULT: ()

auto_layout

Whether to automatically layout the viewport. If True, the container layout will be reset whenever a new space view is added to the viewport. Defaults to False. Defaults to False unless no Containers or SpaceViews are provided, in which case it defaults to True. If you want to create a completely empty Blueprint, you must explicitly set this to False.

TYPE: bool | None DEFAULT: None

auto_space_views

Whether to automatically add space views to the viewport. If True, the viewport will automatically add space views based on content in the data store. Defaults to False unless no Containers or SpaceViews are provided, in which case it defaults to True. If you want to create a completely empty Blueprint, you must explicitly set this to False.

TYPE: bool | None DEFAULT: None

collapse_panels

Whether to collapse the panels in the viewer. Defaults to False.

TYPE: bool DEFAULT: False

def connect(application_id, *, addr=None, make_active=True, make_default=True)

Connect to a remote Rerun Viewer on the given ip:port and send this blueprint.

PARAMETER DESCRIPTION
application_id

The application ID to use for this blueprint. This must match the application ID used when initiating rerun for any data logging you wish to associate with this blueprint.

TYPE: str

addr

The ip:port to connect to

TYPE: str | None DEFAULT: None

make_active

Immediately make this the active blueprint for the associated app_id. Note that setting this to false does not mean the blueprint may not still end up becoming active. In particular, if make_default is true and there is no other currently active blueprint.

TYPE: bool DEFAULT: True

make_default

Make this the default blueprint for the app_id. The default blueprint will be used as the template when the user resets the blueprint for the app. It will also become the active blueprint if no other blueprint is currently active.

TYPE: bool DEFAULT: True

def save(application_id, path=None)

Save this blueprint to a file. Rerun recommends the .rbl suffix.

PARAMETER DESCRIPTION
application_id

The application ID to use for this blueprint. This must match the application ID used when initiating rerun for any data logging you wish to associate with this blueprint.

TYPE: str

path

The path to save the blueprint to. Defaults to <application_id>.rbl.

TYPE: str | None DEFAULT: None

def spawn(application_id, port=9876, memory_limit='75%')

Spawn a Rerun viewer with this blueprint.

PARAMETER DESCRIPTION
application_id

The application ID to use for this blueprint. This must match the application ID used when initiating rerun for any data logging you wish to associate with this blueprint.

TYPE: str

port

The port to listen on.

TYPE: int DEFAULT: 9876

memory_limit

An upper limit on how much memory the Rerun Viewer should use. When this limit is reached, Rerun will drop the oldest data. Example: 16GB or 50% (of system total).

TYPE: str DEFAULT: '75%'

def to_blueprint()

Conform with the BlueprintLike interface.

class Container

Base class for all container types.

Consider using one of the subclasses instead of this class directly:

These are ergonomic helpers on top of rerun.blueprint.archetypes.ContainerBlueprint.

def __init__(*args, contents=None, kind, column_shares=None, row_shares=None, grid_columns=None, active_tab=None, name)

Construct a new container.

PARAMETER DESCRIPTION
*args

All positional arguments are forwarded to the contents parameter for convenience.

TYPE: Container | SpaceView DEFAULT: ()

contents

The contents of the container. Each item in the iterable must be a SpaceView or a Container. This can only be used if no positional arguments are provided.

TYPE: Optional[Iterable[Container | SpaceView]] DEFAULT: None

kind

The kind of the container. This must correspond to a known container kind. Prefer to use one of the subclasses of Container which will populate this for you.

TYPE: ContainerKindLike

column_shares

The layout shares of the columns in the container. The share is used to determine what fraction of the total width each column should take up. The column with index i will take up the fraction shares[i] / total_shares. This is only applicable to Horizontal or Grid containers.

TYPE: Optional[ColumnShareArrayLike] DEFAULT: None

row_shares

The layout shares of the rows in the container. The share is used to determine what fraction of the total height each row should take up. The row with index i will take up the fraction shares[i] / total_shares. This is only applicable to Vertical or Grid containers.

TYPE: Optional[RowShareArrayLike] DEFAULT: None

grid_columns

The number of columns in the grid. This is only applicable to Grid containers.

TYPE: Optional[int] DEFAULT: None

active_tab

The active tab in the container. This is only applicable to Tabs containers.

TYPE: Optional[int | str] DEFAULT: None

name

The name of the container

TYPE: Utf8Like | None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

def to_blueprint()

Convert this container to a full blueprint.

def to_container()

Convert this space view to a container.

class Horizontal

Bases: Container

A horizontal container.

def __init__(*args, contents=None, column_shares=None, name=None)

Construct a new horizontal container.

PARAMETER DESCRIPTION
*args

All positional arguments are forwarded to the contents parameter for convenience.

TYPE: Container | SpaceView DEFAULT: ()

contents

The contents of the container. Each item in the iterable must be a SpaceView or a Container. This can only be used if no positional arguments are provided.

TYPE: Optional[Iterable[Container | SpaceView]] DEFAULT: None

column_shares

The layout shares of the columns in the container. The share is used to determine what fraction of the total width each column should take up. The column with index i will take up the fraction shares[i] / total_shares.

TYPE: Optional[ColumnShareArrayLike] DEFAULT: None

name

The name of the container

TYPE: Utf8Like | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

def to_blueprint()

Convert this container to a full blueprint.

def to_container()

Convert this space view to a container.

class Vertical

Bases: Container

A vertical container.

def __init__(*args, contents=None, row_shares=None, name=None)

Construct a new vertical container.

PARAMETER DESCRIPTION
*args

All positional arguments are forwarded to the contents parameter for convenience.

TYPE: Container | SpaceView DEFAULT: ()

contents

The contents of the container. Each item in the iterable must be a SpaceView or a Container. This can only be used if no positional arguments are provided.

TYPE: Optional[Iterable[Container | SpaceView]] DEFAULT: None

row_shares

The layout shares of the rows in the container. The share is used to determine what fraction of the total height each row should take up. The row with index i will take up the fraction shares[i] / total_shares.

TYPE: Optional[RowShareArrayLike] DEFAULT: None

name

The name of the container

TYPE: Utf8Like | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

def to_blueprint()

Convert this container to a full blueprint.

def to_container()

Convert this space view to a container.

class Grid

Bases: Container

A grid container.

def __init__(*args, contents=None, column_shares=None, row_shares=None, grid_columns=None, name=None)

Construct a new grid container.

PARAMETER DESCRIPTION
*args

All positional arguments are forwarded to the contents parameter for convenience.

TYPE: Container | SpaceView DEFAULT: ()

contents

The contents of the container. Each item in the iterable must be a SpaceView or a Container. This can only be used if no positional arguments are provided.

TYPE: Optional[Iterable[Container | SpaceView]] DEFAULT: None

column_shares

The layout shares of the columns in the container. The share is used to determine what fraction of the total width each column should take up. The column with index i will take up the fraction shares[i] / total_shares.

TYPE: Optional[ColumnShareArrayLike] DEFAULT: None

row_shares

The layout shares of the rows in the container. The share is used to determine what fraction of the total height each row should take up. The row with index i will take up the fraction shares[i] / total_shares.

TYPE: Optional[RowShareArrayLike] DEFAULT: None

grid_columns

The number of columns in the grid.

TYPE: Optional[int] DEFAULT: None

name

The name of the container

TYPE: Utf8Like | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

def to_blueprint()

Convert this container to a full blueprint.

def to_container()

Convert this space view to a container.

class Tabs

Bases: Container

A tab container.

def __init__(*args, contents=None, active_tab=None, name=None)

Construct a new tab container.

PARAMETER DESCRIPTION
*args

All positional arguments are forwarded to the contents parameter for convenience.

TYPE: Container | SpaceView DEFAULT: ()

contents

The contents of the container. Each item in the iterable must be a SpaceView or a Container. This can only be used if no positional arguments are provided.

TYPE: Optional[Iterable[Container | SpaceView]] DEFAULT: None

active_tab

The index or name of the active tab.

TYPE: Optional[int | str] DEFAULT: None

name

The name of the container

TYPE: Utf8Like | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

def to_blueprint()

Convert this container to a full blueprint.

def to_container()

Convert this space view to a container.

class SpaceView

Base class for all space view types.

Consider using one of the subclasses instead of this class directly:

These are ergonomic helpers on top of rerun.blueprint.archetypes.SpaceViewBlueprint.

def __init__(*, class_identifier, origin, contents, name)

Construct a blueprint for a new space view.

PARAMETER DESCRIPTION
name

The name of the space view.

TYPE: Utf8Like | None

class_identifier

The class of the space view to add. This must correspond to a known space view class. Prefer to use one of the subclasses of SpaceView which will populate this for you.

TYPE: Utf8Like

origin

The EntityPath to use as the origin of this space view. All other entities will be transformed to be displayed relative to this origin.

TYPE: EntityPathLike

contents

The contents of the space view specified as a query expression. This is either a single expression, or a list of multiple expressions. See rerun.blueprint.archetypes.SpaceViewContents.

TYPE: SpaceViewContentsLike

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

def to_blueprint()

Convert this space view to a full blueprint.

def to_container()

Convert this space view to a container.

class BarChartView

Bases: SpaceView

A bar chart view.

def __init__(*, origin='/', contents='$origin/**', name=None)

Construct a blueprint for a new bar chart view.

PARAMETER DESCRIPTION
origin

The EntityPath to use as the origin of this view. All other entities will be transformed to be displayed relative to this origin.

TYPE: EntityPathLike DEFAULT: '/'

contents

The contents of the space view specified as a query expression. This is either a single expression, or a list of multiple expressions. See rerun.blueprint.archetypes.SpaceViewContents.

TYPE: SpaceViewContentsLike DEFAULT: '$origin/**'

name

The name of the view.

TYPE: Utf8Like | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

def to_blueprint()

Convert this space view to a full blueprint.

def to_container()

Convert this space view to a container.

class Spatial2DView

Bases: SpaceView

A Spatial 2D view.

def __init__(*, origin='/', contents='$origin/**', name=None)

Construct a blueprint for a new spatial 2D view.

PARAMETER DESCRIPTION
origin

The EntityPath to use as the origin of this view. All other entities will be transformed to be displayed relative to this origin.

TYPE: EntityPathLike DEFAULT: '/'

contents

The contents of the space view specified as a query expression. This is either a single expression, or a list of multiple expressions. See rerun.blueprint.archetypes.SpaceViewContents.

TYPE: SpaceViewContentsLike DEFAULT: '$origin/**'

name

The name of the view.

TYPE: Utf8Like | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

def to_blueprint()

Convert this space view to a full blueprint.

def to_container()

Convert this space view to a container.

class Spatial3DView

Bases: SpaceView

A Spatial 3D view.

def __init__(*, origin='/', contents='$origin/**', name=None)

Construct a blueprint for a new spatial 3D view.

PARAMETER DESCRIPTION
origin

The EntityPath to use as the origin of this view. All other entities will be transformed to be displayed relative to this origin.

TYPE: EntityPathLike DEFAULT: '/'

contents

The contents of the space view specified as a query expression. This is either a single expression, or a list of multiple expressions. See rerun.blueprint.archetypes.SpaceViewContents.

TYPE: SpaceViewContentsLike DEFAULT: '$origin/**'

name

The name of the view.

TYPE: Utf8Like | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

def to_blueprint()

Convert this space view to a full blueprint.

def to_container()

Convert this space view to a container.

class TensorView

Bases: SpaceView

A tensor view.

def __init__(*, origin='/', contents='$origin/**', name=None)

Construct a blueprint for a new tensor view.

PARAMETER DESCRIPTION
origin

The EntityPath to use as the origin of this view. All other entities will be transformed to be displayed relative to this origin.

TYPE: EntityPathLike DEFAULT: '/'

contents

The contents of the space view specified as a query expression. This is either a single expression, or a list of multiple expressions. See rerun.blueprint.archetypes.SpaceViewContents.

TYPE: SpaceViewContentsLike DEFAULT: '$origin/**'

name

The name of the view.

TYPE: Utf8Like | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

def to_blueprint()

Convert this space view to a full blueprint.

def to_container()

Convert this space view to a container.

class TextDocumentView

Bases: SpaceView

A text document view.

def __init__(*, origin='/', contents='$origin/**', name=None)

Construct a blueprint for a new text document view.

PARAMETER DESCRIPTION
origin

The EntityPath to use as the origin of this view. All other entities will be transformed to be displayed relative to this origin.

TYPE: EntityPathLike DEFAULT: '/'

contents

The contents of the space view specified as a query expression. This is either a single expression, or a list of multiple expressions. See rerun.blueprint.archetypes.SpaceViewContents.

TYPE: SpaceViewContentsLike DEFAULT: '$origin/**'

name

The name of the view.

TYPE: Utf8Like | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

def to_blueprint()

Convert this space view to a full blueprint.

def to_container()

Convert this space view to a container.

class TextLogView

Bases: SpaceView

A text log view.

def __init__(*, origin='/', contents='$origin/**', name=None)

Construct a blueprint for a new text log view.

PARAMETER DESCRIPTION
origin

The EntityPath to use as the origin of this view. All other entities will be transformed to be displayed relative to this origin.

TYPE: EntityPathLike DEFAULT: '/'

contents

The contents of the space view specified as a query expression. This is either a single expression, or a list of multiple expressions. See rerun.blueprint.archetypes.SpaceViewContents.

TYPE: SpaceViewContentsLike DEFAULT: '$origin/**'

name

The name of the view.

TYPE: Utf8Like | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

def to_blueprint()

Convert this space view to a full blueprint.

def to_container()

Convert this space view to a container.

class TimeSeriesView

Bases: SpaceView

A time series view.

def __init__(*, origin='/', contents='$origin/**', name=None)

Construct a blueprint for a new time series view.

PARAMETER DESCRIPTION
origin

The EntityPath to use as the origin of this view. All other entities will be transformed to be displayed relative to this origin.

TYPE: EntityPathLike DEFAULT: '/'

contents

The contents of the space view specified as a query expression. This is either a single expression, or a list of multiple expressions. See rerun.blueprint.archetypes.SpaceViewContents.

TYPE: SpaceViewContentsLike DEFAULT: '$origin/**'

name

The name of the view.

TYPE: Utf8Like | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

def to_blueprint()

Convert this space view to a full blueprint.

def to_container()

Convert this space view to a container.

class BlueprintPanel

Bases: Panel

The state of the blueprint panel.

def __init__(*, expanded=None)

Construct a new blueprint panel.

PARAMETER DESCRIPTION
expanded

Whether the panel is expanded or not.

TYPE: bool | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

class SelectionPanel

Bases: Panel

The state of the selection panel.

def __init__(*, expanded=None)

Construct a new selection panel.

PARAMETER DESCRIPTION
expanded

Whether the panel is expanded or not.

TYPE: bool | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.

class TimePanel

Bases: Panel

The state of the time panel.

def __init__(*, expanded=None)

Construct a new time panel.

PARAMETER DESCRIPTION
expanded

Whether the panel is expanded or not.

TYPE: bool | None DEFAULT: None

def blueprint_path()

The blueprint path where this space view will be logged.

Note that although this is an EntityPath, is scoped to the blueprint tree and not a part of the regular data hierarchy.