@umriss-ui/charts 0.14.0 → 0.16.0

package/dist/de.d.ts

@@ -11,6 +11,12 @@ declare interface ChartsWording {
     visibleRange: (from: string, to: string) => string;
     /** The summary's lowest and highest value of one series in that stretch. */
     seriesExtent: (name: string, min: string, max: string) => string;
+    /** The summary's labelled limits, each with its value in its axis' format
+     (a band's two edges as one value). */
+    limitList: (limits: readonly {
+        name: string;
+        value: string;
+    }[]) => string;
     /** What is read after a key: the position, then each series with its value
      (and its own x where it stands on another x axis), the emphasised one
      first. */
@@ -26,6 +32,8 @@ declare interface ChartsWording {
     percent: (value: string) => string;
     /** The keys that walk the chart. */
     walkHelp: string;
+    /** The key that reports the Active point - only where `onSelect` is given. */
+    selectHelp: string;
     /** The keys that zoom and pan it - only where the chart can be zoomed. */
     zoomHelp: string;
     /** The keys of the legend's entries - only where it has one to press. */

package/dist/index.d.ts

@@ -224,6 +224,43 @@ export declare interface BarSeriesConfig<T = unknown> extends SeriesBase<T>, Sta
     barWidth: number;
 }
 
+/** A bin, the way it is drawn. */
+export declare interface Bin {
+    /** Lower edge; the bin holds it. */
+    readonly from: number;
+    /** Upper edge; the bin holds it only if it is the last one. */
+    readonly to: number;
+    /** The middle, `(from + to) / 2` - the bar's x. */
+    readonly x: number;
+    /** How many values fall in it. */
+    readonly count: number;
+}
+
+/** Counts values into bins of equal width.
+
+ A value on an edge belongs to the bin that edge starts - `[from, to)` - but
+ the last bin is closed, so the greatest value of a domain is counted and not
+ lost. Values that are not finite (`NaN`, ±Infinity, `null`, `undefined`)
+ are skipped, as a gap is on a chart. Without values there are no bins; with
+ values there is at least one, even when they are all equal. */
+export declare function bin(values: readonly (number | null | undefined)[], options?: BinOptions): Bin[];
+
+export declare function bin<T>(rows: readonly T[], value: (row: T) => number | null | undefined, options?: BinOptions): Bin[];
+
+/** The settings of `bin`. */
+export declare interface BinOptions {
+    /** The width of a bin. Wins over `count`. Without a `domain` the edges are
+     multiples of it. */
+    readonly width?: number;
+    /** About how many bins: the width becomes the next 1-2-5 step, so the number
+     comes out near it and not exactly - with a `domain`, exactly.
+     @default 10 */
+    readonly count?: number;
+    /** The span the bins cover, the first edge on its start and the last on its
+     end. Values outside it are left out, not clamped into the end bins. */
+    readonly domain?: readonly [number, number];
+}
+
 /** The named channels of a box: one number per point, NaN where the median
  is a gap; and its outliers (ADR-0040). */
 export declare interface BoxChannels extends BoxNumbers<Float64Array> {
@@ -349,7 +386,7 @@ export declare type CalendarInput = WorkingCalendar | readonly WorkingInterval[]
 
 /** What `useChart` takes besides the rows: the view to start from and the
  handler that hears every change of it. */
-export declare interface ChartOptions {
+export declare interface ChartOptions<Z = unknown> {
     /** The view to start from, and to go to whenever one differing in content
      from the last is handed in - the same view again changes nothing, and
      what it leaves out is reset; one the chart reported itself, handed back
@@ -361,6 +398,13 @@ export declare interface ChartOptions {
      or to hand another chart as its `initialView`. A pan or zoom is reported
      at most once per frame. Not called for the view the chart starts with. */
     onViewChange?: (view: ChartView) => void;
+    /** The reader chose a point: a click on a hit (a tap too), or Enter on the
+     Active point - the same hit the tooltip's `render` receives. Once per
+     click; the end of a drag does not report, and the second click of a
+     double click does not either. The chart holds no selection and draws
+     none: what is chosen is the application's state. Needs a `<Tooltip>`,
+     which makes the hits; the hit does not travel over `syncId`. */
+    onSelect?: (hit: TooltipHit<Z>) => void;
 }
 
 /** What `useChart` hands back: the chart and its parts, typed at the row `Z`,
@@ -485,6 +529,12 @@ export declare interface ChartsWording {
     visibleRange: (from: string, to: string) => string;
     /** The summary's lowest and highest value of one series in that stretch. */
     seriesExtent: (name: string, min: string, max: string) => string;
+    /** The summary's labelled limits, each with its value in its axis' format
+     (a band's two edges as one value). */
+    limitList: (limits: readonly {
+        name: string;
+        value: string;
+    }[]) => string;
     /** What is read after a key: the position, then each series with its value
      (and its own x where it stands on another x axis), the emphasised one
      first. */
@@ -500,6 +550,8 @@ export declare interface ChartsWording {
     percent: (value: string) => string;
     /** The keys that walk the chart. */
     walkHelp: string;
+    /** The key that reports the Active point - only where `onSelect` is given. */
+    selectHelp: string;
     /** The keys that zoom and pan it - only where the chart can be zoomed. */
     zoomHelp: string;
     /** The keys of the legend's entries - only where it has one to press. */
@@ -1447,6 +1499,7 @@ export declare function Tooltip<T>(props: TooltipProps<T>): null;
 /** A `Tooltip` as the chart holds it once registered. */
 export declare interface TooltipConfig<T = unknown> {
     mode: "x" | "nearest";
+    limits?: boolean;
     render?: (hit: TooltipHit<T>) => ReactNode;
 }
 
@@ -1500,6 +1553,12 @@ export declare interface TooltipPoint<T = unknown> {
 export declare interface TooltipProps<T> {
     /** "x": every series at the x position; "nearest": only the nearest point. */
     mode?: "x" | "nearest";
+    /** Adds a row for every labelled `LimitLine` and `LimitBand` on the hit's y
+     axis - its label and value in that axis' format - to the built-in
+     tooltip, and the same to what a key reads out. Limits are not series and
+     stay out of the tooltip unless asked for.
+     @default false */
+    limits?: boolean;
     /** Render prop for content of one's own. Compared by its source text, like
      `tickFormat` - with the same closure limit.
      @default the built-in tooltip */
@@ -1548,7 +1607,7 @@ export declare function toWorkingTimeClamped(wallClock: number, input: CalendarI
  @returns `Chart`, `XAxis`, `YAxis` and every series kind - each keeps its
  identity over the renders -, the `view`, its `domains` and `hidden`, and
  the setters that change them. */
-export declare function useChart<Z>(rows: readonly Z[], options?: ChartOptions): ChartParts<Z>;
+export declare function useChart<Z>(rows: readonly Z[], options?: ChartOptions<Z>): ChartParts<Z>;
 
 /** A value read from the row (ADR-0048): the name of a number field, compared
  by its name, or a function, compared by its source text (`ValueFunction`). */

package/dist/wording/de.js

@@ -1,13 +1,16 @@
-const r = {
+"use client";
+const i = {
   roleDescription: "Diagramm",
   empty: "Keine Daten",
   seriesList: (e) => `${e.length === 1 ? "1 Serie" : `${e.length} Serien`}: ${e.join(", ")}.`,
   visibleRange: (e, n) => `Von ${e} bis ${n}.`,
   seriesExtent: (e, n, t) => `${e} von ${n} bis ${t}.`,
+  limitList: (e) => `Grenzen: ${e.map((n) => `${n.name} ${n.value}`).join(", ")}.`,
   readout: (e, n) => [`${e}.`, ...n.map((t) => `${t.name} ${t.value}${t.x === "" ? "" : ` bei ${t.x}`}.`)].join(" "),
   stackTotal: "Summe",
   percent: (e) => `${e} %`,
   walkHelp: "Pfeil links und rechts gehen durch die Werte, Pfeil hoch und runter wechseln die Serie, Pos1 und Ende springen zum ersten und letzten Wert, Escape hebt die Markierung auf.",
+  selectHelp: "Enter wählt den Punkt.",
   zoomHelp: "Plus und Minus zoomen, Umschalt mit Pfeil links oder rechts verschiebt, 0 kehrt zum eigenen Bereich der Achse zurück.",
   legendHelp: "In der Legende blendet Enter eine Serie aus oder ein, Umschalt+Enter zeigt nur sie.",
   allShown: "Sonst wäre nichts mehr zu sehen, darum werden alle Serien gezeigt.",
@@ -31,5 +34,5 @@ const r = {
   downsampled: (e) => `Ausgedünnt aus ${e.toLocaleString("de-DE")} Messwerten: erster, kleinster, größter und letzter Wert je Abschnitt.`
 };
 export {
-  r as GERMAN_CHARTS_WORDING
+  i as GERMAN_CHARTS_WORDING
 };