Struct PriceScale 

pub struct PriceScale { /* private fields */ }

One price axis: options and the visible range in scale units, fitted to the data until the user scales it by hand.

Implementations

impl PriceScale

pub fn new(options: PriceScaleOptions) -> Self

Creates an auto-scaled price scale.

pub fn set_price_precision(&mut self, decimals: Option<u8>)

Sets the decimals used by price ticks and tags. None derives them from the tick step.

pub fn set_bar_ratio_locked( &mut self, locked: bool, bar_spacing: f32, height: f32, )

Locks scale units per bar at the current bar spacing and pane height. Invalid dimensions leave the scale unlocked. Unlocking keeps the current manual range.

pub fn bar_ratio(&self) -> Option<f64>

Locked scale units per bar, or None when unlocked.

pub fn set_bar_ratio(&mut self, ratio: Option<f64>)

Set scale units per bar; None unlocks. Invalid ratios leave the scale unchanged. The next update_bar_ratio applies it about the range centre.

pub fn bar_ratio_locked(&self) -> bool

Whether horizontal zoom and pane resizing preserve scale units per bar.

pub fn update_bar_ratio(&mut self, bar_spacing: f32, height: f32)

Preserves the locked ratio about the range centre after horizontal zoom or pane resize.

pub fn options(&self) -> &PriceScaleOptions

Returns the options.

pub fn options_mut(&mut self) -> &mut PriceScaleOptions

Returns the options for changing the mode, inversion or margins.

The range is in scale units, so after changing the mode call reset to fit the data in the new units.

pub fn range(&self) -> PriceRange

Returns the visible range in scale units.

pub fn is_manual(&self) -> bool

Returns true when the user has scaled by hand.

pub fn autoscale(&mut self, min: f64, max: f64)

Fits min..max (scale units) plus margins unless the user scaled by hand.

Non-finite bounds (no drawable data) and a fit that overflows keep the current range.

pub fn set_range(&mut self, min: f64, max: f64)

Shows min..max and switches to manual.

The bounds are in the units of the transform the last fit returned (ChartState::fit_price_scale). Non-finite, equal or reversed bounds, or an overflowing span, leave the scale unchanged.

pub fn zoom(&mut self, factor: f64, anchor: f64)

Scales the range by factor (above 1 zooms out) around the scale value anchor, which keeps its position on screen, and switches to manual. anchor is in the units of the transform the last fit returned.

One call changes the span by at most 20 times either way. Zooming in stops at a millionth of the price level: 1e-6 log units on a logarithmic scale, 1e-4 percentage or index points in the relative modes, and for prices 1e-6 of the larger magnitude of the data at the last fit or of the range. A result that is not finite leaves the range unchanged.

pub fn reset(&mut self)

Returns to auto-scaling (double click on the axis).

pub fn map(&self, transform: PriceTransform, top: f32, bottom: f32) -> PriceMap

Mapping for one series for one frame, given the pane’s vertical extent in points.

Trait Implementations

impl Clone for PriceScale

fn clone(&self) -> PriceScale

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PriceScale

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PriceScale

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PriceScale

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.