plotters::coord::combinators

Struct WithKeyPoints

Source
pub struct WithKeyPoints<Inner: Ranged> { /* private fields */ }
Expand description

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 maximum number of labels configured by MeshStyle will be ignored and the key point function will always returns the entire vector

Implementations§

Source§

impl<I: Ranged> WithKeyPoints<I>

Source

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

Source

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

Get a reference to the bold points

Source

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

Get a mut reference to the bold points

Source

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

Get a reference to light key points

Source

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

Get a mut reference to the light key points

Trait Implementations§

Source§

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

Source§

fn size(&self) -> usize

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

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

Map a value to the index Read more
Source§

fn from_index(&self, index: usize) -> Option<Self::ValueType>

Reverse map the index to the value Read more
Source§

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

Return a iterator that iterates over the all possible values Read more
Source§

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

Returns the previous value in this range Read more
Source§

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

Returns the next value in this range Read more
Source§

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

Source§

type ValueType = <R as Ranged>::ValueType

The type of this value in this range specification
Source§

type FormatOption = <R as Ranged>::FormatOption

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

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

Get the range of this value
Source§

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

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

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
Source§

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

This function provides the on-axis part of its range

Auto Trait Implementations§

§

impl<Inner> Freeze for WithKeyPoints<Inner>
where Inner: Freeze,

§

impl<Inner> RefUnwindSafe for WithKeyPoints<Inner>
where Inner: RefUnwindSafe, <Inner as Ranged>::ValueType: RefUnwindSafe,

§

impl<Inner> Send for WithKeyPoints<Inner>
where Inner: Send, <Inner as Ranged>::ValueType: Send,

§

impl<Inner> Sync for WithKeyPoints<Inner>
where Inner: Sync, <Inner as Ranged>::ValueType: Sync,

§

impl<Inner> Unpin for WithKeyPoints<Inner>
where Inner: Unpin, <Inner as Ranged>::ValueType: Unpin,

§

impl<Inner> UnwindSafe for WithKeyPoints<Inner>
where Inner: UnwindSafe, <Inner as Ranged>::ValueType: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsRangedCoord for T
where T: Ranged,

Source§

type CoordDescType = T

Type to describe a coordinate system
Source§

type Value = <T as Ranged>::ValueType

Type for values in the given coordinate system
Source§

impl<T> BindKeyPointMethod for T
where T: AsRangedCoord,

Source§

fn with_key_point_func<F: Fn(usize) -> Vec<Self::Value> + 'static>( self, func: F, ) -> WithKeyPointMethod<Self::CoordDescType>

Bind a existing coordinate spec with a given key points algorithm. See WithKeyPointMethod for more details. Example: Read more
Source§

impl<T> BindKeyPoints for T
where T: AsRangedCoord,

Source§

fn with_key_points( self, points: Vec<Self::Value>, ) -> WithKeyPoints<Self::CoordDescType>

Bind a existing coordinate spec with a given key points vector. See WithKeyPoints for more details. Example: Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoLinspace for T
where T: AsRangedCoord,

Source§

fn step<S: Clone>( self, val: S, ) -> Linspace<Self::CoordDescType, S, Exact<Self::Value>>
where Self::Value: Add<S, Output = Self::Value> + PartialOrd + Clone,

Set the step value, make a linspace coordinate from the given range. By default the matching method use the exact match Read more
Source§

impl<R> IntoPartialAxis for R
where R: AsRangedCoord,

Source§

fn partial_axis( self, axis_range: Range<<Self::CoordDescType as Ranged>::ValueType>, ) -> PartialAxis<Self::CoordDescType>

Make the partial axis Read more
Source§

impl<DC> ReversibleRanged for DC
where DC: DiscreteRanged,

Source§

fn unmap( &self, input: i32, limit: (i32, i32), ) -> Option<<DC as Ranged>::ValueType>

Perform the reverse mapping
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.