`, row-major grid positions) * or set `panelSelector` on each panel config to your own unique selector. * * @param config - Recharts adapter configuration * @returns MaidrData ready to pass to `` */ export declare function useRechartsAdapter(config: RechartsAdapterConfig): MaidrData; /** * Data point for violin KDE (kernel density estimation) curves. * Library-agnostic — no SVG coordinates embedded in data. * The density field falls back to width if absent. */ declare interface ViolinKdePoint { /** Categorical label for the violin (e.g., "setosa") */ x: string | number; /** Position along the density axis */ y: number; /** KDE density value at this point. Falls back to `width` if absent. */ density?: number; /** Half-width of the violin at this Y level (used as density fallback) */ width?: number; /** SVG viewport x-coordinate for highlight positioning (provided by backend) */ svg_x?: number; /** SVG viewport y-coordinate for highlight positioning (provided by backend) */ svg_y?: number; } /** * Configuration options for violin plot display. * Controls which summary statistics are shown in the violin box overlay. * Sent from the Python backend alongside violin_kde and violin_box layers. */ declare interface ViolinOptions { /** Show median line marker. Default: true */ showMedian?: boolean; /** Show mean value marker. Default: false */ showMean?: boolean; /** Show extrema (min/max) markers. Default: true */ showExtrema?: boolean; } /** * One point of a volcano or Manhattan plot. * * Both are scatters read almost entirely through a threshold: a volcano puts * effect size against significance, a Manhattan puts genomic position against * it. They routinely carry tens of thousands of points of which a few dozen * matter, so the question is never "what is at this coordinate" -- it is * "which points cross the line, and what are they called". */ declare interface VolcanoPoint extends ScatterPoint { /** * The region the point belongs to -- a chromosome on a Manhattan plot. * * Announced alongside the point, because "which chromosome is it on" is * the second question every one of these charts is read for. */ group?: string; } /** * Configuration for volcano and Manhattan plots. * Optional when `chartType` is `'volcano'` or `'manhattan'`. * * None of this is inferable from a Recharts ``: the component holds * coordinates, and these charts are read for identity and for which side of a * cutoff a point falls on. Both arrive from the author or not at all. */ declare interface VolcanoPointConfig { /** Key holding what the point *is* — a gene, a SNP, a probe. */ labelKey?: string; /** Key holding the region the point belongs to — a chromosome. */ groupKey?: string; /** * The significance cutoff on the y axis. * * There is no default: -log10(p) puts the line at 1.3 for p < 0.05 and at * 7.3 for genome-wide significance, and a guessed line sorts every point * onto the wrong side silently. */ significance?: number; /** * Which side of the cutoff is the significant one. Defaults to `'above'`, * which is right for the transformed axes these charts usually carry. * A raw p axis runs the other way and must declare `'below'`. */ significanceDirection?: 'above' | 'below'; /** The effect-size cutoff, applied to the magnitude of x. */ effect?: number; } /** * What a waterfall step does to the running total. * * `total` marks a step that restates the running total rather than changing * it — the opening and closing bars, and any subtotal drawn along the way. * Those sit on the baseline instead of floating, and a reader told a subtotal * "rose by 950" would be hearing a contribution the chart never made. */ declare type WaterfallKind = 'increase' | 'decrease' | 'total'; /** * One step of a waterfall chart. * * A waterfall answers "how did we get from here to there", so a step carries * two numbers that a bar chart would conflate: the contribution it made * (`delta`) and the running total it produced (`end`). The bar is drawn * floating between `start` and `end`, which is why neither alone describes it * — the height is the contribution and the position is the total. * * `start` and `end` are absolute positions on the value axis, so a producer * that only knows offsets has to accumulate them before emitting, the same * way {@link ErrorBarPoint} fixes absolute bounds. */ declare interface WaterfallPoint { /** The step's label along the category axis. */ x: number | string; /** Running total before this step. */ start: number; /** Running total after this step. */ end: number; /** * The signed contribution, `end - start`. * * Carried rather than derived because a producer may round the two totals * for display, and a delta recomputed from rounded ends is not the number * the chart's own label shows. */ delta: number; /** Whether the step adds, subtracts, or restates the total. */ kind: WaterfallKind; } /** * Configuration for waterfall charts. * Optional when `chartType` is `'waterfall'`. * * The single `yKeys` entry names each step's CONTRIBUTION, and the adapter * accumulates the running totals MAIDR announces — a waterfall bar floats * between the total before the step and the total after it, and neither * number is in the data. This config only says which rows are *not* * contributions: an opening balance, a subtotal, a closing balance. */ declare interface WaterfallStepConfig { /** * Key whose truthy value marks a row as restating the running total rather * than changing it. Such a row sits on the baseline instead of floating, * and a reader told a subtotal "rose by 950" would hear a contribution the * chart never made. * * A restating row's own value becomes the new running total. When it has * none, the accumulated total is used, so a "Closing" row need carry no * number of its own. */ totalKey?: string; /** * Indices of the restating rows, for data that carries no flag column. * A waterfall usually opens and closes on one, so this is commonly * `[0, data.length - 1]`. */ totalIndices?: number[]; /** * Key holding the step kind outright — `'increase'`, `'decrease'` or * `'total'`. Takes precedence over both fields above; without any of the * three, a step is read from the sign of its contribution. */ kindKey?: string; } /** * One term of a word cloud. * * A word cloud is the canonical chart that carries real data while being * readable only by eye: the weight is encoded as glyph size and written down * nowhere on the page. Structurally it is a categorical label and a * magnitude, which is why it needs no shape of its own beyond naming them. */ declare interface WordCloudPoint { /** The term. */ x: string; /** * Its weight -- a frequency, a score, a count. * * Widened to accept a string for the same reason {@link BarPoint.y} is: * hand-authored JSON and some producers send numbers as strings, and the * trace coerces on the way in. Declaring it `number` alone would not stop * one arriving, it would only stop the compiler from admitting it -- and a * string reaching the description's running total would concatenate rather * than add. */ y: number | string; } export { }