Struct PlotSpec 

pub struct PlotSpec {
    pub marks: Vec<Mark>,
    pub x: Axis,
    pub y: Axis,
    pub style: PlotStyle,
    pub crosshair: bool,
    pub y_autoscale: bool,
    pub x_autoscale: bool,
    pub controls: PlotControls,
    pub legend: Option<LegendPosition>,
    pub downsample: Option<Decimation>,
}

The full declarative description of a plot: marks, per-axis scales, view behaviour, and styling. Assemble fluently and pass to plot:

plot(
    PlotSpec::new()
        .x(Scale::time())
        .line(&cpu)
        .line(&mem)
        .crosshair(true),
)
.key("metrics")

Fields

marks: Vec<Mark>

The marks, drawn in order.

x: Axis

Horizontal-axis configuration.

y: Axis

Vertical-axis configuration.

style: PlotStyle

Plot-level styling.

crosshair: bool

Whether to show a crosshair reading out the nearest sample.

y_autoscale: bool

Whether the vertical axis auto-fits to the data visible in the current horizontal window each frame (vs. a fixed Y window).

x_autoscale: bool

Whether the horizontal axis auto-fits to the full data extent each frame (vs. sticking at the window it was first seeded with). On by default so a plot whose series grow — a streaming dashboard fed by SeriesHandle::append — keeps the new samples in view. Any manual X gesture (pan, wheel zoom, X box-zoom) or crate::state::UiState::set_plot_view takes manual control and stops the tracking until a double-click reset or a PlotRequest::FitAll. With static data the re-fit resolves to the same window every frame, so this is invisible for non-streaming plots.

controls: PlotControls

Pointer control scheme — what the primary drag does (see PlotControls).

legend: Option<LegendPosition>

Legend placement, or None for no legend.

downsample: Option<Decimation>

Library-side down-sampling for over-dense line series (the dump-everything path). None draws every sample; Some reduces each line to the pixel budget over the visible window before upload. A virtual app that resamples its own source leaves this None.

Implementations

impl PlotSpec

pub fn new() -> Self

An empty spec with default axes and styling.

pub fn line(self, series: &SeriesHandle) -> Self

Add a default-styled line mark for series.

pub fn scatter(self, series: &SeriesHandle) -> Self

Add a default-styled scatter mark for series.

pub fn add_mark(self, mark: impl Into<Mark>) -> Self

Add a fully-built mark (the escape hatch for styled marks, e.g. spec.add_mark(line(&h).color(c).width(2.0))).

pub fn x(self, scale: Scale) -> Self

Set the horizontal-axis Scale (keeps any existing title).

pub fn y(self, scale: Scale) -> Self

Set the vertical-axis Scale (keeps any existing title).

pub fn x_axis(self, axis: Axis) -> Self

Replace the whole horizontal-axis configuration.

pub fn y_axis(self, axis: Axis) -> Self

Replace the whole vertical-axis configuration.

pub fn crosshair(self, on: bool) -> Self

Set whether to draw the crosshair / nearest-sample readout.

pub fn y_autoscale(self, on: bool) -> Self

Set whether the vertical axis auto-scales to the visible window.

pub fn x_autoscale(self, on: bool) -> Self

Set whether the horizontal axis auto-scales to the full data extent each frame (see Self::x_autoscale; on by default). Turn this off for a plot that should hold a fixed time window regardless of what the series contain.

pub fn controls(self, controls: PlotControls) -> Self

Set the pointer control scheme (what the primary drag does). Defaults to PlotControls::ZoomDrag.

pub fn legend(self, position: LegendPosition) -> Self

Show a legend at position. Series are labelled by their label, falling back to "Series N".

pub fn grid(self, on: bool) -> Self

Set whether gridlines are drawn.

pub fn downsample(self, decimation: Decimation) -> Self

Enable library-side down-sampling of line series to the pixel budget (the dump-everything path). Leave unset for the virtual-data flow.

pub fn background(self, color: Color) -> Self

Set the data-rect background fill.

Trait Implementations

impl Clone for PlotSpec

fn clone(&self) -> PlotSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlotSpec

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

Formats the value using the given formatter.

impl Default for PlotSpec

fn default() -> Self

Returns the “default value” for a type.