MAIDR JavaScript API
    Preparing search index...

    The props of an MUI X chart element that the adapter reads.

    interface MuiChartProps {
        series?: MuiSankeySeries | readonly MuiSeriesConfig[];
        xAxis?: readonly MuiAxisConfig[];
        yAxis?: readonly MuiAxisConfig[];
        dataset?: readonly Record<string, unknown>[];
        layout?: "horizontal" | "vertical";
        renderer?: string;
        width?: number;
        disableKeyboardNavigation?: boolean;
        data?: readonly unknown[];
        plotType?: "line" | "bar";
        area?: boolean;
        curve?: string;
        value?: number | null;
        valueMin?: number;
        valueMax?: number;
        radar?: { metrics?: readonly (string | MuiRadarMetric)[]; max?: number };
        zAxis?: readonly { colorMap?: MuiColorMap }[];
        categoryAxis?: { categories?: readonly unknown[] };
    }
    Index

    Properties

    series?: MuiSankeySeries | readonly MuiSeriesConfig[]

    An array for every chart but <SankeyChart>, whose one series is an object.

    xAxis?: readonly MuiAxisConfig[]
    yAxis?: readonly MuiAxisConfig[]
    dataset?: readonly Record<string, unknown>[]
    layout?: "horizontal" | "vertical"

    Bar: 'horizontal' lays the bars along the y axis.

    renderer?: string

    Bar and scatter: 'svg-batch' / 'svg-progressive' draw no per-mark element.

    width?: number

    Without it the chart sizes itself to its container.

    disableKeyboardNavigation?: boolean
    data?: readonly unknown[]

    Sparkline: its values, in place of a series.

    plotType?: "line" | "bar"

    Sparkline: 'bar' draws bars, anything else a line.

    area?: boolean

    Sparkline: fill under the line.

    curve?: string

    Sparkline: the d3 curve of the line.

    value?: number | null

    Gauge: the measure, and the range of its dial.

    valueMin?: number
    valueMax?: number
    radar?: { metrics?: readonly (string | MuiRadarMetric)[]; max?: number }

    Radar: the spokes.

    zAxis?: readonly { colorMap?: MuiColorMap }[]

    Heatmap: the colour axis, whose scale decides which cells are drawn.

    categoryAxis?: { categories?: readonly unknown[] }

    Funnel: the stage names, when the data items carry none.