Struct SegmentedCoord

pub struct SegmentedCoord<D>(/* private fields */)
where
    D: DiscreteRanged;

A SegmentedCoord is a decorator on any discrete coordinate specification. This decorator will convert the discrete coordinate in two ways:

• Add an extra dummy element after all the values in original discrete coordinate
• Logically each value v from original coordinate system is mapped into an segment [v, v+1) where v+1 denotes the successor of the v
• Introduce two types of values SegmentValue::Exact(value) which denotes the left end of value’s segment and SegmentValue::CenterOf(value) which refers the center of the segment. This is used in histogram types, which uses a discrete coordinate as the buckets. The segmented coord always emits CenterOf(value) key points, thus it allows all the label and tick marks of the coordinate rendered in the middle of each segment. The corresponding trait IntoSegmentedCoord is used to apply this decorator to coordinates.

Trait Implementations

impl<D> Clone for SegmentedCoord<D>

where D: Clone + DiscreteRanged,

fn clone(&self) -> SegmentedCoord<D>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D> DiscreteRanged for SegmentedCoord<D>

where D: DiscreteRanged,

fn size(&self) -> usize

Get the number of element in the range Note: we assume that all the ranged discrete coordinate has finite value

fn index_of( &self, value: &<SegmentedCoord<D> as Ranged>::ValueType, ) -> Option<usize>

Map a value to the index

fn from_index( &self, idx: usize, ) -> Option<<SegmentedCoord<D> as Ranged>::ValueType>

Reverse map the index to the value

fn values(&self) -> DiscreteValueIter<'_, Self>

where Self: Sized,

Return a iterator that iterates over the all possible values

fn previous(&self, value: &Self::ValueType) -> Option<Self::ValueType>

Returns the previous value in this range

fn next(&self, value: &Self::ValueType) -> Option<Self::ValueType>

Returns the next value in this range

impl<D> Ranged for SegmentedCoord<D>

where D: DiscreteRanged,

type FormatOption = NoDefaultFormatting

This marker decides if Plotters default ValueFormatter implementation should be used. This associated type can be one of the following two types:

type ValueType = SegmentValue<<D as Ranged>::ValueType>

The type of this value in this range specification

fn map( &self, value: &<SegmentedCoord<D> as Ranged>::ValueType, limit: (i32, i32), ) -> i32

This function maps the value to i32, which is the drawing coordinate

fn key_points<HintType>( &self, hint: HintType, ) -> Vec<<SegmentedCoord<D> as Ranged>::ValueType>

where HintType: KeyPointHint,

This function gives the key points that we can draw a grid based on this

fn range(&self) -> Range<<SegmentedCoord<D> as Ranged>::ValueType>

Get the range of this value

fn axis_pixel_range(&self, limit: (i32, i32)) -> Range<i32>

This function provides the on-axis part of its range

impl<T, D> ValueFormatter<SegmentValue<T>> for SegmentedCoord<D>

where D: DiscreteRanged<ValueType = T> + Ranged + ValueFormatter<T>,

fn format(value: &SegmentValue<T>) -> String

Format the value

fn format_ext(&self, value: &V) -> String

Determine how we can format a value in a coordinate system by default