MAIDR JavaScript API
    Preparing search index...

    Interface HighchartsAdapterOptions

    Options for customizing the highchartsToMaidr adapter output.

    interface HighchartsAdapterOptions {
        id?: string;
        title?: string;
        seriesIndices?: number[];
        dumbbellLabels?: { start?: string; end?: string };
        bump?: boolean;
        significancePlot?: {
            type: "manhattan" | "volcano";
            seriesIndices?: number[];
            significance?: number;
            significanceDirection?: "above" | "below";
            effect?: number;
        };
    }
    Index

    Properties

    id? title? seriesIndices? dumbbellLabels? bump? significancePlot?

    Properties

    id?: string

    Override the generated chart ID. Defaults to highcharts-{n}.

    title?: string

    Override the chart title. Defaults to chart.title.textStr.

    seriesIndices?: number[]

    Convert only specific series by index. Default: all visible series.

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

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

    Supplied here because Highcharts names them nowhere: a dumbbell series declares a low and a high and nothing that says what either one is, so the names a legend gives a sighted reader have no field to be read from. Omitted, MAIDR announces them as "start" and "end", which says which dot the cursor is on but not which year it is.

    Type Declaration

    • Optionalstart?: string

      What the low end is called.

    • Optionalend?: string

      What the high end is called.

    bump?: boolean

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

    Highcharts has no bump series: the chart is ordinary line series over a reversed axis, so the adapter otherwise decides from the data, and only for a table that is a rank permutation at every period on a reversed axis (see readsAsBump). Set it to force that reading on a chart the heuristic declines, or to false to suppress it on one it accepts.

    significancePlot?: {
        type: "manhattan" | "volcano";
        seriesIndices?: number[];
        significance?: number;
        significanceDirection?: "above" | "below";
        effect?: number;
    }

    Reads the chart's scatter series as a volcano or Manhattan plot.

    Declared here because Highcharts ships neither series: both are drawn as an ordinary scatter with a plot line across it, and nothing in the chart object distinguishes one from a scatter of two variables. Without this the points are read as a scatter — accurate, but a per-point walk of tens of thousands of points rather than the threshold reading the chart was drawn for.

    Type Declaration

    • type: "manhattan" | "volcano"

      Which of the two it is: volcano puts effect size against significance, manhattan genomic position against it.

    • OptionalseriesIndices?: number[]

      Which series to read this way, by Highcharts series index. Defaults to every scatter series, which is what a Manhattan needs — one series per chromosome, all of them one cloud.

    • Optionalsignificance?: number

      The significance cutoff on the y axis. Defaults to the first numeric yAxis.plotLines value, which is the line the chart already draws.

    • OptionalsignificanceDirection?: "above" | "below"

      Which side of the cutoff is the significant one. MAIDR reads above when nothing is declared, which suits the transformed axes these charts usually carry; a raw p axis runs the other way and must say so.

    • Optionaleffect?: number

      The effect-size cutoff, applied to the magnitude of x. On a volcano it defaults to the first non-zero numeric xAxis.plotLines value. A manhattan has no default: its x is genomic position, so the plot lines across it are chromosome dividers rather than a cutoff.

    Settings

    Member Visibility

    On This Page

    Properties