MAIDR JavaScript API
    Preparing search index...

    Interface ChartJsChart

    Minimal representation of a Chart.js chart instance.

    interface ChartJsChart {
        isDatasetVisible?: (index: number) => boolean;
        canvas: HTMLCanvasElement;
        data: ChartJsData;
        options: ChartJsOptions;
        config: { type: string };
        scales?: Record<string, ChartJsRuntimeScale>;
        getDatasetMeta: (datasetIndex: number) => ChartJsDatasetMeta;
        setActiveElements: (elements: ChartJsActiveElement[]) => void;
        chartArea?: { left: number; top: number; right: number; bottom: number };
        tooltip?: {
            setActiveElements: (
                elements: ChartJsActiveElement[],
                eventPosition: { x: number; y: number },
            ) => void;
        };
        update: (mode?: string) => void;
        draw?: () => void;
    }
    Index

    Properties

    isDatasetVisible? canvas data options config scales? getDatasetMeta setActiveElements chartArea? tooltip? update draw?

    Properties

    isDatasetVisible?: (index: number) => boolean

    Whether a dataset is drawn. chartjs-chart-pcp needs it because a hidden dataset there is a hidden axis: Chart.js lays out no scale for it, so it is not a column of the drawn chart at all.

    canvas: HTMLCanvasElement
    data: ChartJsData
    options: ChartJsOptions
    config: { type: string }
    scales?: Record<string, ChartJsRuntimeScale>

    Runtime scale instances keyed by scale id, laid out with pixel geometry.

    getDatasetMeta: (datasetIndex: number) => ChartJsDatasetMeta
    setActiveElements: (elements: ChartJsActiveElement[]) => void
    chartArea?: { left: number; top: number; right: number; bottom: number }

    The plot area, in canvas CSS pixels, once the chart is laid out.

    tooltip?: {
        setActiveElements: (
            elements: ChartJsActiveElement[],
            eventPosition: { x: number; y: number },
        ) => void;
    }
    update: (mode?: string) => void
    draw?: () => void

    Repaints the chart as it stands, running the draw hooks, without animating.

    Settings

    Member Visibility

    On This Page

    Properties