@theredhead — Frontend Library - v1.0.0
    Preparing search index...

    Interface GaugeRenderContext

    Configuration snapshot passed to every GaugePresentationStrategy.render call.

    All values are pre-clamped and validated by the UIGauge component.

    interface GaugeRenderContext {
        detailLevel: GaugeDetailLevel;
        formatValue?: (value: number) => string;
        max: number;
        min: number;
        size: GaugeSize;
        thresholds?: readonly number[];
        tokens: GaugeTokens;
        unit: string;
        value: number;
        zones: readonly GaugeZone[];
    }
    Index

    Properties

    detailLevel: GaugeDetailLevel

    Level of visual detail the strategy should render.

    formatValue?: (value: number) => string

    Optional consumer-supplied formatter for numeric values.

    When provided, strategies use this for all numeric labels (value readout, tick labels, min/max). When undefined, each strategy falls back to its own default formatting.

    max: number

    Scale maximum.

    min: number

    Scale minimum.

    size: GaugeSize

    Target render size.

    thresholds?: readonly number[]

    Optional reference values rendered as marker lines on the gauge.

    Use for target set-points, thresholds, or limit indicators.

    tokens: GaugeTokens

    CSS custom-property tokens resolved from the host element.

    unit: string

    Unit label displayed beside the value (e.g. "km/h", "dB").

    value: number

    Current value (clamped between min and max).

    zones: readonly GaugeZone[]

    Optional coloured zones.