MAIDR JavaScript API
    Preparing search index...

    Interface FrappeChartAdapterOptions

    Options accepted by createMaidrFromFrappeChart.

    interface FrappeChartAdapterOptions {
        id?: string;
        title?: string;
        chartType: FrappeChartType;
        axes?: { x?: string; y?: string; z?: string };
    }
    Index

    Properties

    id? title? chartType axes?

    Properties

    id?: string

    Unique ID for the MAIDR instance. Defaults to the container element's id.

    title?: string

    Chart title.

    chartType: FrappeChartType

    Which chart was drawn, in the adapter's own names — see FrappeChartType. Required because a chart instance does not expose its type in a stable way, and because Frappe draws several distinct statistical charts with the same type. Multi-line charts use 'line' (the adapter auto-detects multiple datasets).

    axes?: { x?: string; y?: string; z?: string }

    Axis labels. z names the dimension the series themselves vary along — the two sides of a 'diverging' chart, for instance — and is ignored by the types that have no third dimension.

    Settings

    Member Visibility

    On This Page

    Properties