Struct SeriesLines

pub struct SeriesLines {
    pub colors: Option<SerializedComponentBatch>,
    pub widths: Option<SerializedComponentBatch>,
    pub names: Option<SerializedComponentBatch>,
    pub visible_series: Option<SerializedComponentBatch>,
    pub aggregation_policy: Option<SerializedComponentBatch>,
}

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

This archetype only provides styling information. Changes over time are supported for most but not all its fields (see respective fields for details), it’s generally recommended to log this type as static.

The underlying data needs to be logged to the same entity-path using archetypes::Scalars. Dimensionality of the scalar arrays logged at each time point is assumed to be the same over time.

Example

Line series

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

    // 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::SeriesLines::new()
            .with_colors([[255, 0, 0]])
            .with_names(["sin(0.01t)"])
            .with_widths([2.0]),
    )?;
    rec.log_static(
        "trig/cos",
        &rerun::SeriesLines::new()
            .with_colors([[0, 255, 0]])
            .with_names(["cos(0.01t)"])
            .with_widths([4.0]),
    )?;

    for t in 0..((std::f32::consts::TAU * 2.0 * 100.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::Scalars::single((t as f64 / 100.0).sin()),
        )?;
        rec.log(
            "trig/cos",
            &rerun::Scalars::single((t as f64 / 100.0).cos()),
        )?;
    }

    Ok(())
}

Fields

colors: Option<SerializedComponentBatch>

Color for the corresponding series.

May change over time, but can cause discontinuities in the line.

widths: Option<SerializedComponentBatch>

Stroke width for the corresponding series.

May change over time, but can cause discontinuities in the line.

names: Option<SerializedComponentBatch>

Display name of the series.

Used in the legend. Expected to be unchanging over time.

visible_series: Option<SerializedComponentBatch>

Which lines are visible.

If not set, all line series on this entity are visible. Unlike with the regular visibility property of the entire entity, any series that is hidden via this property will still be visible in the legend.

May change over time, but can cause discontinuities in the line.

aggregation_policy: Option<SerializedComponentBatch>

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.

Expected to be unchanging over time.

Implementations

impl SeriesLines

pub fn descriptor_colors() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::colors.

pub fn descriptor_widths() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::widths.

pub fn descriptor_names() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::names.

pub fn descriptor_visible_series() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::visible_series.

pub fn descriptor_aggregation_policy() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::aggregation_policy.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl SeriesLines

pub const NUM_COMPONENTS: usize = 6usize

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

impl SeriesLines

pub fn new() -> Self

Create a new SeriesLines.

pub fn update_fields() -> Self

Update only some specific fields of a SeriesLines.

pub fn clear_fields() -> Self

Clear all the fields of a SeriesLines.

pub fn columns<I>( self, _lengths: I, ) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>

where I: IntoIterator<Item = usize> + Clone,

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing SerializedComponentBatches data into SerializedComponentColumns instead, via SerializedComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

pub fn columns_of_unit_batches( self, ) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>

Helper to partition the component data into unit-length sub-batches.

This is semantically similar to calling Self::columns with std::iter::take(1).repeat(n), where n is automatically guessed.

pub fn with_colors( self, colors: impl IntoIterator<Item = impl Into<Color>>, ) -> Self

Color for the corresponding series.

May change over time, but can cause discontinuities in the line.

pub fn with_widths( self, widths: impl IntoIterator<Item = impl Into<StrokeWidth>>, ) -> Self

Stroke width for the corresponding series.

May change over time, but can cause discontinuities in the line.

pub fn with_names( self, names: impl IntoIterator<Item = impl Into<Name>>, ) -> Self

Display name of the series.

Used in the legend. Expected to be unchanging over time.

pub fn with_visible_series( self, visible_series: impl IntoIterator<Item = impl Into<SeriesVisible>>, ) -> Self

Which lines are visible.

If not set, all line series on this entity are visible. Unlike with the regular visibility property of the entire entity, any series that is hidden via this property will still be visible in the legend.

May change over time, but can cause discontinuities in the line.

pub fn with_aggregation_policy( self, aggregation_policy: impl Into<AggregationPolicy>, ) -> Self

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.

Expected to be unchanging over time.

pub fn with_many_aggregation_policy( self, aggregation_policy: impl IntoIterator<Item = impl Into<AggregationPolicy>>, ) -> Self

This method makes it possible to pack multiple crate::components::AggregationPolicy in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_aggregation_policy should be used when logging a single row’s worth of data.

Trait Implementations

impl Archetype for SeriesLines

type Indicator = GenericIndicatorComponent<SeriesLines>

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() -> SerializedComponentBatch

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

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

Returns all component descriptors that must be provided by the user when constructing this archetype.

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

Returns all component descriptors that should be provided by the user when constructing this archetype.

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

Returns all component descriptors that may be provided by the user when constructing this archetype.

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

Returns all component descriptors that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentDescriptor, ArrayRef)>, ) -> 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, Arc<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 SeriesLines

fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>

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

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

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

impl Clone for SeriesLines

fn clone(&self) -> SeriesLines

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SeriesLines

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

Formats the value using the given formatter.

impl Default for SeriesLines

fn default() -> SeriesLines

Returns the “default value” for a type.

impl SizeBytes for SeriesLines

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

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.

fn is_pod() -> bool

Is Self just plain old data?

impl ArchetypeReflectionMarker for SeriesLines