Struct plotters_unstable::coord::combinators::WithKeyPoints

pub struct WithKeyPoints<Inner: Ranged> { /* fields omitted */ }

The coordinate decorator that binds a key point vector. Normally, all the ranged coordinate implements its own keypoint algorithm to determine how to render the tick mark and mesh grid. This decorator allows customized tick mark specifiied by vector. See BindKeyPoints::with_key_points for details. Note: For any coordinate spec wrapped by this decorator, the maxium number of labels configured by MeshStyle will be ignored and the key point function will always returns the entire vector

Implementations

impl<I: Ranged> WithKeyPoints<I>

pub fn with_light_points<T: IntoIterator<Item = I::ValueType>>(
    self,
    iter: T
) -> Self

Specify the light key points, which is used to render the light mesh line

pub fn bold_points(&self) -> &[I::ValueType]

Get a reference to the bold points

pub fn bold_points_mut(&mut self) -> &mut [I::ValueType]

Get a mut reference to the bold points

pub fn light_points(&self) -> &[I::ValueType]

Get a reference to light key points

pub fn light_points_mut(&mut self) -> &mut [I::ValueType]

Get a mut reference to the light key points

Trait Implementations

impl<R: DiscreteRanged> DiscreteRanged for WithKeyPoints<R> where
    R::ValueType: Clone, 

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: &Self::ValueType) -> Option<usize>

Map a value to the index

fn from_index(&self, index: usize) -> Option<Self::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<R: Ranged> Ranged for WithKeyPoints<R> where
    R::ValueType: Clone, 

type ValueType = R::ValueType

The type of this value in this range specification

type FormatOption = R::FormatOption

This marker decides if Plotters default ValueFormatter implementation should be used. This assicated type can be one of follow two types: - DefaultFormatting will allow Plotters automatically impl the formatter based on Debug trait, if Debug trait is not impl for the Self::Value, ValueFormatter will not impl unless you impl it manually.

fn range(&self) -> Range<Self::ValueType>

Get the range of this value

fn map(&self, value: &Self::ValueType, limit: (i32, i32)) -> i32

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

fn key_points<Hint: KeyPointHint>(&self, hint: Hint) -> Vec<Self::ValueType>

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

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

This function provides the on-axis part of its range