Archetype: The query for the dataframe view. More...

#include <rerun/blueprint/archetypes/dataframe_query.hpp>

Public Member Functions
	DataframeQuery (DataframeQuery &&other)=default

	DataframeQuery (const DataframeQuery &other)=default

DataframeQuery &	operator= (const DataframeQuery &other)=default

DataframeQuery &	operator= (DataframeQuery &&other)=default

DataframeQuery	with_timeline (const rerun::blueprint::components::TimelineName &_timeline) &&
	The timeline for this query.

DataframeQuery	with_filter_by_range (const rerun::blueprint::components::FilterByRange &_filter_by_range) &&
	If provided, only rows whose timestamp is within this range will be shown.

DataframeQuery	with_filter_is_not_null (const rerun::blueprint::components::FilterIsNotNull &_filter_is_not_null) &&
	If provided, only show rows which contains a logged event for the specified component.

DataframeQuery	with_apply_latest_at (const rerun::blueprint::components::ApplyLatestAt &_apply_latest_at) &&
	Should empty cells be filled with latest-at queries?

DataframeQuery	with_select (const rerun::blueprint::components::SelectedColumns &_select) &&
	Selected columns. If unset, only the active timeline and all component columns are selected.

DataframeQuery	with_entity_order (const rerun::blueprint::components::ColumnOrder &_entity_order) &&
	The order of entity path column groups.

DataframeQuery	with_auto_scroll (const rerun::blueprint::components::AutoScroll &_auto_scroll) &&
	Whether to auto-scroll to track the time cursor.

Collection< ComponentColumn >	columns (const Collection< uint32_t > &lengths_)
	Partitions the component data into multiple sub-batches.

Collection< ComponentColumn >	columns ()
	Partitions the component data into unit-length sub-batches.

Static Public Member Functions
static DataframeQuery	update_fields ()
	Update only some specific fields of a `DataframeQuery`.

static DataframeQuery	clear_fields ()
	Clear all the fields of a `DataframeQuery`.

Public Attributes
std::optional< ComponentBatch >	timeline
	The timeline for this query.

std::optional< ComponentBatch >	filter_by_range
	If provided, only rows whose timestamp is within this range will be shown.

std::optional< ComponentBatch >	filter_is_not_null
	If provided, only show rows which contains a logged event for the specified component.

std::optional< ComponentBatch >	apply_latest_at
	Should empty cells be filled with latest-at queries?

std::optional< ComponentBatch >	select
	Selected columns. If unset, only the active timeline and all component columns are selected.

std::optional< ComponentBatch >	entity_order
	The order of entity path column groups.

std::optional< ComponentBatch >	auto_scroll
	Whether to auto-scroll to track the time cursor.

Static Public Attributes
static constexpr const char	ArchetypeName [] = "rerun.blueprint.archetypes.DataframeQuery"
	The name of the archetype as used in `ComponentDescriptor`s.

static constexpr auto	Descriptor_timeline
	`ComponentDescriptor` for the `timeline` field.

static constexpr auto	Descriptor_filter_by_range
	`ComponentDescriptor` for the `filter_by_range` field.

static constexpr auto	Descriptor_filter_is_not_null
	`ComponentDescriptor` for the `filter_is_not_null` field.

static constexpr auto	Descriptor_apply_latest_at
	`ComponentDescriptor` for the `apply_latest_at` field.

static constexpr auto	Descriptor_select
	`ComponentDescriptor` for the `select` field.

static constexpr auto	Descriptor_entity_order
	`ComponentDescriptor` for the `entity_order` field.

static constexpr auto	Descriptor_auto_scroll
	`ComponentDescriptor` for the `auto_scroll` field.

Detailed Description

Archetype: The query for the dataframe view.

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

Member Function Documentation

◆ with_timeline()

DataframeQuery rerun::blueprint::archetypes::DataframeQuery::with_timeline ( const rerun::blueprint::components::TimelineName & _timeline ) &&

inline

The timeline for this query.

If unset, the timeline currently active on the time panel is used.

◆ with_filter_by_range()

DataframeQuery rerun::blueprint::archetypes::DataframeQuery::with_filter_by_range ( const rerun::blueprint::components::FilterByRange & _filter_by_range ) &&

inline

If provided, only rows whose timestamp is within this range will be shown.

Note: will be unset as soon as timeline is changed.

◆ with_entity_order()

DataframeQuery rerun::blueprint::archetypes::DataframeQuery::with_entity_order ( const rerun::blueprint::components::ColumnOrder & _entity_order ) &&

inline

The order of entity path column groups.

If unset, the default order is used.

This affects the order of component columns, which are always grouped by entity path. Timeline columns always come first. Entities not listed here are appended at the end in default order.

If entity_order contains any entity path that is not included in the view, they are ignored.

◆ with_auto_scroll()

