MAIDR Documentation - v4.4.0
    Preparing search index...

    Interface D3VolcanoConfig

    Configuration for binding a D3 volcano plot.

    Extends D3ManhattanConfig because the two are the same chart read the same way: label names the gene the way it names the SNP, and significance is the same cutoff on the same axis. What a volcano adds is the second cutoff — the x axis is an effect size rather than a position, so a point is a finding only when it clears both.

    bindD3Volcano(svgElement, {
      selector: 'circle.gene',
      axes: { x: 'log2 fold change', y: '-log10(p)' },
      x: 'lfc',
      y: 'logP',
      label: 'gene',
      significance: 1.3,
      effect: 1,
    });
    interface D3VolcanoConfig {
        id?: string;
        title?: string;
        subtitle?: string;
        caption?: string;
        axes?: { x?: D3AxisInput; y?: D3AxisInput; fill?: D3AxisInput };
        format?: AxisFormat;
        autoApply?: boolean;
        selector: string;
        x?: DataAccessor<number>;
        y?: DataAccessor<number>;
        label?: DataAccessor<string>;
        group?: DataAccessor<string>;
        significance?: number;
        significanceDirection?: "above" | "below";
        effect?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    id? title? subtitle? caption? axes? format? autoApply? selector x? y? label? group? significance? significanceDirection? effect?

    Properties

    id?: string

    Unique identifier for the chart. Used as the MAIDR id.

    title?: string

    Chart title displayed in text descriptions.

    subtitle?: string

    Chart subtitle.

    caption?: string

    Chart caption.

    axes?: { x?: D3AxisInput; y?: D3AxisInput; fill?: D3AxisInput }

    Axis configuration. Each axis may be provided as either a plain string (shorthand for { label: value }) or a full AxisConfig object (for per-axis format, or grid navigation on scatter).

    For heatmaps and segmented bar charts, use fill for the color/category axis; the binder maps it to the canonical z axis in the MAIDR schema.

    Type Declaration

    format?: AxisFormat

    Optional formatting configuration applied to axes that do not specify their own format. Per-axis format on AxisConfig takes precedence.

    autoApply?: boolean

    When true (the default), the binder writes the generated MAIDR schema to the SVG as a maidr-data attribute so vanilla-JS users don't need to call svg.setAttribute(...) themselves. The returned result is unchanged either way.

    Set to false if you are driving MAIDR yourself — e.g. passing the returned schema to <Maidr data={...}> or persisting it elsewhere. The React adapter (useD3Adapter, MaidrD3) forces this to false internally so it can stay in control of the schema.

    true
    selector: string

    CSS selector for the point elements (e.g., 'circle', 'circle.dot').

    x?: DataAccessor<number>

    Accessor for the x-axis value.

    'x'
    y?: DataAccessor<number>

    Accessor for the y-axis value.

    'y'
    label?: DataAccessor<string>

    Accessor for what each point is — a SNP id, a probe, a marker.

    'label', falling back to snp, id, name, gene, or probe. Left out of the payload when the datum carries none of them.

    group?: DataAccessor<string>

    Accessor for the region a point belongs to — its chromosome.

    'group', falling back to chromosome, chrom, chr, or region. Left out of the payload when the datum carries none of them.

    significance?: number

    The significance cutoff on the y axis, on the axis the chart is drawn against — 7.3 for genome-wide significance on a -log10(p) axis.

    There is deliberately no default: the conventions differ by field and by software, and a guessed line would sort every point onto the wrong side silently. Omit it and the trace simply reports no findings.

    significanceDirection?: "above" | "below"

    Which side of significance is the significant one. 'above' (the default) suits the transformed axes these charts usually carry; a raw p axis runs the other way and needs 'below'.

    effect?: number

    The effect-size cutoff on the x axis, applied to its magnitude — a volcano is symmetric, and a fold change of -2 is as large an effect as one of +2.

    Like significance, there is no default: the conventions differ by field, and a guessed line would sort every gene onto the wrong side silently.

    Settings

    Member Visibility

    On This Page

    Properties