MAIDR Documentation - v4.4.0
    Preparing search index...

    Interface PlotlyGauge

    The dial an indicator trace draws, as plotly resolves it.

    Only present when the trace's mode includes gauge; a number-only indicator is a text tile with no dial and no container here.

    interface PlotlyGauge {
        shape?: "angular" | "bullet";
        axis?: { range?: [number, number] };
        steps?: { range?: [number, number]; name?: string }[];
        threshold?: { value?: number | false };
    }
    Index

    Properties

    shape? axis? steps? threshold?

    Properties

    shape?: "angular" | "bullet"

    angular (the default dial) or bullet (a horizontal bar).

    axis?: { range?: [number, number] }

    The dial's ends, on axis.range.

    steps?: { range?: [number, number]; name?: string }[]

    The coloured arcs behind the bar. Plotly resolves range and color for every step; name only when the author wrote one.

    threshold?: { value?: number | false }

    The target line. Plotly resolves value to the boolean false when the author set none, which is why it is not simply coerced to a number.

    Settings

    Member Visibility

    On This Page

    Properties