@fasl-work/caos-app-shell 0.18.0 → 0.19.0

package/dist/chart.d.ts

@@ -1,10 +1,24 @@
 import * as react from 'react';
 import uPlot from 'uplot';
-import { F as FormatOptions, S as ShellColorToken } from './text-DyQ1A8oo.js';
-export { r as referenceLineName } from './text-DyQ1A8oo.js';
+import { F as FormatOptions, S as ShellColorToken } from './tokens-BvU9bFPw.js';
+export { r as referenceLineName, a as repeatedLabels } from './tokens-BvU9bFPw.js';
 import { B as BiText, L as Lang } from './text-BlY47nIt.js';
 import 'zustand';
 
+/**
+ * The pure rules of the interactions every shell chart carries (Tier A of the interactive-visualization rubric, shell 0.19.0):
+ * zoom and pan of a range, the keys of the keyboard model, the window of categories a bar chart shows, the text a screen
+ * reader gets, and the thinning of a long table. Nothing here touches the DOM, so each rule is tested in node.
+ */
+
+/** A placed mark label, in device pixels: the box its text occupies (`y1` is the baseline). */
+interface LabelBox {
+    x0: number;
+    y0: number;
+    x1: number;
+    y1: number;
+}
+
 interface ChartSeries {
     /** What identifies the series to the solo key (0.18.0): the solo follows the series with this id when the list of series
      * changes (one dropped, one added, a label changed), not its position. Without an id the English label is the key. Unique
@@ -116,6 +130,15 @@ interface UPlotChartProps {
      * other series (alpha 0.12, 1 px) and leaves the chosen one as drawn; pressing it again releases it, pressing another
      * moves the solo. The chart is redrawn, not rebuilt. A chart of one series shows the key too. Off by default. */
     solo?: boolean;
+    /** The chart's accessible name and the name of its data table (0.19.0); by default the y axis by the x axis. */
+    title?: BiText;
+    /** Zoom and pan the y axis too (0.19.0): the wheel, the pinch, the brush and the keys then work on both axes (a parity plot
+     * always does, its two axes share one range). Off by default: x zooms and y follows the visible data. */
+    zoomY?: boolean;
+    /** Turn zoom, pan and the brush off (0.19.0), with the reason, in both languages when the page is bilingual (a chart whose
+     * range is the finding). It names a reason of at least 12 characters, or the gate fails it; the gate lists every chart that
+     * sets it. The keyboard crosshair, the readout, the data table and the summary cannot be turned off. */
+    zoomOff?: BiText;
 }
 /** The alpha a series takes when another one is soloed (0.18.0; what CAOS_Fragmenta's key did). */
 declare const SOLO_DIM_ALPHA = 0.12;
@@ -206,14 +229,22 @@ declare function overlayExtent(series: readonly ChartSeries[], positiveX?: boole
     x: [number, number];
     y: [number, number];
 } | null;
