@umriss-ui/charts 0.45.0 → 0.47.0

package/dist/de.d.ts

@@ -82,6 +82,9 @@ declare interface ChartsWording {
     /** Added to the caption where the table shows the downsampled course:
      how many readings its rows stand for. */
     downsampled: (readings: number) => string;
+    /** Added to the name of a matrix' legend entry that has a colour bar: the range its colours span, both ends
+     written in the matrix' format. The bar's own values are hidden from assistive technology. */
+    levelRange: (from: string, to: string) => string;
 }
 
 /** The German instance, for a chart's `wording`. Complete, because it is

package/dist/index.d.ts

@@ -50,6 +50,13 @@ export declare interface AreaProps<T> {
      stays whole.
      @default a solid outline */
     dash?: readonly number[];
+    /** The longest step between two readings that is still filled through, in
+     the x axis' units: milliseconds on a time axis, working time on a
+     calendar axis, places on a category axis. A longer step is a gap: the
+     area closes on both sides of it. A pointer farther than this from the
+     nearest reading finds no hit. In a `stack` this is not read.
+     @default no limit, a stretch without rows is bridged */
+    maxGap?: number;
 }
 
 /** An `Area` as the chart holds it once registered. */
@@ -62,6 +69,8 @@ export declare interface AreaSeriesConfig<T = unknown> extends SeriesBase<T>, St
     strokeWidth: number;
     /** Dash pattern of the outline. */
     dash?: readonly number[];
+    /** A step between readings longer than this is a gap; not read in a stack. */
+    maxGap?: number;
 }
 
 /** What the value is, given the limit set. A pure function of the two.
@@ -176,6 +185,12 @@ export declare interface BarProps<T> {
     /** Height - a number field of the row or a function of it;
      null/undefined/NaN/±Infinity means a gap. */
     value: Value<T>;
+    /** Lower edge - a number field of the row or a function of it: the bar
+     floats from here to `value`, either way up. A gap in either edge leaves
+     the bar out. In a `stack` the stack below is the lower edge, and this is
+     not read.
+     @default a fixed baseline at 0 */
+    baseline?: Value<T>;
     /** Binding to an x axis. */
     xAxisId?: string;
     /** Binding to a y axis. */
