@umriss-ui/charts 0.8.1 → 0.9.0

package/dist/de.d.ts

@@ -37,6 +37,22 @@ declare interface ChartsWording {
     rowColumn: string;
     /** The table's caption: the visible stretch it lists, both ends formatted. */
     tableCaption: (from: string, to: string) => string;
+    /** A box's numbers, top to bottom as drawn: the tooltip's rows, the
+     readout's parts and the data table's columns (box-plot B9). */
+    upperWhisker: string;
+    upperQuartile: string;
+    median: string;
+    lowerQuartile: string;
+    lowerWhisker: string;
+    /** A box's outliers: the row's name, and the row's value - their count and
+     the first few values, the rest counted (box-plot B9). */
+    outliers: string;
+    /** A box's optional readings: its mean, its notch's two bounds as one row,
+     and how many values stand behind it. */
+    mean: string;
+    notch: string;
+    count: string;
+    outlierList: (values: readonly string[], more: number) => string;
     /** Added to the caption where the table shows the downsampled course (C2):
      how many readings its rows stand for. */
     downsampled: (readings: number) => string;

package/dist/index.d.ts

@@ -190,6 +190,115 @@ export declare interface BarSeriesConfig<T = unknown> extends SeriesBase<T>, Sta
     barWidth: 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> {
+    /** Every box's outliers, flat, box after box; null without `outliers`. */
+    outliers: Float64Array | null;
+    /** Where each box's outliers begin, and one past the last: box i's stand
+     from outlierOffsets[i] to outlierOffsets[i + 1]. null without
+     `outliers`. */
+    outlierOffsets: Uint32Array | null;
+    /** The optional numbers, each null where not given. */
+    mean: Float64Array | null;
+    notchLower: Float64Array | null;
+    notchUpper: Float64Array | null;
+    count: Float64Array | null;
+}
+
+/** The optional numbers of a box (box-plot 04), by name. */
+export declare interface BoxExtras<V = number> {
+    mean: V;
+    notchLower: V;
+    notchUpper: V;
+    count: V;
+}
+
+/** A box's further numbers beside its median, by name. */
+export declare interface BoxNumbers<V = number> {
+    lowerQuartile: V;
+    upperQuartile: V;
+    lowerWhisker: V;
+    upperWhisker: V;
+}
+
+export declare function BoxPlot<T>(props: BoxPlotProps<T>): null;
+
+export declare interface BoxPlotProps<T> {
+    /** The line across the box; null/undefined/NaN/±Infinity means a gap - no
+     box is drawn there, whatever the other numbers say (R-2.5). */
+    median: Accessor<T>;
+    /** The box's lower edge. */
+    lowerQuartile: Accessor<T>;
+    /** The box's upper edge. */
+    upperQuartile: Accessor<T>;
+    /** Where the lower whisker ends - the caller's rule, not the minimum. */
+    lowerWhisker: Accessor<T>;
+    /** Where the upper whisker ends - the caller's rule, not the maximum. */
+    upperWhisker: Accessor<T>;
+    /** The values beyond the whiskers, per box: an array, empty or missing
+     where there are none. Drawn with their box in its colour - one beyond
+     three IQR of the box's own quartiles as a ring -, read in its tooltip
+     and table row, never hit on their own (ADR-0040). */
+    outliers?: ListAccessor<T>;
+    /** The mean, drawn as a small ×: beside the median it shows a skew. */
+    mean?: Accessor<T>;
+    /** The notch's lower bound - usually of a confidence interval of the
+     median. Both bounds or neither: one alone warns in DEV and is not
+     drawn. */
+    notchLower?: Accessor<T>;
+    /** The notch's upper bound; see `notchLower`. */
+    notchUpper?: Accessor<T>;
+    /** How many values stand behind the box; read in the tooltip and the
+     table, not drawn. */
+    count?: Accessor<T>;
+    /** Binding to an x axis (R-4.12). */
+    xAxisId?: string;
+    /** Binding to a y axis (R-4.12). */
+    yAxisId?: string;
+    /** Series-own data; overrides the container data (R-2.4). */
+    data?: readonly T[];
+    /** The name in legend and tooltip. Without one the series is called
+     "Series n" and a warning stands in DEV. */
+    name?: string;
+    /** Not drawn, not hit and not counted for its axes' extent. Its legend
+     entry stays, drawn back. Controlled, typically from `Legend onToggle`. */
+    hidden?: boolean;
+    /** Every number of the box as the tooltip and the table write it; without
+     one the y axis' `tickFormat`, then the default. */
+    format?: (value: number) => string;
+    /** Any CSS colour value; without one the palette --uc-series-N. */
+    color?: string;
+    /** A role instead of a colour value; the theme resolves it. `color` beats
+     it. Set by the caller: a box out of its specification is the caller's
+     judgement, not the library's. */
+    tone?: "ok" | "warning" | "alarm";
+    /** Width as a fraction of the step, as a bar's: boxes and bars on one x axis
+     share this fraction and stand side by side. */
+    boxWidth?: number;
+}
+
+/** A box plot (CONTEXT.md: Box). The base accessor is the median; the four
+ further numbers are the caller's, computed by whatever method the caller
+ chose - the library draws them and computes none. */
+export declare interface BoxSeriesConfig<T = unknown> extends SeriesBase<T> {
+    kind: "box";
+    lowerQuartile: Accessor<T>;
+    upperQuartile: Accessor<T>;
+    lowerWhisker: Accessor<T>;
+    upperWhisker: Accessor<T>;
+    /** The values beyond the whiskers, per box (ADR-0040). */
+    outliers?: ListAccessor<T>;
+    mean?: Accessor<T>;
+    /** Both bounds or neither (CONTEXT.md: Notch). */
+    notchLower?: Accessor<T>;
+    notchUpper?: Accessor<T>;
+    /** How many values stand behind the box; no y value. */
+    count?: Accessor<T>;
+    /** Width as a fraction of the step; boxes and bars on one x axis share it. */
+    boxWidth: number;
+}
+
 /** The breaks in working time that lie within the extent [from, to] - what the
  axis must mark, in domain units. */
 export declare function breaks(input: CalendarInput, from: number, to: number): number[];
@@ -297,6 +406,22 @@ export declare interface ChartsWording {
     rowColumn: string;
     /** The table's caption: the visible stretch it lists, both ends formatted. */
     tableCaption: (from: string, to: string) => string;
+    /** A box's numbers, top to bottom as drawn: the tooltip's rows, the
+     readout's parts and the data table's columns (box-plot B9). */
+    upperWhisker: string;
+    upperQuartile: string;
+    median: string;
+    lowerQuartile: string;
+    lowerWhisker: string;
+    /** A box's outliers: the row's name, and the row's value - their count and
+     the first few values, the rest counted (box-plot B9). */
+    outliers: string;
+    /** A box's optional readings: its mean, its notch's two bounds as one row,
+     and how many values stand behind it. */
+    mean: string;
+    notch: string;
+    count: string;
+    outlierList: (values: readonly string[], more: number) => string;
     /** Added to the caption where the table shows the downsampled course (C2):
      how many readings its rows stand for. */
     downsampled: (readings: number) => string;
@@ -615,6 +740,10 @@ export declare interface LineSeriesConfig<T = unknown> extends SeriesBase<T> {
     step?: boolean;
 }
 
+/** A list per datum - a box's outliers (ADR-0040). null/undefined or an
+ empty array is none; a value that is not finite is left out. */
+export declare type ListAccessor<T> = (d: T, index: number) => readonly number[] | null | undefined;
+
 /** The local offset at an instant, as the shift of a grid that is to lie on
  local time: `wallClock = offset + k · step`. Taken at one instant, it holds
  for a grid up to the next clock change. */
@@ -638,6 +767,9 @@ export declare interface MaterializedSeries {
      carry does not belong in the shared type with a comment (ADR-0011). null
      for every kind that does not use it. */
     w: Float64Array | null;
+    /** A box's further numbers beside its median in y; null for every other
+     kind (ADR-0011). */
+    box: BoxChannels | null;
     length: number;
 }
 
@@ -942,7 +1074,7 @@ export declare interface SeriesBase<T = unknown> {
     hidden?: boolean;
 }
 
-export declare type SeriesConfig<T = unknown> = LineSeriesConfig<T> | AreaSeriesConfig<T> | BarSeriesConfig<T> | ScatterSeriesConfig<T> | StateSeriesConfig<T> | MatrixSeriesConfig<T>;
+export declare type SeriesConfig<T = unknown> = LineSeriesConfig<T> | AreaSeriesConfig<T> | BarSeriesConfig<T> | BoxSeriesConfig<T> | ScatterSeriesConfig<T> | StateSeriesConfig<T> | MatrixSeriesConfig<T>;
 
 export declare type SeriesKind = SeriesConfig["kind"];
 
@@ -1074,6 +1206,12 @@ export declare interface TooltipPoint<T = unknown> {
         to: number;
         label: string;
     };
+    /** Only for a box: its further numbers; yValue is its median. Fields of
+     their own for the reason `value` has one (ADR-0011). */
+    box?: BoxNumbers & Partial<BoxExtras> & {
+        /** As the caller gave them; only where the series has `outliers`. */
+        outliers?: readonly number[];
+    };
 }
 
 export declare interface TooltipProps<T> {
@@ -1215,8 +1353,10 @@ export declare function workingTimeTicks(input: CalendarInput, from: number, to:
 export declare function XAxis<T>(props: XAxisProps<T>): null;
 
 export declare interface XAxisProps<T> extends CommonProps_2<T> {
-    /** `"nice"` widens the data's extent to ticks, `"data"` keeps it, a pair is
-     fixed - the one a zoom passes back. */
+    /** `"nice"` widens the data's extent to ticks - to named `ticks` where
+     there are any, on a time axis to whole units of a step of hours or
+     longer -, `"data"` keeps it, a pair is fixed - the one a zoom passes
+     back. */
     domain?: "nice" | "data" | readonly [number, number];
     /** Which edge the axis stands at. A second x axis on the opposite edge is how
      a series counts in a unit of its own. */

package/dist/wording/de.js

@@ -1,10 +1,10 @@
-const i = {
+const n = {
   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}.`,
-  readout: (e, n) => [`${e}.`, ...n.map((t) => `${t.name} ${t.value}${t.x === "" ? "" : ` bei ${t.x}`}.`)].join(" "),
+  visibleRange: (e, t) => `Von ${e} bis ${t}.`,
+  seriesExtent: (e, t, i) => `${e} von ${t} bis ${i}.`,
+  readout: (e, t) => [`${e}.`, ...t.map((i) => `${i.name} ${i.value}${i.x === "" ? "" : ` bei ${i.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.",
@@ -13,9 +13,20 @@ const i = {
   hideData: "Daten verbergen",
   positionColumn: "Position",
   rowColumn: "Zeile",
-  tableCaption: (e, n) => `Werte von ${e} bis ${n}.`,
+  tableCaption: (e, t) => `Werte von ${e} bis ${t}.`,
+  upperWhisker: "Oberer Whisker",
+  upperQuartile: "Oberes Quartil",
+  median: "Median",
+  lowerQuartile: "Unteres Quartil",
+  lowerWhisker: "Unterer Whisker",
+  outliers: "Ausreißer",
+  mean: "Mittelwert",
+  // As "Whisker": the term of the trade, not "Kerbe" (CONTEXT.md: Notch).
+  notch: "Notch",
+  count: "n",
+  outlierList: (e, t) => `${e.length + t}: ${e.join(", ")}${t > 0 ? ` und ${t} weitere` : ""}`,
   downsampled: (e) => `Ausgedünnt aus ${e.toLocaleString("de-DE")} Messwerten: erster, kleinster, größter und letzter Wert je Abschnitt.`
 };
 export {
-  i as GERMAN_CHARTS_WORDING
+  n as GERMAN_CHARTS_WORDING
 };