Struct re_types::blueprint::archetypes::ScalarAxis

pub struct ScalarAxis {
    pub range: Option<Range1D>,
    pub lock_range_during_zoom: Option<LockRangeDuringZoom>,
}

Archetype: Configuration for the scalar axis of a plot.

Fields

range: Option<Range1D>

The range of the axis.

If unset, the range well be automatically determined based on the queried data.

lock_range_during_zoom: Option<LockRangeDuringZoom>

Whether to lock the range of the axis during zoom.

Implementations

impl ScalarAxis

pub const NUM_COMPONENTS: usize = 3usize

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

impl ScalarAxis

pub fn new() -> Self

Create a new ScalarAxis.

pub fn with_range(self, range: impl Into<Range1D>) -> Self

The range of the axis.

If unset, the range well be automatically determined based on the queried data.

pub fn with_lock_range_during_zoom( self, lock_range_during_zoom: impl Into<LockRangeDuringZoom> ) -> Self

Whether to lock the range of the axis during zoom.

Trait Implementations

impl Archetype for ScalarAxis

type Indicator = GenericIndicatorComponent<ScalarAxis>

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 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 ScalarAxis

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 ScalarAxis

fn clone(&self) -> ScalarAxis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScalarAxis

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

Formats the value using the given formatter.

impl Default for ScalarAxis

fn default() -> ScalarAxis

Returns the “default value” for a type.

impl SizeBytes for ScalarAxis

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.