Struct ChartState 

pub struct ChartState { /* private fields */ }

Backend chart state – owns bar data, time-scale coordinate system, price auto-scaling logic, and zoom history.

This is the pure-logic layer with no UI or rendering dependencies. The UI layer reads from ChartState to determine what to draw and writes back interaction results (scroll, zoom, data updates).

Example

use egui_charts::model::BarData;
use egui_charts::studies::ChartState;

let data = BarData::new();
let state = ChartState::new(data);
assert!(state.visible_data().is_empty());

Implementations

impl ChartState

pub fn new(data: BarData) -> Self

Create new chart state with data

pub fn data(&self) -> &BarData

Get reference to bar data

pub fn time_scale_mut(&mut self) -> &mut TimeScale

Get mutable reference to time scale

pub fn time_scale(&self) -> &TimeScale

Get reference to time scale

pub fn revision(&self) -> u64

Identifies the bars before the last one. It changes when any of them changes or bars are removed, and stays the same when bars are appended or the last bar is updated, so results computed from the bars can be cached under it and extended as the series streams.

pub fn set_data(&mut self, data: BarData) -> Option<usize>

Replaces the bars (also updates the bar count of the time scale). Returns the index of the first bar that differs from the previous bars, counting a change of length: the shorter length when one is a prefix of the other, None when they are identical.

pub fn shown(&self) -> &[Bar]

The series drawn on the time scale, one OHLC bar per element on price-based charts. Indices returned by the chart hover and selection APIs refer to this series.

pub fn visible_data(&self) -> &[Bar]

The bars of visible_range: source bars, or one OHLC bar per element on a price-based chart type.

pub fn visible_range(&self) -> (usize, usize)

Indices of the bars in view, end exclusive, counting elements on price-based chart types and bars otherwise. A bar the plot’s edge cuts is in view. With no bar in view the range is empty: it starts at 0 before the first bar and at the number of bars after the last.

pub fn price_scale(&self) -> &PriceScale

Returns the main series’ price scale.

pub fn price_scale_mut(&mut self) -> &mut PriceScale

Returns the main series’ price scale for changing its options or range.

pub fn fit_price_scale<'a>( &mut self, indicators: impl IntoIterator<Item = &'a dyn Indicator>, ) -> PriceTransform

Fits the price scale to the visible bars and the visible values of the visible overlay studies in indicators, unless the user scaled by hand, and returns this frame’s transform: percentage and indexed modes are relative to the first visible close.

pub fn push_zoom_state(&mut self)

Save current zoom state to history

pub fn pop_zoom_state(&mut self) -> bool

Restore previous zoom state (zoom out button)

pub fn clear_zoom_history(&mut self)

Clear zoom history

pub fn has_zoom_history(&self) -> bool

Check if there are zoom states to restore

Trait Implementations

impl Clone for ChartState

fn clone(&self) -> Self

A copy with a revision of its own, since its bars change independently.

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

Performs copy-assignment from source.

impl Debug for ChartState

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

Formats the value using the given formatter.