Skip to content

Components

rerun.blueprint.components

class ActiveTab

Bases: EntityPath, ComponentMixin

Component: The active tab in a tabbed container.

def __init__(path)

Create a new instance of the EntityPath datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class ApplyLatestAt

Bases: Bool, ComponentMixin

Component: Whether empty cells in a dataframe should be filled with a latest-at query.

def __init__(value)

Create a new instance of the Bool datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class AutoLayout

Bases: Bool, ComponentMixin

Component: Whether the viewport layout is determined automatically.

def __init__(value)

Create a new instance of the Bool datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class AutoSpaceViews

Bases: Bool, ComponentMixin

Component: Whether or not space views should be created automatically.

def __init__(value)

Create a new instance of the Bool datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class BackgroundKind

Bases: Enum

Component: The type of the background in a view.

GradientBright = 2 class-attribute instance-attribute

A bright gradient.

In 3D views it changes depending on the direction of the view.

GradientDark = 1 class-attribute instance-attribute

A dark gradient.

In 3D views it changes depending on the direction of the view.

SolidColor = 3 class-attribute instance-attribute

Simple uniform color.

def __str__()

Returns the variant name.

def auto(val) classmethod

Best-effort converter, including a case-insensitive string matcher.

class ColumnShare

Bases: Float32, ComponentMixin

Component: The layout share of a column in the container.

def __init__(value)

Create a new instance of the Float32 datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class ComponentColumnSelector

Bases: ComponentColumnSelector, ComponentMixin

Component: Describe a component column to be selected in the dataframe view.

def __init__(spec=None, *, entity_path=None, component=None)

Create a new instance of the ComponentColumnSelector datatype.

PARAMETER DESCRIPTION
spec

A string in the format "/entity/path:ComponentName". If used, entity_path and component must be None.

TYPE: str | None DEFAULT: None

entity_path

The column's entity path. If used, spec must be None and component must be provided.

TYPE: EntityPathLike | None DEFAULT: None

component

The column's component name. If used, spec must be None and entity_path must be provided.

TYPE: Utf8Like | None DEFAULT: None

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class ContainerKind

Bases: Enum

Component: The kind of a blueprint container (tabs, grid, …).

Grid = 4 class-attribute instance-attribute

Organize children in a grid layout

Horizontal = 2 class-attribute instance-attribute

Order the children left to right

Tabs = 1 class-attribute instance-attribute

Put children in separate tabs

Vertical = 3 class-attribute instance-attribute

Order the children top to bottom

def __str__()

Returns the variant name.

def auto(val) classmethod

Best-effort converter, including a case-insensitive string matcher.

class Corner2D

Bases: Enum

Component: One of four 2D corners, typically used to align objects.

LeftBottom = 3 class-attribute instance-attribute

Left bottom corner.

LeftTop = 1 class-attribute instance-attribute

Left top corner.

RightBottom = 4 class-attribute instance-attribute

Right bottom corner.

RightTop = 2 class-attribute instance-attribute

Right top corner.

def __str__()

Returns the variant name.

def auto(val) classmethod

Best-effort converter, including a case-insensitive string matcher.

class FilterByRange

Bases: FilterByRange, ComponentMixin

Component: Configuration for a filter-by-range feature of the dataframe view.

def __init__(start, end)

Create a new instance of the FilterByRange datatype.

PARAMETER DESCRIPTION
start

Beginning of the time range.

TYPE: TimeIntLike

end

End of the time range (inclusive).

TYPE: TimeIntLike

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class FilterIsNotNull

Bases: FilterIsNotNull, ComponentMixin

Component: Configuration for the filter is not null feature of the dataframe view.

def __init__(active, column)

Create a new instance of the FilterIsNotNull datatype.

PARAMETER DESCRIPTION
active

Whether the filter by event feature is active.

TYPE: BoolLike

column

The column used when the filter by event feature is used.

TYPE: ComponentColumnSelectorLike

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class GridColumns

Bases: UInt32, ComponentMixin

Component: How many columns a grid container should have.

def __init__(value)

Create a new instance of the UInt32 datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class IncludedContent

Bases: EntityPath, ComponentMixin

Component: All the contents in the container.

def __init__(path)

Create a new instance of the EntityPath datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class IncludedSpaceView

Bases: Uuid, ComponentMixin

Component: The unique id of a space view, used to refer to views in containers.

def __init__(bytes)

Create a new instance of the Uuid datatype.

PARAMETER DESCRIPTION
bytes

The raw bytes representing the UUID.

TYPE: UuidLike

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class Interactive

Bases: Bool, ComponentMixin

Component: Whether the entity can be interacted with.

Non interactive components are still visible, but mouse interactions in the view are disabled.

def __init__(value)

Create a new instance of the Bool datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class LockRangeDuringZoom

Bases: Bool, ComponentMixin

Component: Indicate whether the range should be locked when zooming in on the data.

Default is false, i.e. zoom will change the visualized range.

def __init__(value)

Create a new instance of the Bool datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class PanelState

Bases: Enum

Component: Tri-state for panel controls.

Collapsed = 2 class-attribute instance-attribute

Visible, but as small as possible on its shorter axis.

Expanded = 3 class-attribute instance-attribute

Fully expanded.

Hidden = 1 class-attribute instance-attribute

Completely hidden.

def __str__()

Returns the variant name.

def auto(val) classmethod

Best-effort converter, including a case-insensitive string matcher.

class QueryExpression

Bases: Utf8, ComponentMixin

Component: An individual query expression used to filter a set of datatypes.EntityPaths.

Each expression is either an inclusion or an exclusion expression. Inclusions start with an optional + and exclusions must start with a -.

