MAIDR JavaScript API
    Preparing search index...

    Interface MuiChartsAdapterConfig

    Configuration accepted by both the MaidrMuiCharts wrapper component and the useMuiChartsAdapter hook.

    interface MuiChartsAdapterConfig {
        id: string;
        title?: string;
        subtitle?: string;
        caption?: string;
        children: ReactNode;
        chartType?: MuiChartKind;
    }
    Index

    Properties

    id title? subtitle? caption? children chartType?

    Properties

    id: string

    Unique identifier for the chart. Used for DOM element IDs.

    title?: string

    Chart title displayed in text descriptions.

    subtitle?: string

    Chart subtitle.

    caption?: string

    Chart caption.

    children: ReactNode

    The MUI X chart to make accessible: one <BarChart>, <LineChart>, <ScatterChart> or <PieChart> element, optionally wrapped in plain elements such as a <Box>. Its series, xAxis, yAxis, dataset and layout props are what the adapter reads.

    chartType?: MuiChartKind

    Which kind of chart children is.

    Only needed when the kind cannot be recognised on its own. The adapter reads it from the component's name first and, failing that, from the class names MUI stamps on the rendered SVG, so a minifier that renames the component still leaves the second route open.

    Settings

    Member Visibility

    On This Page

    Properties