rerun::blueprint::archetypes::DataframeQuery Struct Reference

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

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

Public Types
using	IndicatorComponent = rerun::components::IndicatorComponent< IndicatorComponentName >
	Indicator component, used to identify the archetype when converting to a list of components.

Public Member Functions
	DataframeQuery (DataframeQuery &&other)=default
DataframeQuery	with_timeline (rerun::blueprint::components::TimelineName _timeline) &&
	The timeline for this query.
DataframeQuery	with_kind (rerun::blueprint::components::QueryKind _kind) &&
	Kind of query: latest-at or range.
DataframeQuery	with_latest_at_queries (rerun::blueprint::components::LatestAtQueries _latest_at_queries) &&
	Configuration for latest-at queries.
DataframeQuery	with_time_range_queries (rerun::blueprint::components::TimeRangeQueries _time_range_queries) &&
	Configuration for the time range queries.

Public Attributes
std::optional< rerun::blueprint::components::TimelineName >	timeline
	The timeline for this query.
std::optional< rerun::blueprint::components::QueryKind >	kind
	Kind of query: latest-at or range.
std::optional< rerun::blueprint::components::LatestAtQueries >	latest_at_queries
	Configuration for latest-at queries.
std::optional< rerun::blueprint::components::TimeRangeQueries >	time_range_queries
	Configuration for the time range queries.

Static Public Attributes
static constexpr const char	IndicatorComponentName []

Detailed Description

Archetype: The query for the dataframe view.

Member Function Documentation

with_timeline()

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

inline

The timeline for this query.

If unset, use the time panel's timeline and a latest-at query, ignoring all other components of this archetype.

with_latest_at_queries()

DataframeQuery rerun::blueprint::archetypes::DataframeQuery::with_latest_at_queries ( rerun::blueprint::components::LatestAtQueries  _latest_at_queries ) &&

inline

Configuration for latest-at queries.

Note: configuration as saved on a per-timeline basis.

with_time_range_queries()

DataframeQuery rerun::blueprint::archetypes::DataframeQuery::with_time_range_queries ( rerun::blueprint::components::TimeRangeQueries  _time_range_queries ) &&

inline

Configuration for the time range queries.

Note: configuration as saved on a per-timeline basis.

Member Data Documentation

timeline

std::optional<rerun::blueprint::components::TimelineName> rerun::blueprint::archetypes::DataframeQuery::timeline

The timeline for this query.

If unset, use the time panel's timeline and a latest-at query, ignoring all other components of this archetype.

latest_at_queries

std::optional<rerun::blueprint::components::LatestAtQueries> rerun::blueprint::archetypes::DataframeQuery::latest_at_queries

Configuration for latest-at queries.

Note: configuration as saved on a per-timeline basis.

time_range_queries

std::optional<rerun::blueprint::components::TimeRangeQueries> rerun::blueprint::archetypes::DataframeQuery::time_range_queries

Configuration for the time range queries.

Note: configuration as saved on a per-timeline basis.

IndicatorComponentName

constexpr const char rerun::blueprint::archetypes::DataframeQuery::IndicatorComponentName[]

staticconstexpr

Initial value:

=
            "rerun.blueprint.components.DataframeQueryIndicator"

---

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

• rerun/blueprint/archetypes/dataframe_query.hpp