MAIDR JavaScript API
    Preparing search index...

    Interface MuiSeriesConfig

    The subset of an MUI X series config the adapter reads, across the four supported kinds.

    interface MuiSeriesConfig {
        id?: string | number;
        type?: string;
        label?: string | ((location: "legend" | "tooltip") => string);
        data?: readonly unknown[];
        dataKey?: string;
        valueGetter?: (row: never) => unknown;
        stack?: string;
        stackOffset?: string;
        area?: boolean;
        curve?: string;
        datasetKeys?: { x?: string; y?: string; id?: string };
        startAngle?: number;
        endAngle?: number;
        sortingValues?:
            | "none"
            | "desc"
            | "asc"
            | ((a: number, b: number) => number);
        layout?: "horizontal" | "vertical";
    }
    Index

    Properties

    id? type? label? data? dataKey? valueGetter? stack? stackOffset? area? curve? datasetKeys? startAngle? endAngle? sortingValues? layout?

    Properties

    id?: string | number
    type?: string
    label?: string | ((location: "legend" | "tooltip") => string)
    data?: readonly unknown[]
    dataKey?: string
    valueGetter?: (row: never) => unknown

    Reads the series' value (bar, line) or { x, y } point (scatter) off one dataset row.

    stack?: string

    Bar and line: series sharing a stack id are drawn on top of each other.

    stackOffset?: string

    Bar and line: 'expand' normalises each stack to a share of one.

    area?: boolean

    Line: fill the region under the line.

    curve?: string

    Line: the d3 curve the line is drawn with; step* draws a staircase.

    datasetKeys?: { x?: string; y?: string; id?: string }

    Scatter: which dataset columns hold x, y and the point id.

    startAngle?: number

    Pie: angles in degrees clockwise from 12 o'clock.

    endAngle?: number
    sortingValues?: "none" | "desc" | "asc" | ((a: number, b: number) => number)

    Pie: draw the slices sorted by value rather than in data order.

    layout?: "horizontal" | "vertical"

    Bar: the orientation MUI stamps on a series from the chart's layout.

    Settings

    Member Visibility

    On This Page

    Properties