Struct re_types::archetypes::SeriesPoint

pub struct SeriesPoint {
    pub color: Option<Color>,
    pub marker: Option<MarkerShape>,
    pub name: Option<Name>,
    pub marker_size: Option<MarkerSize>,
}

Archetype: Define the style properties for a point 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

Point series

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rec = rerun::RecordingStreamBuilder::new("rerun_example_series_point_style").spawn()?;

    // Set up plot styling:
    // They are logged static as they don't change over time and apply to all timelines.
    // Log two point series under a shared root so that they show in the same plot by default.
    rec.log_static(
        "trig/sin",
        &rerun::SeriesPoint::new()
            .with_color([255, 0, 0])
            .with_name("sin(0.01t)")
            .with_marker(rerun::components::MarkerShape::Circle)
            .with_marker_size(4.0),
    )?;
    rec.log_static(
        "trig/cos",
        &rerun::SeriesPoint::new()
            .with_color([0, 255, 0])
            .with_name("cos(0.01t)")
            .with_marker(rerun::components::MarkerShape::Cross)
            .with_marker_size(2.0),
    )?;

    for t in 0..((std::f32::consts::TAU * 2.0 * 10.0) as i64) {
        rec.set_time_sequence("step", t);

        // Log two time series under a shared root so that they show in the same plot by default.
        rec.log("trig/sin", &rerun::Scalar::new((t as f64 / 10.0).sin()))?;
        rec.log("trig/cos", &rerun::Scalar::new((t as f64 / 10.0).cos()))?;
    }

    Ok(())
}

Fields

color: Option<Color>

Color for the corresponding series.

marker: Option<MarkerShape>

What shape to use to represent the point

name: Option<Name>

Display name of the series.

Used in the legend.

marker_size: Option<MarkerSize>

Size of the marker.

Implementations

impl SeriesPoint

pub const NUM_COMPONENTS: usize = 5usize

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

impl SeriesPoint

pub fn new() -> Self

Create a new SeriesPoint.

pub fn with_color(self, color: impl Into<Color>) -> Self

Color for the corresponding series.

pub fn with_marker(self, marker: impl Into<MarkerShape>) -> Self

What shape to use to represent the point

pub fn with_name(self, name: impl Into<Name>) -> Self

Display name of the series.

Used in the legend.

pub fn with_marker_size(self, marker_size: impl Into<MarkerSize>) -> Self

Size of the marker.

Trait Implementations

impl Archetype for SeriesPoint

type Indicator = GenericIndicatorComponent<SeriesPoint>

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 SeriesPoint

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 Clone for SeriesPoint

fn clone(&self) -> SeriesPoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SeriesPoint

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

Formats the value using the given formatter.

impl SizeBytes for SeriesPoint

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 SeriesPoint