Datatypes

rerun.blueprint.datatypes

ComponentColumnSelectorArrayLike = ComponentColumnSelector | Sequence[ComponentColumnSelectorLike] module-attribute

A type alias for any ComponentColumnSelector-like array object.

ComponentColumnSelectorLike = ComponentColumnSelector | str module-attribute

A type alias for any ComponentColumnSelector-like object.

FilterByRangeArrayLike = FilterByRange | Sequence[FilterByRangeLike] module-attribute

A type alias for any FilterByRange-like array object.

FilterByRangeLike = FilterByRange module-attribute

A type alias for any FilterByRange-like object.

FilterIsNotNullArrayLike = FilterIsNotNull | Sequence[FilterIsNotNullLike] module-attribute

A type alias for any FilterIsNotNull-like array object.

FilterIsNotNullLike = FilterIsNotNull | blueprint_datatypes.ComponentColumnSelectorLike module-attribute

A type alias for any FilterIsNotNull-like object.

SelectedColumnsArrayLike = SelectedColumns | Sequence[SelectedColumnsLike] module-attribute

A type alias for any SelectedColumns-like array object.

SelectedColumnsLike = SelectedColumns | Sequence[blueprint_datatypes.ComponentColumnSelectorLike | datatypes.Utf8Like] module-attribute

A type alias for any SelectedColumns-like object.

TensorDimensionIndexSliderArrayLike = TensorDimensionIndexSlider | Sequence[TensorDimensionIndexSliderLike] | npt.ArrayLike module-attribute

A type alias for any TensorDimensionIndexSlider-like array object.

TensorDimensionIndexSliderLike = TensorDimensionIndexSlider | int module-attribute

A type alias for any TensorDimensionIndexSlider-like object.

class ComponentColumnSelector

Bases: ComponentColumnSelectorExt

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

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

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:Component". 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 type. If used, spec must be None and entity_path must be provided. TYPE: Utf8Like | None DEFAULT: None

class FilterByRange

Bases: FilterByRangeExt

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

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

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

class FilterIsNotNull

Bases: FilterIsNotNullExt

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

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

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

class SelectedColumns

Bases: SelectedColumnsExt

Datatype: List of selected columns in a dataframe.

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

def __init__(columns)

Create a new instance of the SelectedColumns datatype.

Example:

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

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:Component", or a ComponentColumnSelector. TYPE: Sequence[ComponentColumnSelectorLike | Utf8Like]

class TensorDimensionIndexSlider

Bases: TensorDimensionIndexSliderExt

Datatype: Defines a slider for the index of some dimension.

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

def __init__(dimension)

Create a new instance of the TensorDimensionIndexSlider datatype.

PARAMETER	DESCRIPTION
dimension	The dimension number. TYPE: TensorDimensionIndexSliderLike