MAIDR JavaScript API
    Preparing search index...

    Interface AmChartsBinderOptions

    Options for the amCharts-to-MAIDR adapter.

    interface AmChartsBinderOptions {
        title?: string;
        subtitle?: string;
        axisLabels?: { x?: string; y?: string };
        dumbbellLabels?: { start?: string; end?: string };
        bump?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    title?: string

    Override the chart title. By default the binder reads the chart's first title child if one exists.

    subtitle?: string

    Override the chart subtitle.

    axisLabels?: { x?: string; y?: string }

    Override individual axis labels. Keys are "x" or "y".

    dumbbellLabels?: { start?: string; end?: string }

    What a dumbbell chart's two ends are called — "1990" and "2020", "before" and "after".

    Supplied here because there is nowhere to read them from: amCharts names the series, not the two ends of its columns, so anything taken off the chart would be a guess. Left out, MAIDR announces "start" and "end", which says which dot the cursor is on but not what it stands for.

    bump?: boolean

    Whether the chart's line series carry ranks — a bump chart — rather than magnitudes.

    amCharts has no bump series: a rank table is line series on a value axis whose renderer is inversed, so first place sits at the top. That inversion is also how a plain chart of descending magnitudes is drawn, which is why the adapter corroborates it against the values themselves and why this option exists at all.

    • true says the lines are ranks when amCharts was not told to invert the axis. The values still have to read as ranks, since the option applies to every panel of the figure and must not invert a plain line chart's pitch.
    • false suppresses the reading entirely, for a chart of small integers that happens to look like a ranking.
    • Left out, the adapter decides from the axis and the values together.