MAIDR JavaScript API
    Preparing search index...

    Interface ApexChartsAdapterOptions

    Options for customizing the apexchartsToMaidr output.

    Each overrides what the chart's own configuration says.

    interface ApexChartsAdapterOptions {
        id?: string;
        title?: string;
        subtitle?: string;
        caption?: string;
        axes?: { x?: string; y?: string; z?: string };
        percentileBands?: PercentileBandOption[];
    }
    Index

    Properties

    id?: string

    The MAIDR figure id. Defaults to maidr-apexcharts-<chartID>.

    title?: string

    The chart title. Defaults to title.text.

    subtitle?: string

    The chart subtitle. Defaults to subtitle.text.

    caption?: string

    A caption read after the title. The chart has no default.

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

    Axis labels. Default to xaxis.title.text and the title.text of the y axis each layer's series are drawn against (yaxis[0] by default). ApexCharts draws each title where its axis is drawn, so on a horizontal bar chart x is the value axis along the bottom.

    percentileBands?: PercentileBandOption[]

    Fan charts drawn on the chart, each read as one percentile_band layer.

    A rangeArea series is a band between two values, and nothing in it says which quantiles those are; ApexCharts gives a series no slot to say so in. So they are stated here: median names the median's line series and each band's series a rangeArea series, both by series name, with the band's two levels as fractions. The bands' edges are the low and high values ApexCharts drew, matched to the median by x.

    percentileBands: [{
    median: 'Median',
    bands: [{ series: '90% interval', lower: 0.05, upper: 0.95 }],
    }]