Skip to main content

PriceMap

Struct PriceMap 

Source
pub struct PriceMap { /* private fields */ }
Expand description

Per-frame price-to-pixel mapping.

Unclamped: a price outside the visible range maps outside the pane, and the painter’s clip rect clips it.

Implementations§

Source§

impl PriceMap

Source

pub fn new( transform: PriceTransform, range: PriceRange, top: f32, bottom: f32, inverted: bool, ) -> Self

Maps range (scale units) onto top..bottom (points), the low end at the bottom unless inverted.

Source

pub fn with_bounds(self, top: f32, bottom: f32) -> Self

Uses the same scale, orientation and formatting in a different vertical plot area.

Source

pub fn with_price_precision(self, decimals: Option<u8>) -> Self

Sets the price precision for this frame.

Source

pub fn with_tick_marks(self, config: PriceMarkGeneratorConfig) -> Self

Sets how marks spaces the tick marks.

Source

pub fn marks(&self) -> Vec<PriceMark>

Tick marks for the visible range, spaced by the scale’s tick_marks settings. The labels of a chart’s maps write prices of four or more integer digits with its ChartConfig::thousands_sep.

Source

pub fn price_precision(&self) -> Option<usize>

Supplied price decimals, or None to derive them from the tick step. Percentage and indexed axes keep their own precision.

Source

pub fn transform(&self) -> PriceTransform

Returns the price transform.

Source

pub fn range(&self) -> PriceRange

Returns the visible range in scale units.

Source

pub fn price_to_y(&self, price: f64) -> f32

Converts a price to a y coordinate.

Source

pub fn y_to_price(&self, y: f32) -> f64

Converts a y coordinate to a price.

Source

pub fn translate_price(&self, price: f64, from_y: f32, to_y: f32) -> f64

Translates a price by the scale-unit offset between two y coordinates.

Equal y coordinates keep valid prices exactly unchanged. Non-positive logarithmic prices start from their bounded off-pane coordinate.

Trait Implementations§

Source§

impl Clone for PriceMap

Source§

fn clone(&self) -> PriceMap

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for PriceMap

Source§

impl Debug for PriceMap

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for PriceMap

Source§

fn eq(&self, other: &PriceMap) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PriceMap

Auto Trait Implementations§

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSend for T
where T: Send + Sync + ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.