Struct re_types::blueprint::archetypes::PlotLegend

pub struct PlotLegend {
    pub corner: Option<Corner2D>,
    pub visible: Option<Visible>,
}

Archetype: Configuration for the legend of a plot.

Fields

corner: Option<Corner2D>

To what corner the legend is aligned.

Defaults to the right bottom corner.

visible: Option<Visible>

Whether the legend is shown at all.

True by default.

Implementations

impl PlotLegend

pub const NUM_COMPONENTS: usize = 3usize

The total number of components in the archetype: 0 required, 1 recommended, 2 optional

impl PlotLegend

pub fn new() -> Self

Create a new PlotLegend.

pub fn with_corner(self, corner: impl Into<Corner2D>) -> Self

To what corner the legend is aligned.

Defaults to the right bottom corner.

pub fn with_visible(self, visible: impl Into<Visible>) -> Self

Whether the legend is shown at all.

True by default.

Trait Implementations

impl Archetype for PlotLegend

type Indicator = GenericIndicatorComponent<PlotLegend>

The associated indicator component, whose presence indicates that the high-level archetype-based APIs were used to log the data.

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

fn display_name() -> &'static str

Readable name for displaying in ui.

fn indicator() -> MaybeOwnedComponentBatch<'static>

Creates a ComponentBatch out of the associated Self::Indicator component.

fn required_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that must be provided by the user when constructing this archetype.

fn recommended_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that should be provided by the user when constructing this archetype.

fn optional_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that may be provided by the user when constructing this archetype.

fn all_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)> ) -> DeserializationResult<Self>

Given an iterator of Arrow arrays and their respective ComponentNames, deserializes them into this archetype.

fn from_arrow( data: impl IntoIterator<Item = (Field, Box<dyn Array>)> ) -> Result<Self, DeserializationError>

where Self: Sized,

Given an iterator of Arrow arrays and their respective field metadata, deserializes them into this archetype.

impl AsComponents for PlotLegend

fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>

Exposes the object’s contents as a set of ComponentBatchs.

fn to_arrow(&self) -> Result<Vec<(Field, Box<dyn Array>)>, SerializationError>

Serializes all non-null Components of this bundle into Arrow arrays.

impl Borrow<PlotLegend> for BarChartView

fn borrow(&self) -> &PlotLegend

Immutably borrows from an owned value.

impl Clone for PlotLegend

fn clone(&self) -> PlotLegend

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PlotLegend

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PlotLegend

fn default() -> PlotLegend

Returns the “default value” for a type.

impl SizeBytes for PlotLegend

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

impl ArchetypeReflectionMarker for PlotLegend