Components
rerun.blueprint.components
class ActiveTab
Bases: EntityPath, ComponentMixin
Component: The active tab in a tabbed container.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns 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.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class AutoLayout
Bases: Bool, ComponentMixin
Component: Whether the viewport layout is determined automatically.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class AutoViews
Bases: Bool, ComponentMixin
Component: Whether or not views should be created automatically.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns 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.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns 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.
⚠️ 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,
TYPE:
|
entity_path
|
The column's entity path. If used,
TYPE:
|
component
|
The column's component type. If used,
TYPE:
|
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_type()
Returns 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 Enabled
Bases: Bool, ComponentMixin
Component: Whether a procedure is enabled.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class Eye3DKind
Bases: Enum
Component: The kind of the 3D eye to view a scene in a views.Spatial3DView.
This is used to specify how the controls of the view react to user input (such as mouse gestures).
FirstPerson = 1
class-attribute
instance-attribute
First person point of view.
The camera perspective as if one is seeing it through the eyes of a person as popularized by first-person games. The center of rotation is the position of the eye (the camera). Dragging the mouse on the spatial 3D view, will rotation the scene as if one is moving their head around.
Orbital = 2
class-attribute
instance-attribute
Orbital eye.
The center of rotation is located to a center location in front of the eye (it is different from the eye location itself), as if the eye was orbiting around the scene.
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.
⚠️ 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:
|
end
|
End of the time range (inclusive).
TYPE:
|
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_type()
Returns 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.
⚠️ 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:
|
column
|
The column used when the filter by event feature is used.
TYPE:
|
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class ForceDistance
Bases: Float64, ComponentMixin
Component: The target distance between two nodes.
This is helpful to scale the layout, for example if long labels are involved.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
def __init__(value)
Create a new instance of the Float64 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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class ForceIterations
Bases: UInt64, ComponentMixin
Component: Specifies how often this force should be applied per iteration.
Increasing this parameter can lead to better results at the cost of longer computation time.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class ForceStrength
Bases: Float64, ComponentMixin
Component: The strength of a given force.
Allows to assign different weights to the individual forces, prioritizing one over the other.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
def __init__(value)
Create a new instance of the Float64 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_type()
Returns 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.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class GridSpacing
Bases: Float32, ComponentMixin
Component: Space between grid lines of one line to the next in scene units.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class IncludedContent
Bases: EntityPath, ComponentMixin
Component: All the contents in the container.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class LinkAxis
Bases: Enum
Component: How should the horizontal/X/time axis be linked across multiple plots.
Independent = 1
class-attribute
instance-attribute
The axis is independent from all other plots.
LinkToGlobal = 2
class-attribute
instance-attribute
Link to all other plots that also have this options set.
def __str__()
Returns the variant name.
def auto(val)
classmethod
Best-effort converter, including a case-insensitive string matcher.
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.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class MapProvider
Bases: Enum
Component: Name of the map provider to be used in Map views.
MapboxDark = 3
class-attribute
instance-attribute
Mapbox Dark is a dark-themed map designed by Mapbox.
MapboxSatellite = 4
class-attribute
instance-attribute
Mapbox Satellite is a satellite map designed by Mapbox.
MapboxStreets = 2
class-attribute
instance-attribute
Mapbox Streets is a minimalistic map designed by Mapbox.
OpenStreetMap = 1
class-attribute
instance-attribute
OpenStreetMap is the default map provider.
def __str__()
Returns the variant name.
def auto(val)
classmethod
Best-effort converter, including a case-insensitive string matcher.
class NearClipPlane
Bases: Float32, ComponentMixin
Component: Distance to the near clip plane used for Spatial2DView.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns 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 archetypes.ViewContents.
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.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns 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.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
def __init__(bytes)
Create a new instance of the Uuid datatype.
| PARAMETER | DESCRIPTION |
|---|---|
bytes
|
The raw bytes representing the UUID.
TYPE:
|
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_type()
Returns 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.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns 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.
⚠️ 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
TYPE:
|
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_type()
Returns 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.
⚠️ 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:
|
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class TimelineName
Bases: Utf8, ComponentMixin
Component: A timeline identified by its name.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class ViewClass
Bases: Utf8, ComponentMixin
Component: The class identifier of view, e.g. "2D", "TextLog", ….
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns 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 ViewMaximized
Bases: Uuid, ComponentMixin
Component: Whether a view is maximized.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
def __init__(bytes)
Create a new instance of the Uuid datatype.
| PARAMETER | DESCRIPTION |
|---|---|
bytes
|
The raw bytes representing the UUID.
TYPE:
|
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class ViewOrigin
Bases: EntityPath, ComponentMixin
Component: The origin of a view.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
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.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns 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.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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:
|
range
|
Time range to use for this timeline.
TYPE:
|
start
|
Low time boundary for sequence timeline. Specify this instead of
TYPE:
|
end
|
High time boundary for sequence timeline. Specify this instead of
TYPE:
|
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_type()
Returns 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.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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:
|
y_range
|
The minimum visible range of the Y-axis (usually left and right bounds).
TYPE:
|
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class VisualizerOverride
Bases: Utf8, ComponentMixin
Component: Single visualizer override the visualizers for an entity.
For details see archetypes.VisualizerOverrides.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.
class ZoomLevel
Bases: Float64, ComponentMixin
Component: A zoom level determines how much of the world is visible on a map.
⚠️ This type is unstable and may change significantly in a way that the data won't be backwards compatible.
def __init__(value)
Create a new instance of the Float64 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_type()
Returns the name of the component.
Part of the ComponentBatchLike logging interface.