@@ -213,6 +228,8 @@ export declare interface BarProps<T> {
 /** A `Bar` as the chart holds it once registered. */
 export declare interface BarSeriesConfig<T = unknown> extends SeriesBase<T>, Stackable {
     kind: "bar";
+    /** Lower edge; without a value the fixed baseline 0. */
+    baseline?: ValueFunction<T>;
     /** Width as a fraction of the step; the group shares this fraction. */
     barWidth: number;
 }
@@ -234,9 +251,10 @@ export declare interface Bin {
  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
+ are skipped, as a gap is on a chart. The values may be a typed array
+ (`Float64Array`, `Int32Array`): they are read by index. 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(values: ArrayLike<number | null | undefined>, options?: BinOptions): Bin[];
 
 export declare function bin<T>(rows: readonly T[], value: (row: T) => number | null | undefined, options?: BinOptions): Bin[];
 
@@ -630,6 +648,9 @@ export declare interface ChartsWording {
     /** Added to the caption where the table shows the downsampled course:
      how many readings its rows stand for. */
     downsampled: (readings: number) => string;
+    /** Added to the name of a matrix' legend entry that has a colour bar: the range its colours span, both ends
+     written in the matrix' format. The bar's own values are hidden from assistive technology. */
+    levelRange: (from: string, to: string) => string;
 }
 
 /** How a reader is looking at a chart. Whatever is at its default is absent. */
@@ -816,14 +837,16 @@ export declare function Legend({ placement }: LegendProps): ReactNode;
 
 /** A `Legend` as the chart holds it once registered. */
 export declare interface LegendConfig {
-    placement: "top" | "bottom";
+    placement: "top" | "bottom" | "left" | "right";
 }
 
 /** The props of `Legend`. */
 export declare interface LegendProps {
-    /** Which side of the plot area the legend stands on.
+    /** Which side of the plot area the legend stands on. `"left"` and `"right"` set the entries in a column beside
+     the plot, as wide as the longest name up to a quarter of the chart, scrolling where they do not fit; in a
+     chart narrower than 480 px they stand above the plot, as `"top"`.
      @default "top" */
-    placement?: "top" | "bottom";
+    placement?: "top" | "bottom" | "left" | "right";
 }
 
 /** A bound: a value, a side and a severity. No more - a tolerance band is
@@ -999,6 +1022,13 @@ export declare interface LineProps<T> {
      and jumps there - a target, a digital signal. A gap ends the hold at
      its x. The tooltip reports the sample the hold began with. */
     step?: boolean;
+    /** The longest step between two readings that is still drawn through, in the
+     x axis' units: milliseconds on a time axis, working time on a calendar
+     axis, places on a category axis. A longer step is a gap: the line breaks
+     and a `step` hold ends `maxGap` after its reading. A pointer farther than
+     this from the nearest reading finds no hit on the series.
+     @default no limit, a stretch without rows is bridged */
+    maxGap?: number;
 }
 
 /** A `Line` as the chart holds it once registered. */
@@ -1009,6 +1039,8 @@ export declare interface LineSeriesConfig<T = unknown> extends SeriesBase<T> {
     markers: "auto" | "always" | "never";
     /** Sample-and-hold: each value holds until the next sample. */
     step?: boolean;
+    /** A step between readings longer than this is a gap. */
+    maxGap?: number;
 }
 
 /** The fields of a row whose value is a list of numbers, or absent. */
@@ -1079,7 +1111,8 @@ export declare interface MatrixProps<T> {
      function of it. A missing level is a hole, not a zero. */
     level: Value<T>;
     /** How the level colours a cell: by assessment against limits, or across
-     a gradient.
+     a gradient. A gradient's legend entry shows a colour bar: its steps, with the range's two ends written under
+     them in `format` and the inner edges where they fit. An assessment keeps its three colours.
      @default { kind: "gradient", stops: DEFAULT_GRADIENT } */
     coloring?: MatrixColoring;
     /** Binding to an x axis. */
@@ -1096,6 +1129,13 @@ export declare interface MatrixProps<T> {
      row, not the level.
      @default the built-in number format */
     format?: ValueFormat;
+    /** Each cell writes its level in `format`, in the tick size, in the text
+     colour over a halo of the ground colour - legible on every stop, in both
+     themes and in forced colours. A cell too small for its text is left
+     without one, never truncated; a hole has none. Off by default: a dense
+     heat map would be all clipped text.
+     @default false */
+    labels?: boolean;
 }
 
 /** A `Matrix` as the chart holds it once registered: its base accessor is the
@@ -1108,6 +1148,8 @@ export declare interface MatrixSeriesConfig<T = unknown> extends SeriesBase<T> {
      The base accessor yields the row position, not this level. */
     level: ValueFunction<T>;
     coloring: MatrixColoring;
+    /** Each cell writes its level. */
+    labels?: boolean;
 }
 
 /** One minute in milliseconds. */
@@ -1271,6 +1313,8 @@ export declare interface ResolvedTheme {
     colorOk: string;
     font: string;
     fontMono: string;
+    /** The tick label's size in pixels (`--uc-size-tick`). */
+    sizeTick: number;
     series: readonly string[];
     /** The page is in forced colours: every colour above is a system colour, and
      the chart encodes by marks whatever its `encoding`. */
@@ -1496,6 +1540,11 @@ export declare interface TooltipPoint<T = unknown> {
     yValue: number;
     datum: T;
     index: number;
+    /** The lower edge, where the series has a baseline of its own - a `Bar` or
+     an `Area` outside a stack; `yValue` is the upper one. A stack's foot is no
+     reading and never stands here. A field of its own, as `level` and `box`
+     have (ADR-0011). */
+    baseline?: number;
     /** Only for the matrix: its level, out of the level channel. It stands here and
      not in yValue, because yValue is the position on the y axis - for a matrix
      therefore the row. Putting both into one field would be exactly the

package/dist/wording/de.js

@@ -35,6 +35,7 @@ const r = {
   notch: "Notch",
   count: "n",
   outlierList: (e, n) => `${e.length + n}: ${e.join(", ")}${n > 0 ? ` und ${n} weitere` : ""}`,
+  levelRange: (e, n) => `von ${e} bis ${n}`,
   downsampled: (e) => `Ausgedünnt aus ${e.toLocaleString("de-DE")} Messwerten: erster, kleinster, größter und letzter Wert je Abschnitt.`
 };
 export {