-/** How many tick labels repeat the label before them (empty labels apart); the gate fails a chart with any (G6). */
-declare function repeatedLabels(labels: readonly (string | null | undefined)[]): number;
+/** A placed mark label, in device pixels: its box (`y1` is the baseline), the kind of mark, the text drawn and the whole text it stands for. */
+interface MarkBox extends LabelBox {
+    kind: 'x' | 'y';
+    text: string;
+    full: string;
+}
 /**
  * The vertical marks of a chart and their labels. Every label is drawn with an explicit alignment (uPlot leaves the
  * context right-aligned after its last axis, so a label meant to start at its line ended there and ran off the plot
  * near the left edge, CAOS_Fragmenta 2026-10-06), on the side of its line where it fits inside the plot, on the next
- * row down when it would overlap the label before it, with a halo in the surface colour so a curve under it does not
+ * row down when it would overlap a label before it, with a halo in the surface colour so a curve under it does not
  * cross its letters. A mark outside the x range is not drawn.
+ *
+ * Since 0.19.0 the labels of x marks and of y marks share one set of boxes (`boxes`, to which `drawYMarks` adds its own first): no x
+ * label lies over a y label or another x label. A label for which no row inside the plot has room is cut with an ellipsis, and one
+ * that fits nowhere is not written; the whole texts of those are returned, and every label placed is added to `boxes`.
  */
 declare function drawMarks(u: uPlot, marks: {
     x: number;
@@ -222,11 +253,13 @@ declare function drawMarks(u: uPlot, marks: {
     color: string;
     halo: string;
     family: string;
-}): void;
+}, boxes?: MarkBox[]): string[];
 /**
  * The horizontal reference lines of a chart and their labels: a dashed line across the plot, its label at the right
  * end above the line (below it when the line runs along the top), inside the plot, haloed; a label that would overlap
- * the one placed before it moves left of it. A line outside the y range is not drawn; a line without a label is drawn alone. A mark's `color` (the tone's) draws
+ * the one placed before it moves left of it, then to the other side of its line or a row further, and is cut with an ellipsis when no place
+ * clears (`placeYLabel`; `boxes`, when given, collects what is placed, for `drawMarks` to avoid). Returns the whole texts of the labels it cut
+ * or could not write. A line outside the y range is not drawn; a line without a label is drawn alone. A mark's `color` (the tone's) draws
  * its line and its label; without one `style.color` does.
  */
 declare function drawYMarks(u: uPlot, marks: {
@@ -237,7 +270,7 @@ declare function drawYMarks(u: uPlot, marks: {
     color: string;
     halo: string;
     family: string;
-}): void;
+}, boxes?: MarkBox[]): string[];
 /**
  * The index of the point nearest (left, top) in the plane, over every series, or null when no point has a value.
  * `xs` and every column of `ys` are positions in the same pixels as (left, top); a null position is no point.
@@ -256,6 +289,6 @@ declare function nearestPoint(xs: readonly number[], ys: readonly (readonly (num
  * 0.18.0: named x ticks (`x.ticks`, declared in `data-x-tick-labels`), an x range (`x.range`), a key that solos a series
  * (`solo`, declared in `data-solo`), dots on a line (`ChartSeries.dots`) and reference lines without a label.
  */
-declare function UPlotChart({ x, y, series, marks, yMarks, onYMarkChange, height, onCursor, onPick, parity, readout, hint, solo }: UPlotChartProps): react.JSX.Element;
+declare function UPlotChart({ x, y, series, marks, yMarks, onYMarkChange, height, onCursor, onPick, parity, readout, hint, solo, title, zoomY, zoomOff }: UPlotChartProps): react.JSX.Element;
 
-export { type ChartAxis, type ChartSeries, type ChartTick, LOG_TABLE_FLOOR, SOLO_DIM_ALPHA, UPlotChart, type UPlotChartProps, YMARK_TONE_TOKENS, type YMarkDrag, type YMarkTone, clampMark, decadeOnly, drawMarks, drawYMarks, logDecades, namedRepeats, nearestPoint, nudgeMark, overlayExtent, parityBox, parityRange, rangeWithLevels, repeatedLabels, seriesStyle, smallestPositive, soloKey, soloStyle, sortOrder, tickLabelAt, tickSplits, tickSteps, xScaleRange };
+export { type ChartAxis, type ChartSeries, type ChartTick, LOG_TABLE_FLOOR, SOLO_DIM_ALPHA, UPlotChart, type UPlotChartProps, YMARK_TONE_TOKENS, type YMarkDrag, type YMarkTone, clampMark, decadeOnly, drawMarks, drawYMarks, logDecades, namedRepeats, nearestPoint, nudgeMark, overlayExtent, parityBox, parityRange, rangeWithLevels, seriesStyle, smallestPositive, soloKey, soloStyle, sortOrder, tickLabelAt, tickSplits, tickSteps, xScaleRange };