DataframeQuery rerun::blueprint::archetypes::DataframeQuery::with_auto_scroll ( const rerun::blueprint::components::AutoScroll & _auto_scroll ) &&

inline

Whether to auto-scroll to track the time cursor.

When enabled and the view's timeline matches the time panel's active timeline, the view will scroll to keep the row at or before the current time cursor visible.

◆ columns() [1/2]

Collection< ComponentColumn > rerun::blueprint::archetypes::DataframeQuery::columns ( const Collection< uint32_t > & lengths_ )

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing ComponentBatch data into ComponentColumns instead, via ComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

◆ columns() [2/2]

Collection< ComponentColumn > rerun::blueprint::archetypes::DataframeQuery::columns ( )

Partitions the component data into unit-length sub-batches.

This is semantically similar to calling columns with std::vector<uint32_t>(n, 1), where n is automatically guessed.

Member Data Documentation

◆ timeline

std::optional<ComponentBatch> rerun::blueprint::archetypes::DataframeQuery::timeline

The timeline for this query.

If unset, the timeline currently active on the time panel is used.

◆ filter_by_range

std::optional<ComponentBatch> rerun::blueprint::archetypes::DataframeQuery::filter_by_range

If provided, only rows whose timestamp is within this range will be shown.

Note: will be unset as soon as timeline is changed.

◆ entity_order

std::optional<ComponentBatch> rerun::blueprint::archetypes::DataframeQuery::entity_order

The order of entity path column groups.

If unset, the default order is used.

This affects the order of component columns, which are always grouped by entity path. Timeline columns always come first. Entities not listed here are appended at the end in default order.

If entity_order contains any entity path that is not included in the view, they are ignored.

◆ auto_scroll

std::optional<ComponentBatch> rerun::blueprint::archetypes::DataframeQuery::auto_scroll

Whether to auto-scroll to track the time cursor.

When enabled and the view's timeline matches the time panel's active timeline, the view will scroll to keep the row at or before the current time cursor visible.

◆ Descriptor_timeline

constexpr auto rerun::blueprint::archetypes::DataframeQuery::Descriptor_timeline

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "DataframeQuery:timeline",
            Loggable<rerun::blueprint::components::TimelineName>::ComponentType
        )

ComponentDescriptor for the timeline field.

◆ Descriptor_filter_by_range

constexpr auto rerun::blueprint::archetypes::DataframeQuery::Descriptor_filter_by_range

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "DataframeQuery:filter_by_range",
            Loggable<rerun::blueprint::components::FilterByRange>::ComponentType
        )

ComponentDescriptor for the filter_by_range field.

◆ Descriptor_filter_is_not_null

constexpr auto rerun::blueprint::archetypes::DataframeQuery::Descriptor_filter_is_not_null

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "DataframeQuery:filter_is_not_null",
            Loggable<rerun::blueprint::components::FilterIsNotNull>::ComponentType
        )

ComponentDescriptor for the filter_is_not_null field.

◆ Descriptor_apply_latest_at

constexpr auto rerun::blueprint::archetypes::DataframeQuery::Descriptor_apply_latest_at

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "DataframeQuery:apply_latest_at",
            Loggable<rerun::blueprint::components::ApplyLatestAt>::ComponentType
        )

ComponentDescriptor for the apply_latest_at field.

◆ Descriptor_select

constexpr auto rerun::blueprint::archetypes::DataframeQuery::Descriptor_select

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "DataframeQuery:select",
            Loggable<rerun::blueprint::components::SelectedColumns>::ComponentType
        )

ComponentDescriptor for the select field.

◆ Descriptor_entity_order

constexpr auto rerun::blueprint::archetypes::DataframeQuery::Descriptor_entity_order

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "DataframeQuery:entity_order",
            Loggable<rerun::blueprint::components::ColumnOrder>::ComponentType
        )

ComponentDescriptor for the entity_order field.

◆ Descriptor_auto_scroll

constexpr auto rerun::blueprint::archetypes::DataframeQuery::Descriptor_auto_scroll

staticconstexpr

Initial value:

= ComponentDescriptor(
            ArchetypeName, "DataframeQuery:auto_scroll",
            Loggable<rerun::blueprint::components::AutoScroll>::ComponentType
        )

ComponentDescriptor for the auto_scroll field.

The documentation for this struct was generated from the following file:

rerun/blueprint/archetypes/dataframe_query.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ with_timeline()

◆ with_filter_by_range()

◆ with_entity_order()

◆ with_auto_scroll()

◆ columns() [1/2]

◆ columns() [2/2]

Member Data Documentation

◆ timeline

◆ filter_by_range

◆ entity_order

◆ auto_scroll

◆ Descriptor_timeline

◆ Descriptor_filter_by_range

◆ Descriptor_filter_is_not_null

◆ Descriptor_apply_latest_at

◆ Descriptor_select

◆ Descriptor_entity_order

◆ Descriptor_auto_scroll