Struct LegendSpec 

pub struct LegendSpec {
    pub title: String,
    pub units: String,
    pub ramp: ColorRamp,
    pub min_value: f64,
    pub max_value: f64,
    pub labeled_stops: Vec<LabeledStop>,
    pub normalization: NormalizationMode,
}

Legend metadata sufficient for client-side UI rendering.

Rustial does not render the legend itself. This struct carries enough information for a client application to build a legend widget in Bevy UI, egui, HTML, or any other framework.

Fields

title: String

Human-readable title (e.g. "Agent Density").

units: String

Units string (e.g. "agents/m2", "dBm", "%").

ramp: ColorRamp

The colour ramp driving both renderer output and legend display.

min_value: f64

Minimum data value (maps to ramp position 0.0).

max_value: f64

Maximum data value (maps to ramp position 1.0).

labeled_stops: Vec<LabeledStop>

Optional labeled tick marks for the legend.

normalization: NormalizationMode

How values should be presented.

Implementations

impl LegendSpec

pub fn new( title: impl Into<String>, ramp: ColorRamp, min: f64, max: f64, ) -> Self

Create a minimal legend spec.

pub fn with_units(self, units: impl Into<String>) -> Self

Set the units string.

pub fn with_stop(self, position: f32, label: impl Into<String>) -> Self

Add a labeled stop.

Trait Implementations

impl Clone for LegendSpec

fn clone(&self) -> LegendSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LegendSpec

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

Formats the value using the given formatter.