Tables

rerun.blueprint.table

Configure catalog table layouts, columns, and segment previews.

⚠️ The rerun.blueprint.table namespace is unstable and may change significantly.

CardLayout dataclass

Display table records as cards.

PARAMETER	DESCRIPTION
title	Physical Arrow column name to use for card titles. If unset or not found in the table, uses the first visible string field. TYPE: str | None DEFAULT: None
link	Physical Arrow column name containing the target to open when a card is activated. If unset or not found in the table, uses the first visible field with a PreviewCell. TYPE: str | None DEFAULT: None
fields	Fields to configure, in display order, with each source listed at most once. Listed fields are visible unless visible=False; unlisted fields are hidden. At most one visible FlagCell is allowed; it appears in the card header rather than the labeled-field list. TYPE: Sequence[Column] DEFAULT: ()

Column dataclass

Configure a source column's appearance and behavior in one layout.

PARAMETER	DESCRIPTION
source	Physical Arrow column name, not a display label. TYPE: str
name	Display label, overriding column_display_mode. If unset, the label is derived from source. TYPE: str | None DEFAULT: None
editable	Allow editing; disabled by default. Requires write permission on a remote table with a column marked by rerun:is_table_index metadata. Only boolean values rendered with FlagCell support editing. TYPE: bool | None DEFAULT: None
cell	Cell renderer. If unset, the Viewer infers it from the component or Arrow datatype. TYPE: LinkCell | ThumbnailCell | FlagCell | EntryKindCell | PreviewCell | None DEFAULT: None
visible	Override visibility in this layout. Configured columns are visible by default. Set to False to hide a column while retaining its configuration and position. TYPE: bool | None DEFAULT: None

EntryKindCell dataclass

Bases: _Cell

Render an integer as a human-readable Rerun entry kind.

FlagCell dataclass

Bases: _Cell

Render a boolean as a flag.

Editable columns currently require this renderer.

LinkCell dataclass

Bases: _Cell

Render a Rerun URI as an interactive link.

PreviewCell dataclass

Bases: _Cell

Render a recording reference using one or more embedded views.

Preview timing is shared by all preview columns through PreviewsConfig.

PreviewsConfig

Bases: Archetype

Archetype: Shared configuration for every preview cell in a table blueprint.

This archetype is stored at the entity /table alongside archetypes.TableBlueprint.

⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.

__init__

def __init__(*, timeline: Utf8Like | None = None) -> None

Create a new instance of the PreviewsConfig archetype.

PARAMETER	DESCRIPTION
timeline	The timeline used by every preview cell. If left empty a timeline is automatically picked, preferring custom over built-in. TYPE: Utf8Like | None DEFAULT: None

cleared classmethod

def cleared() -> PreviewsConfig

Clear all the fields of a PreviewsConfig.

from_fields classmethod

def from_fields(
    *,
    clear_unset: bool = False,
    timeline: Utf8Like | None = None,
) -> PreviewsConfig

Update only some specific fields of a PreviewsConfig.

PARAMETER	DESCRIPTION
clear_unset	If true, all unspecified fields will be explicitly cleared. TYPE: bool DEFAULT: False
timeline	The timeline used by every preview cell. If left empty a timeline is automatically picked, preferring custom over built-in. TYPE: Utf8Like | None DEFAULT: None

TableBlueprint dataclass

Configure layouts and segment previews for a catalog table.

This configures a table, not a Viewer viewport Blueprint. Save it as an .rbl file and register its server-accessible URI with TableEntry.register_blueprint(uri) or DatasetEntry.register_blueprint(uri, segment_table=True). See Configure table layouts and segment previews for the full workflow.

PARAMETER	DESCRIPTION
table_layout	Row-and-column layout, available by default. TYPE: TableLayout | None DEFAULT: None
card_layout	Card layout, disabled unless configured. TYPE: CardLayout | None DEFAULT: None
default_layout	Initial layout: "table" or "cards". If unset, uses cards when configured, otherwise the table layout. "cards" requires card_layout. TYPE: Literal['table', 'cards'] | None DEFAULT: None
column_display_mode	Column-name formatting in both layouts; defaults to compact formatting. Explicit Column.name labels take precedence. TYPE: ColumnDisplayModeLike | None DEFAULT: None
previews_config	Timeline selection shared by every PreviewCell in both layouts. If no timeline is specified, one is picked automatically, preferring custom over built-in timelines. TYPE: PreviewsConfig | None DEFAULT: None

save

def save(
    application_id: str, path: str | Path | None = None
) -> None

Save this table blueprint to an .rbl file for catalog registration.

PARAMETER	DESCRIPTION
application_id	Application ID stored in the blueprint recording. TYPE: str
path	Output file path; defaults to <application_id>.rbl. TYPE: str | Path | None DEFAULT: None

TableLayout dataclass

Display table records as rows and columns.

PARAMETER	DESCRIPTION
columns	Columns to configure, in display order, with each source listed at most once. Listed columns appear first and are visible unless visible=False. Unlisted columns follow in default order and retain Viewer visibility defaults. TYPE: Sequence[Column] DEFAULT: ()

ThumbnailCell dataclass

Bases: _Cell

Render an image blob as a thumbnail.