rerun::archetypes::SeriesLine Struct Reference

Archetype: Define the style properties for a line series in a chart. More...

#include <rerun/archetypes/series_line.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
	SeriesLine (SeriesLine &&other)=default
SeriesLine	with_color (rerun::components::Color _color) &&
	Color for the corresponding series.
SeriesLine	with_width (rerun::components::StrokeWidth _width) &&
	Stroke width for the corresponding series.
SeriesLine	with_name (rerun::components::Name _name) &&
	Display name of the series.
SeriesLine	with_aggregation_policy (rerun::components::AggregationPolicy _aggregation_policy) &&
	Configures the zoom-dependent scalar aggregation.

Public Attributes
std::optional< rerun::components::Color >	color
	Color for the corresponding series.
std::optional< rerun::components::StrokeWidth >	width
	Stroke width for the corresponding series.
std::optional< rerun::components::Name >	name
	Display name of the series.
std::optional< rerun::components::AggregationPolicy >	aggregation_policy
	Configures the zoom-dependent scalar aggregation.

Static Public Attributes
static constexpr const char	IndicatorComponentName []

Detailed Description

Archetype: Define the style properties for a line series in a chart.

This archetype only provides styling information and should be logged as static when possible. The underlying data needs to be logged to the same entity-path using archetypes::Scalar.

Example

Line series

#include <rerun.hpp>
 
#include <cmath>
 
constexpr float TAU = 6.28318530717958647692528676655900577f;
 
int main() {
    const auto rec = rerun::RecordingStream("rerun_example_series_line_style");
    rec.spawn().exit_on_failure();
 
    // Set up plot styling:
    // They are logged static as they don't change over time and apply to all timelines.
    // Log two lines series under a shared root so that they show in the same plot by default.
    rec.log_static(
        "trig/sin",
        rerun::SeriesLine().with_color({255, 0, 0}).with_name("sin(0.01t)").with_width(2)
    );
    rec.log_static(
        "trig/cos",
        rerun::SeriesLine().with_color({0, 255, 0}).with_name("cos(0.01t)").with_width(4)
    );
 
    // Log the data on a timeline called "step".
    for (int t = 0; t <static_cast<int>(TAU * 2.0 * 100.0); ++t) {
        rec.set_time_sequence("step", t);
 
        rec.log("trig/sin", rerun::Scalar(sin(static_cast<double>(t) / 100.0)));
        rec.log("trig/cos", rerun::Scalar(cos(static_cast<double>(t) / 100.0f)));
    }
}

Member Function Documentation

with_name()

SeriesLine rerun::archetypes::SeriesLine::with_name ( rerun::components::Name  _name ) &&

inline

Display name of the series.

Used in the legend.

with_aggregation_policy()

SeriesLine rerun::archetypes::SeriesLine::with_aggregation_policy ( rerun::components::AggregationPolicy  _aggregation_policy ) &&

inline

Configures the zoom-dependent scalar aggregation.

This is done only if steps on the X axis go below a single pixel, i.e. a single pixel covers more than one tick worth of data. It can greatly improve performance (and readability) in such situations as it prevents overdraw.

Member Data Documentation

name

std::optional<rerun::components::Name> rerun::archetypes::SeriesLine::name

Display name of the series.

Used in the legend.

aggregation_policy

std::optional<rerun::components::AggregationPolicy> rerun::archetypes::SeriesLine::aggregation_policy

Configures the zoom-dependent scalar aggregation.

This is done only if steps on the X axis go below a single pixel, i.e. a single pixel covers more than one tick worth of data. It can greatly improve performance (and readability) in such situations as it prevents overdraw.

IndicatorComponentName

constexpr const char rerun::archetypes::SeriesLine::IndicatorComponentName[]

staticconstexpr

Initial value:

=
            "rerun.components.SeriesLineIndicator"

---

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

• rerun/archetypes/series_line.hpp