Multiple expressions are combined together as part of SpaceViewContents.

The /** suffix matches the whole subtree, i.e. self and any child, recursively (/world/** matches both /world and /world/car/driver). Other uses of * are not (yet) supported.

def __init__(value)

Create a new instance of the Utf8 datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class RootContainer

Bases: Uuid, ComponentMixin

Component: The container that sits at the root of a viewport.

def __init__(bytes)

Create a new instance of the Uuid datatype.

PARAMETER DESCRIPTION
bytes

The raw bytes representing the UUID.

TYPE: UuidLike

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class RowShare

Bases: Float32, ComponentMixin

Component: The layout share of a row in the container.

def __init__(value)

Create a new instance of the Float32 datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class SelectedColumns

Bases: SelectedColumns, ComponentMixin

Component: Describe a component column to be selected in the dataframe view.

def __init__(columns)

Create a new instance of the SelectedColumns datatype.

Example: 

SelectedColumns(["timeline", "/entity/path:ComponentName"])

PARAMETER DESCRIPTION
columns

The columns to include.

The column must be either of the timeline, or component kind. Timeline columns can be specified using a str without any :, or an Utf8. Component columns can be specified using either a str in the form of "/entity/path:ComponentName", or a ComponentColumnSelector.

TYPE: Sequence[ComponentColumnSelectorLike | Utf8Like]

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class SpaceViewClass

Bases: Utf8, ComponentMixin

Component: The class identifier of view, e.g. "2D", "TextLog", ….

def __init__(value)

Create a new instance of the Utf8 datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class SpaceViewMaximized

Bases: Uuid, ComponentMixin

Component: Whether a space view is maximized.

def __init__(bytes)

Create a new instance of the Uuid datatype.

PARAMETER DESCRIPTION
bytes

The raw bytes representing the UUID.

TYPE: UuidLike

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class SpaceViewOrigin

Bases: EntityPath, ComponentMixin

Component: The origin of a SpaceView.

def __init__(path)

Create a new instance of the EntityPath datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class TensorDimensionIndexSlider

Bases: TensorDimensionIndexSlider, ComponentMixin

Component: Show a slider for the index of some dimension of a slider.

def __init__(dimension)

Create a new instance of the TensorDimensionIndexSlider datatype.

PARAMETER DESCRIPTION
dimension

The dimension number.

TYPE: TensorDimensionIndexSliderLike

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class TimelineName

Bases: Utf8, ComponentMixin

Component: A timeline identified by its name.

def __init__(value)

Create a new instance of the Utf8 datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class ViewFit

Bases: Enum

Component: Determines whether an image or texture should be scaled to fit the viewport.

Fill = 2 class-attribute instance-attribute

Scale the image for the largest possible fit in the view's container.

FillKeepAspectRatio = 3 class-attribute instance-attribute

Scale the image for the largest possible fit in the view's container, but keep the original aspect ratio.

Original = 1 class-attribute instance-attribute

No scaling, pixel size will match the image's width/height dimensions in pixels.

def __str__()

Returns the variant name.

def auto(val) classmethod

Best-effort converter, including a case-insensitive string matcher.

class ViewerRecommendationHash

Bases: UInt64, ComponentMixin

Component: Hash of a viewer recommendation.

The formation of this hash is considered an internal implementation detail of the viewer.

def __init__(value)

Create a new instance of the UInt64 datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class Visible

Bases: Bool, ComponentMixin

Component: Whether the container, view, entity or instance is currently visible.

def __init__(value)

Create a new instance of the Bool datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class VisibleTimeRange

Bases: VisibleTimeRange, ComponentMixin

Component: The range of values on a given timeline that will be included in a view's query.

Refer to VisibleTimeRanges archetype for more information.

def __init__(timeline, range=None, *, start=None, end=None)

Create a new instance of the VisibleTimeRange datatype.

PARAMETER DESCRIPTION
timeline

Name of the timeline this applies to.

TYPE: Utf8Like

range

Time range to use for this timeline.

TYPE: TimeRangeLike | None DEFAULT: None

start

Low time boundary for sequence timeline. Specify this instead of range.

TYPE: TimeRangeBoundary | None DEFAULT: None

end

High time boundary for sequence timeline. Specify this instead of range.

TYPE: TimeRangeBoundary | None DEFAULT: None

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class VisualBounds2D

Bases: VisualBounds2DExt, Range2D, ComponentMixin

Component: Visual bounds in 2D space used for Spatial2DView.

def __init__(*, x_range, y_range)

Create a new instance of the VisualBounds2D component.

PARAMETER DESCRIPTION
x_range

The minimum visible range of the X-axis (usually left and right bounds).

TYPE: Range1DLike

y_range

The minimum visible range of the Y-axis (usually left and right bounds).

TYPE: Range1DLike

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.

class VisualizerOverrides

Bases: Utf8List, ComponentMixin

Component: Override the visualizers for an entity.

This component is a stop-gap mechanism based on the current implementation details of the visualizer system. It is not intended to be a long-term solution, but provides enough utility to be useful in the short term.

The long-term solution is likely to be based off: https://github.com/rerun-io/rerun/issues/6626

This can only be used as part of blueprints. It will have no effect if used in a regular entity.

def __init__(value)

Create a new instance of the Utf8List datatype.

def arrow_type() classmethod

The pyarrow type of this batch.

Part of the ComponentBatchLike logging interface.

def as_arrow_array()

The component as an arrow batch.

Part of the ComponentBatchLike logging interface.

def component_name()

The name of the component.

Part of the ComponentBatchLike logging interface.