rerun::blueprint::archetypes::PlotLegend Struct Reference

Archetype: Configuration for the legend of a plot. More...

#include <rerun/blueprint/archetypes/plot_legend.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
	PlotLegend (PlotLegend &&other)=default
PlotLegend	with_corner (rerun::blueprint::components::Corner2D _corner) &&
	To what corner the legend is aligned.
PlotLegend	with_visible (rerun::blueprint::components::Visible _visible) &&
	Whether the legend is shown at all.

Public Attributes
std::optional< rerun::blueprint::components::Corner2D >	corner
	To what corner the legend is aligned.
std::optional< rerun::blueprint::components::Visible >	visible
	Whether the legend is shown at all.

Static Public Attributes
static constexpr const char	IndicatorComponentName []

Detailed Description

Archetype: Configuration for the legend of a plot.

Member Function Documentation

with_corner()

PlotLegend rerun::blueprint::archetypes::PlotLegend::with_corner ( rerun::blueprint::components::Corner2D  _corner ) &&

inline

To what corner the legend is aligned.

Defaults to the right bottom corner.

with_visible()

PlotLegend rerun::blueprint::archetypes::PlotLegend::with_visible ( rerun::blueprint::components::Visible  _visible ) &&

inline

Whether the legend is shown at all.

True by default.

Member Data Documentation

corner

std::optional<rerun::blueprint::components::Corner2D> rerun::blueprint::archetypes::PlotLegend::corner

To what corner the legend is aligned.

Defaults to the right bottom corner.

visible

std::optional<rerun::blueprint::components::Visible> rerun::blueprint::archetypes::PlotLegend::visible

Whether the legend is shown at all.

True by default.

IndicatorComponentName

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

staticconstexpr

Initial value:

=
            "rerun.blueprint.components.PlotLegendIndicator"

---

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

• rerun/blueprint/archetypes/plot_legend.hpp