Skip to main content

ChartState

Struct ChartState 

Source
pub struct ChartState {
    pub version: u32,
    pub bar_spacing: Css,
    pub right_offset: f64,
    pub crosshair_mode: CrosshairMode,
    pub panes: Vec<PaneState>,
    pub drawings: Vec<SavedDrawing>,
}
Expand description

Saved view, layout and drawings of a chart.

§Examples

use ferrochart_core::chart::{SeriesData, SeriesOptions};
use ferrochart_core::drawing::{Anchor, DrawingData};
use ferrochart_core::frame::SeriesKind;
use ferrochart_core::testing::random_walk;
use ferrochart_core::{Chart, ChartOptions};

// The host sets up a chart: series and data.
let setup = || -> Result<Chart, ferrochart_core::Error> {
    let mut chart = Chart::new(ChartOptions::default());
    let id = chart.add_series(chart.main_pane(), SeriesKind::Candlestick, SeriesOptions::default())?;
    chart.set_data(id, SeriesData::Ohlc(random_walk(1, 100, 0, 60_000)?))?;
    Ok(chart)
};
let mut chart = setup()?;
let pane = chart.main_pane();
chart.drawings().add(pane, &DrawingData::new("horizontal_line", vec![Anchor { time: 0, price: 100.0 }]))?;
chart.time_scale().set_bar_spacing(12.0);
let state = chart.save_state();

// Later: the same setup, then the saved state.
let mut restored = setup()?;
restored.load_state(state.clone())?;
assert_eq!(restored.save_state(), state);

Fields§

§version: u32

Format version (STATE_VERSION).

§bar_spacing: Css

Bar spacing.

§right_offset: f64

Empty space right of the last bar, in bars.

§crosshair_mode: CrosshairMode

Crosshair mode.

§panes: Vec<PaneState>

Panes, top to bottom.

§drawings: Vec<SavedDrawing>

Drawings, bottom to top.

Trait Implementations§

Source§

impl Clone for ChartState

Source§

fn clone(&self) -> Self

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 Debug for ChartState

Source§

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

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

impl PartialEq for ChartState

Source§

fn eq(&self, other: &Self) -> 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 ChartState

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
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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.