Struct StreamingChart 

pub struct StreamingChart { /* private fields */ }

A wrapper around Chart that automatically manages caching for live updates.

StreamingChart tracks dirty state and provides efficient methods for updating chart data in real-time scenarios.

Example

use astrelis_geometry::chart::*;

// Create a streaming chart for sensor data
let chart = ChartBuilder::line()
    .add_series("Temperature", &[])
    .interactive(true)
    .build();

let mut streaming = StreamingChart::new(chart);

// In your update loop:
streaming.push_point(0, DataPoint::new(timestamp, temperature), Some(1000));

// Before rendering:
streaming.prepare_render(&bounds);

// Render using cached data
chart_renderer.draw(streaming.chart(), bounds);

Implementations

impl StreamingChart

pub fn new(chart: Chart) -> Self

Create a new streaming chart wrapper.

pub fn chart(&self) -> &Chart

Get a reference to the underlying chart.

pub fn chart_mut(&mut self) -> &mut Chart

Get a mutable reference to the underlying chart.

Note: Direct mutations bypass dirty tracking. Prefer using the streaming-specific methods when possible.

pub fn cache(&self) -> &ChartCache

Get a reference to the cache.

pub fn cache_mut(&mut self) -> &mut ChartCache

Get a mutable reference to the cache.

pub fn needs_rebuild(&self) -> bool

Check if the cache needs to be rebuilt before rendering.

pub fn prepare_render(&mut self, bounds: &Rect)

Prepare the chart for rendering by rebuilding the cache if needed.

pub fn append_data(&mut self, series_idx: usize, points: &[DataPoint])

Append data points to a series.

This method tracks the change for efficient partial cache updates.

pub fn push_point( &mut self, series_idx: usize, point: DataPoint, max_points: Option<usize>, )

Push a single point with optional sliding window.

If max_points causes data to be removed, this marks as a full data change. Otherwise, it marks as an append for partial updates.

pub fn set_data(&mut self, series_idx: usize, data: Vec<DataPoint>)

Replace all data in a series.

pub fn clear_data(&mut self, series_idx: usize)

Clear all data from a series.

pub fn mark_view_changed(&mut self)

Notify that the view has changed (pan/zoom).

Call this after modifying chart.interactive.pan_offset or chart.interactive.zoom.

pub fn mark_style_changed(&mut self)

Notify that style has changed.

pub fn mark_axes_changed(&mut self)

Notify that axes have changed.

pub fn mark_bounds_changed(&mut self)

Notify that bounds have changed.

pub fn dirty_flags(&self) -> ChartDirtyFlags

Get the current dirty flags.

pub fn clear_dirty(&mut self)

Manually clear dirty flags (normally done by prepare_render).

pub fn push_time_point(&mut self, series_idx: usize, time: f64, value: f64)

Push a time/value point to a series.

Convenient method for time series data.

pub fn push_time_point_windowed( &mut self, series_idx: usize, time: f64, value: f64, max_points: usize, )

Push a time/value point with sliding window.

pub fn auto_scroll(&mut self, axis_id: AxisId, window_size: f64)

Configure auto-scrolling for an axis.

When enabled, the axis range will automatically shift to show the most recent window_size units of data.

Example

// Show the last 60 seconds of data
streaming.auto_scroll(AxisId::X_PRIMARY, 60.0);

pub fn disable_auto_scroll(&mut self, axis_id: AxisId)

Disable auto-scrolling for an axis.

pub fn apply_auto_scroll(&mut self)

Apply auto-scroll to update axis ranges.

Call this after pushing data to adjust the view window.

pub fn prepare_render_with_result(&mut self, bounds: &Rect) -> PrepareResult

Prepare for rendering and return detailed update information.

pub fn get_display_data( &self, series_idx: usize, pixel_width: f32, ) -> Vec<DataPoint>

Get display data for a series, downsampled if necessary.

Uses LTTB (Largest Triangle Three Buckets) algorithm to preserve visual features while reducing point count for rendering.

Arguments

• series_idx - Index of the series
• pixel_width - Width of the display area in pixels

Returns

Downsampled data points optimized for the given pixel width. If the data has fewer points than pixels, returns all points.

pub fn get_all_display_data(&self, pixel_width: f32) -> Vec<Vec<DataPoint>>

Get downsampled data for all series.

pub fn statistics(&self) -> StreamingStatistics

Get statistics about the streaming data.

Methods from Deref<Target = Chart>

pub fn series_len(&self, series_idx: usize) -> usize

Get the number of data points in a series.

pub fn total_points(&self) -> usize

Get the total number of data points across all series.

pub fn get_axis(&self, id: AxisId) -> Option<&Axis>

Get an axis by ID.

pub fn x_axis(&self) -> Option<&Axis>

Get the X axis (primary).

pub fn y_axis(&self) -> Option<&Axis>

Get the Y axis (primary).

pub fn data_bounds_for_axis(&self, axis_id: AxisId) -> Option<(f64, f64)>

Get the combined bounds of all series for a specific axis.

pub fn data_bounds(&self) -> Option<(DataPoint, DataPoint)>

Get the combined bounds of all series.

pub fn axis_range(&self, axis_id: AxisId) -> (f64, f64)

Get the effective range for an axis.

pub fn x_range(&self) -> (f64, f64)

Get the effective X range (respecting axis min/max overrides).

pub fn y_range(&self) -> (f64, f64)

Get the effective Y range (respecting axis min/max overrides).

Trait Implementations

impl Debug for StreamingChart

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

Formats the value using the given formatter.

impl Deref for StreamingChart

type Target = Chart

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<Chart> for StreamingChart

fn from(chart: Chart) -> Self

Converts to this type from the input type.