MAIDR JavaScript API
    Preparing search index...

    Interface AxisConfig

    Canonical axis configuration. Every axis (x, y, z) must be specified as an object of this shape. The label is optional and falls back to built-in defaults ('X', 'Y', 'Level') when omitted.

    Grid navigation properties (min, max, tickStep) are currently consumed by scatter-plot traces only; they are silently ignored by other trace types.

    Formatting configuration lives inline as format on each axis, allowing different formatters per axis without a separate top-level block.

    // Simple label
    axes: { x: { label: "Date" }, y: { label: "Price" } }

    // With grid navigation (scatter)
    axes: {
      x: { label: "Sepal Length", min: 4.3, max: 7.9, tickStep: 0.7 },
      y: { label: "Sepal Width",  min: 2,   max: 4.4, tickStep: 0.5 }
    }

    // With formatting
    axes: {
      x: { label: "Date" },
      y: { label: "Price", format: { type: "currency", decimals: 2 } }
    }
    interface AxisConfig {
        label?: string;
        min?: number;
        max?: number;
        tickStep?: number;
        format?: AxisFormat;
    }
    Index

    Properties

    label? min? max? tickStep? format?

    Properties

    label?: string

    Axis label displayed in text descriptions. Defaults applied when absent.

    min?: number

    Minimum value for scatter grid navigation, and the lower edge of a rug's braille bins.

    max?: number

    Maximum value for scatter grid navigation, and the upper edge of a rug's braille bins.

    tickStep?: number

    Step size for scatter grid navigation, and the width of a rug's braille bins.

    format?: AxisFormat

    Optional per-axis value formatting applied in text descriptions.

    Settings

    Member Visibility

    On This Page

    Properties