MAIDR JavaScript API
    Preparing search index...

    Type Alias RechartsChartType

    RechartsChartType:
        | "bar"
        | "stacked_bar"
        | "dodged_bar"
        | "normalized_bar"
        | "diverging_bar"
        | "waterfall"
        | "dumbbell"
        | "gantt"
        | "gauge"
        | "dot"
        | "lollipop"
        | "funnel"
        | "histogram"
        | "line"
        | "step"
        | "area"
        | "stacked_area"
        | "normalized_area"
        | "radar"
        | "polar_area"
        | "bump"
        | "survival"
        | "scatter"
        | "volcano"
        | "manhattan"
        | "error_bar"
        | "forest"
        | "pie"
        | "alluvial"
        | "sankey"
        | "treemap"
        | "sunburst"
        | "icicle"
        | "parallel"
        | "ridgeline"
        | "hexbin"
        | "boxen"

    Recharts chart types supported by the adapter.

    Mapping to MAIDR trace types:

    • 'bar'TraceType.BAR — Simple bar chart
    • 'stacked_bar'TraceType.STACKED — Stacked bar chart (Recharts <Bar stackId="...">)
    • 'dodged_bar'TraceType.DODGED — Grouped/dodged bar chart (multiple <Bar> without stackId)
    • 'normalized_bar'TraceType.NORMALIZED — Stacked normalized (100%) bar chart
    • 'diverging_bar'TraceType.DIVERGING — Population pyramid or Likert scale: exactly two yKeys drawn back to back with <BarChart stackOffset="sign">, the left-hand one holding NEGATIVE values
    • 'waterfall'TraceType.WATERFALL — A starting value carried to an ending one through signed contributions. The single yKeys entry holds each step's contribution and the adapter accumulates the running totals; see WaterfallStepConfig
    • 'dumbbell'TraceType.DUMBBELL — Two values compared at each category, joined by a segment. Exactly two yKeys — the starting end first — named for the reader by fillKeys
    • 'gantt'TraceType.GANTT — Intervals laid out along a shared axis, one row per interval: xKey names the lane and the two yKeys its start and end; see GanttChartConfig
    • 'gauge'TraceType.GAUGE — One measure read against a range, drawn as a half-dial <RadialBarChart>; see GaugeDialConfig
    • 'dot'TraceType.DOT — Cleveland dot plot: one point per category, drawn with <Scatter> against a category axis
    • 'lollipop'TraceType.LOLLIPOP — Lollipop chart: a <ComposedChart> of a thin <Bar> stem plus a <Scatter> head. Read exactly as a bar is — the stem is the mark, not extra data
    • 'funnel'TraceType.FUNNEL — Funnel chart (<FunnelChart> + <Funnel>): a population shrinking across ordered stages. The counts are a bar's data; MAIDR derives the retention and share it announces from them
    • 'histogram'TraceType.HISTOGRAM — Histogram rendered as bar chart with bin ranges
    • 'line'TraceType.LINE — Line chart
    • 'step'TraceType.STEP — Step chart: a <Line> or <Area> drawn with type="stepAfter", "stepBefore" or "step". The value is held across an interval and then jumps rather than sliding between samples, which is what StepTrace navigates and describes in terms of runs. Which convention it is comes from RechartsAdapterConfig.stepDirection or is read off the <Line>: hv, vh, or mid for the centred type="step", whose riser lands midway between the samples
    • 'area'TraceType.AREA — Area chart (Recharts <Area>); the fill is decoration, so the data is a line's
    • 'stacked_area'TraceType.STACKED_AREA — Stacked area chart (<Area stackId="...">, multiple yKeys)
    • 'normalized_area'TraceType.NORMALIZED_AREA — 100% stacked area (<AreaChart stackOffset="expand">, multiple yKeys)
    • 'radar'TraceType.RADAR — Radar/spider chart (<RadarChart> + <Radar>)
    • 'polar_area'TraceType.POLAR_AREA — Coxcomb or rose chart: the same spokes a radar has, drawn as wedges whose radius is the value. A <Pie> with equal-angle slices and a per-datum outerRadius, NOT a <RadialBarChart> — that one puts the categories on rings and encodes the value as angle, which is a different chart
    • 'bump'TraceType.BUMP — Bump chart: rank over time, drawn as a <LineChart> with <YAxis reversed>
    • 'survival'TraceType.SURVIVAL — Kaplan-Meier curve: a <Line type="stepAfter"> plus the censoring marks and confidence band declared through SurvivalCurveConfig
    • 'scatter'TraceType.SCATTER — Scatter/point plot
    • 'volcano'TraceType.VOLCANO — Volcano plot: effect size against significance, read through the cutoffs in VolcanoPointConfig
    • 'manhattan'TraceType.MANHATTAN — Manhattan plot: genomic position against significance. Same payload and config as 'volcano'
    • 'error_bar'TraceType.ERROR_BAR — An estimate with the interval drawn around it (<ErrorBar> inside a <Bar>/<Line>/<Scatter>)
    • 'forest'TraceType.FOREST — Forest plot: one interval per study against a shared null line, with the pooled summary last
    • 'pie'TraceType.PIE — Pie/doughnut chart (Recharts <Pie>); a doughnut is a pie with an innerRadius, which changes nothing about the data, so both use this type
    • 'alluvial'TraceType.ALLUVIAL — Weighted flow between nodes drawn as a <Sankey> whose node set repeats at each stage
    • 'sankey'TraceType.SANKEY — The same weighted flow drawn as a left-to-right budget: one <Sankey>, one node set, ribbons that split and rejoin. Same data and same FlowLinkConfig as 'alluvial'
    • 'treemap'TraceType.TREEMAP — A hierarchy laid out as nested area (<Treemap>). data is the nested { name, children } array the component itself is given, not the adapter's usual flat rows
    • 'sunburst'TraceType.SUNBURST — The same hierarchy drawn as rings (<SunburstChart>). data is the root's children, since the sunburst draws every node except the root
    • 'icicle'TraceType.ICICLE — The same hierarchy drawn as depth-ordered bands. Recharts has no icicle component, so it is built as a <BarChart layout="vertical"> of floating bars — one row per node, the lane its depth — exactly the recipe 'gantt' uses
    • 'parallel'TraceType.PARALLEL (the string 'parallel_coordinates') — One polyline per observation crossing an axis per variable. A <Line> binds to one yAxisId, so the drawn values have to be min-max normalised onto a shared scale; the announced ones must not be, and ParallelAxesConfig names the RAW fields
    • 'ridgeline'TraceType.RIDGELINE — One density curve per group along a shared value axis, drawn as overlapping <Area>s with a per-group offset baked into the plotted values. The offset is presentation, so RidgelineCurveConfig names the densities BEFORE it was added
    • 'hexbin'TraceType.HEXBIN — A hexagonal lattice of counts, drawn as <Scatter shape={hexagon}> on numeric axes. Recharts places the marks and nothing else: the binning happens outside it, so the rows are precomputed bin centres and counts named by HexbinLatticeConfig
    • 'boxen'TraceType.BOXEN — A letter-value plot: a median and a variable-depth ladder of quantile pairs per category, computed outside Recharts and named by BoxenLadderConfig