@eifi1/ui-kit 0.33.1 → 0.35.0

package/dist/components/series-chart.d.ts

@@ -1,113 +1,16 @@
-import * as react from 'react';
-import { ReactNode, RefObject } from 'react';
-import { ZoomAxesSetting, ZoomBinding } from './chart-zoom.js';
-import { LegendEntry } from './toggle-legend.js';
-import { SeriesChartLabels } from './series-chart-labels.js';
-import { TimeTickUnit } from './series-chart-ticks.js';
-import { SeriesChartAxisBudget } from './series-chart-budget.js';
-import { c6 as ChartTooltipPlacement } from '../delete-account-setting-DAgGBrbn.js';
-import { ChartHeight } from './chart-height.js';
-import 'recharts';
-import './tooltip.js';
-import '../hooks/use-anchored-rect.js';
-import '../lib/clipping.js';
-import '../data-table-labels-BJ5JE_X2.js';
-import './data-table-sort.js';
-import './swipeable-row.js';
-import './status-dot.js';
-import './progress-bar.js';
-import './signed-amount.js';
-import './stat-tile.js';
-import './chip.js';
-import 'lucide-react';
-import './field-parts.js';
-import './write-lock.js';
-import './mini-calendar.js';
-import './calendar-heatmap.js';
-import './popover.js';
-import '../hooks/use-breakpoint.js';
-import './field-sync.js';
-import '../wizard/types.js';
-import '../tour/tour.js';
-import '../search/command-palette.js';
-import '../search/global-search.js';
-import '../search/search-index.js';
-import './month-picker.js';
-import './page-contents.js';
-import './pie-chart-labels.js';
-import './sparkline.js';
-import './signature-pad.js';
-import './password-strength.js';
-import './swatch-picker.js';
-import './tile-radio.js';
-import './icon-picker.js';
-import './dialog-frame.js';
-import './modal.js';
-import '../hooks/use-search-param-state.js';
-import './measured-grid.js';
-import './user-avatar.js';
-import '../lib/person-name.js';
-import '../shell/topbar-action-menu.js';
-import './menu-item.js';
-import './floating-panel.js';
-import '../hooks/use-authed-src.js';
-import './account-settings-labels.js';
-import './bulk-action-bar.js';
-import './list.js';
-import './breadcrumbs.js';
-import './toast.js';
-import './description-list.js';
-import './line-items.js';
-import './error-boundary.js';
-import './authed-image.js';
-import './image-grid.js';
-import './lightbox.js';
-import '../auth/sign-in-form.js';
-import '../landing/access.js';
-import '../landing/landing-labels.js';
-import '../shell/topbar-controls.js';
-import '../theme/palette-presets.js';
-import '../theme/chart-palette.js';
-import '../theme/theme-store.js';
-import 'zustand/middleware';
-import 'zustand';
-import '../auth/complete-name-dialog.js';
-import '../auth/forgot-password-form.js';
-import '../auth/status-parts.js';
-import '../auth/reset-password-form.js';
-import '../auth/verify-email.js';
-import '../auth/not-found-page.js';
-import '../auth/accept-invitation.js';
-import '../shell/company-switcher.js';
-import '../account/email-change-setting.js';
-import '../account/sessions-setting.js';
-import '../lib/format.js';
-import '../account/data-export-setting.js';
-import './account-chips.js';
-import '../admin/admin-parts.js';
-import '../admin/admin-action-log.js';
-import '../settings/settings-labels.js';
-import '../demo/demo-labels.js';
-import '../i18n/plurals.js';
-import './appearance-labels.js';
-import '../theme/contrast.js';
-import '../theme/text-size.js';
-import './reauth-dialog.js';
-import './server-wake.js';
-import '../lib/server-wake.js';
-import './translation-review-labels.js';
-import '../lib/translation-review.js';
-import './country-select.js';
-import './inline-edit-field.js';
-import '../lib/iban.js';
-import '../lib/phone.js';
-import './sign-chip.js';
-import './column-mapper.js';
-import '../lib/column-mapping.js';
-import '../lib/table-text.js';
-import './focus-ring.js';
-
-interface SeriesChartSeries {
+import type { ReactNode, RefObject } from "react";
+import { type ZoomAxesSetting, type ZoomBinding } from "./chart-zoom-core.js";
+import { type LegendEntry } from "./toggle-legend.js";
+import { type SeriesChartLabels } from "./series-chart-labels.js";
+import { type TimeTickUnit } from "./series-chart-ticks.js";
+export type { TimeTickUnit } from "./series-chart-ticks.js";
+import { type SeriesChartAxisBudget } from "./series-chart-budget.js";
+export type { SeriesChartAxisBudget } from "./series-chart-budget.js";
+export { AXIS_TICK_WIDTH, AXIS_TITLE_STRIP, anchoredBand, axisBandWidth, mergeSeries, oneAxis, padBand, paddedDomain, seriesKey, soleSeriesColor, visibleSeries, } from "./series-chart-axes.js";
+export type { SeriesSource } from "./series-chart-axes.js";
+import { type ChartTooltipPlacement, type LabelOverride } from "../i18n/kit-labels.js";
+import { type ChartHeight } from "./chart-height.js";
+export interface SeriesChartSeries {
     /** The row key this line reads — and the `--color-<key>` it is painted with, so it
      *  must be a CSS identifier. Build keys out of data with {@link seriesKey}. */
     key: string;
@@ -190,9 +93,9 @@ interface SeriesChartSeries {
     minBarLength?: number;
 }
 /** What a series draws. See {@link SeriesChartSeries.type}. */
-type SeriesChartType = "line" | "bar" | "area";
+export type SeriesChartType = "line" | "bar" | "area";
 /** One point of a series, as a `dot` function is handed it. */
-interface SeriesChartPoint {
+export interface SeriesChartPoint {
     /** The series' key. */
     key: string;
     /** The row's position in `rows`. */
@@ -211,13 +114,13 @@ interface SeriesChartPoint {
 /** A row of a series chart: one abscissa value and the series' values at it. Anything
  *  else in it (a raw ISO period for a drilldown) rides along untouched and is handed
  *  back in {@link SeriesChartPoint.row} and {@link SeriesChartHit.row}. */
-type SeriesChartRow = Readonly<Record<string, unknown>>;
+export type SeriesChartRow = Readonly<Record<string, unknown>>;
 /** An abscissa value: a number (`x.type: "number"`), a category (a string, a number or
  *  a Date standing for a period), or a time (a Date, epoch ms or an ISO string). */
-type SeriesChartXValue = number | string | Date;
+export type SeriesChartXValue = number | string | Date;
 /** Ticks a caller decides — a list, or a function of the domain on show, so a zoom
  *  window gets ticks from the same rule instead of none. */
-type SeriesChartTickValues<T> = readonly T[] | ((domain: [number, number]) => readonly T[] | undefined);
+export type SeriesChartTickValues<T> = readonly T[] | ((domain: [number, number]) => readonly T[] | undefined);
 interface SeriesChartAxisShape {
     id: string;
     /**
@@ -292,7 +195,7 @@ interface SeriesChartAxisShape {
  * pair, whose neighbour already said it). A HIDDEN axis scales its lines and draws
  * nothing, so there is nowhere for a title to go.
  */
-type SeriesChartAxis = SeriesChartAxisShape & ({
+export type SeriesChartAxis = SeriesChartAxisShape & ({
     title: string;
     hide?: false;
 } | {
@@ -304,7 +207,7 @@ type SeriesChartAxis = SeriesChartAxisShape & ({
  * the value in the caller's own terms, which on a category or time axis is not the
  * number the plot runs on.
  */
-interface SeriesChartXTick {
+export interface SeriesChartXTick {
     /** The number itself, the row's category, or (time) a Date. */
     value: SeriesChartXValue;
     /** The slot, on a category axis: the row's index in `rows`. */
@@ -313,7 +216,7 @@ interface SeriesChartXTick {
      *  as it means — a month start as "Mar 26", a midnight as "14 Mar". */
     unit?: TimeTickUnit;
 }
-interface SeriesChartX {
+export interface SeriesChartX {
     /**
      * What the abscissa is.
      *
@@ -388,14 +291,14 @@ interface SeriesChartX {
     integerTicks?: boolean;
 }
 /** Where the tooltip goes — see {@link SeriesChartTooltip.placement}. */
-type SeriesChartTooltipPlacement = ChartTooltipPlacement;
+export type SeriesChartTooltipPlacement = ChartTooltipPlacement;
 /**
  * The placement a chart actually uses: its own, else the provider's, else `"cursor"`;
  * `"auto"` is `"above"` on a phone (`phone`: below `sm`) and `"cursor"` from `sm` up.
  */
-declare function resolveTooltipPlacement(own: SeriesChartTooltipPlacement | undefined, fromProvider: SeriesChartTooltipPlacement | undefined, phone: boolean): "cursor" | "above" | "below";
+export declare function resolveTooltipPlacement(own: SeriesChartTooltipPlacement | undefined, fromProvider: SeriesChartTooltipPlacement | undefined, phone: boolean): "cursor" | "above" | "below";
 /** Room for the tooltip beyond the chart — see {@link SeriesChartProps.tooltip}. */
-interface SeriesChartTooltip {
+export interface SeriesChartTooltip {
     /**
      * Where the values under the pointer are shown (keksdose #359: on a phone the box
      * sat under the finger, on the very data it was reporting).
@@ -438,7 +341,7 @@ interface SeriesChartTooltip {
  * turnarounds of a hysteresis loop, where the abscissa stands still while the value
  * falls from one branch to the other.
  */
-interface SeriesChartSpan {
+export interface SeriesChartSpan {
     /** Distinct within the chart. */
     key: string;
     /** Which y axis `from`/`to` are measured on. Default `"y"`. */
@@ -451,7 +354,7 @@ interface SeriesChartSpan {
 }
 /** The colours a reference or a marker can take by name — the kit's semantic tokens,
  *  so a threshold reads the same on every chart and flips with the theme. */
-type SeriesChartTone = "muted" | "brand" | "income" | "expense" | "net" | "success" | "warning" | "danger" | "info";
+export type SeriesChartTone = "muted" | "brand" | "income" | "expense" | "net" | "success" | "warning" | "danger" | "info";
 /**
  * A line across the whole plot at one value: a threshold, a target, an event.
  *
@@ -463,7 +366,7 @@ type SeriesChartTone = "muted" | "brand" | "income" | "expense" | "net" | "succe
  * it, because a threshold the reader cannot see is not a threshold. A pinned domain or a
  * zoom window does not widen — there it is discarded when outside, like a span.
  */
-interface SeriesChartReference {
+export interface SeriesChartReference {
     /** Distinct within the chart. Default: its position in the list. */
     key?: string;
     /** `"x"` for a vertical line at an abscissa, otherwise the id of the y axis the value
@@ -487,7 +390,7 @@ interface SeriesChartReference {
  * use the series' `dot` instead; a marker is for a point that is a fact of its own.
  * Fitted like a reference: it widens the band it would otherwise fall outside of.
  */
-interface SeriesChartMarker {
+export interface SeriesChartMarker {
     /** Distinct within the chart. Default: its position in the list. */
     key?: string;
     /** In the x axis' own terms, like a reference's `value`. */
@@ -504,7 +407,7 @@ interface SeriesChartMarker {
     r?: number;
 }
 /** What a click on the plot picked. */
-interface SeriesChartHit {
+export interface SeriesChartHit {
     /** The row's position in `rows`. */
     index: number;
     /** The caller's own row — with its `rawPeriod`, id or whatever the drilldown needs. */
@@ -514,7 +417,7 @@ interface SeriesChartHit {
      *  (the period), not a series. */
     key?: string;
 }
-interface SeriesChartProps {
+export interface SeriesChartProps {
     /** One row per abscissa value. A missing key is a hole (see `connectNulls`). */
     rows: readonly SeriesChartRow[];
     series: SeriesChartSeries[];
@@ -612,7 +515,7 @@ interface SeriesChartProps {
     /** Supplied by `withChartZoom` and by nothing else. */
     zoom?: ZoomBinding;
     /** Per-chart strings over `<UiKitProvider labels={{ seriesChart }}>`. */
-    labels?: Partial<SeriesChartLabels>;
+    labels?: LabelOverride<SeriesChartLabels>;
     /** BCP 47 tag for the default number formats. Default: the provider's. */
     locale?: string;
     /** Onto the chart's root (`ChartContainer`) — e.g. an app's own grid ink. */
@@ -621,89 +524,38 @@ interface SeriesChartProps {
      *  {@link SeriesChartSeries.minBarLength}. Drawing only: domain, tooltip and names
      *  keep the real value. Default: none — a zero draws nothing. */
     minBarLength?: number;
+    /**
+     * The most rows the chart hands recharts (0.34, KS U2). A longer table is THINNED, by
+     * envelope: cut into buckets, and from each the row where each drawn series is lowest
+     * and the row where it is highest, plus each series' first and last sample — so every
+     * line still reaches every peak and dip the table has, and a tone faster than the
+     * buckets draws as the band it fills, never as the slow wave a stride would alias it
+     * into. Nothing is averaged or invented; every point drawn is one of `rows`. There is
+     * no stride option, on purpose.
+     *
+     * Opt-in. Default: none — every row is drawn, as before. Kurvenschmiede draws 2000 for
+     * a 200-second profile at 1 kHz; a few thousand is about what a plot's pixels can show.
+     *
+     * - **Zoom** thins the window on show (with one row past each edge), so zooming in
+     *   draws more of the samples there — all of them, once the window holds fewer than
+     *   `maxRows` — rather than the same rows larger. That needs an abscissa that never
+     *   decreases; where it doubles back (a loop against position) the whole table is
+     *   thinned once, and the abscissa is enveloped too, so the path's turning points stay.
+     * - **Fitting** is not thinned: the axes, the zoom's refit and the automatic whole
+     *   ticks read every row, so a pinned or fitted band is the same either way.
+     * - **Indices** stay the caller's: a `dot` function's `point.index` and a click's
+     *   `hit.index` are positions in `rows`, not in the rows drawn.
+     * - **A category axis** (`x.type: "category"`) is never thinned: a slot is a period, and
+     *   a period left out is a gap. Meant for lines and areas; stacked layers are each
+     *   enveloped on their own.
+     *
+     * The budget is a cap for any `maxRows` of at least 2 + 4 × the drawn series (the
+     * fewest rows an envelope can be drawn with); a smaller one is raised to that.
+     */
+    maxRows?: number;
 }
-/** How much of an axis band the rotated title takes, in px at Normal — × the text size's
- *  scale on the chart (§3.2), since the title is text. Reserved rather than shared with
- *  the ticks: a title merely offset inside the band prints on top of a five-figure tick,
- *  and which gives way depends on the data. */
-declare const AXIS_TITLE_STRIP = 16;
-/** The width the ticks of a y axis get when a caller does not say, in px at Normal. */
-declare const AXIS_TICK_WIDTH = 48;
-/** The band a fitted axis draws, padded — and a real band for constant data, which is
- *  a zero-height domain recharts cannot scale into. `undefined` when nothing finite. */
-declare function paddedDomain(values: Iterable<number>): [number, number] | undefined;
-/**
- * {@link paddedDomain} for a caller that has already walked its own data — so a row
- * of charts can share one scale without building an array to find two numbers in, and
- * without a second padding rule. `low > high` means "nothing was seen": `undefined`.
- */
-declare function padBand(low: number, high: number): [number, number] | undefined;
-/**
- * The whole band a y axis occupies: its ticks, and its title when it draws one. For
- * lining a heading up over a PLOT rather than over its column.
- *
- * `scale` is the text size's (`useTextSize().scale`, §3.2, §10.10): the chart draws every
- * band — the default 48 px and a caller's own `width` alike (keksdose's
- * `MONEY_AXIS_WIDTH`) — this many times wider, because the ticks in it are `text-xs`
- * and grow with the text. A heading lined up over the plot has to pass the same scale.
- * One factor for both sides of a facing pair, so the mirrored bands stay equal.
- */
-declare function axisBandWidth(tickWidth: number | undefined, titled: boolean, scale?: number): number;
-/**
- * The colour an axis TITLE takes, or `undefined` for the neutral one.
- *
- * An axis measuring exactly one line is that line's, and saying so in the title lets a
- * reader find a channel's scale without counting axes. An axis measuring several is
- * nobody's — a title in the first one's colour would be claiming it. Counted off the
- * series, so toggling a second line onto an axis gives the colour up in the same render.
- */
-declare function soleSeriesColor(axis: Pick<SeriesChartAxisShape, "id" | "color">, series: readonly Pick<SeriesChartSeries, "axis">[]): string | undefined;
-/** The single-axis case, which is most charts. `width` is what the TICKS need;
- *  `orientation` is which side they stand on. */
-declare function oneAxis(format: ((value: number) => string) | undefined, title: string, width?: number, orientation?: "left" | "right"): SeriesChartAxis[];
-/** One source's samples: an abscissa and the channels measured against it. */
-interface SeriesSource {
-    x: number[];
-    channels: Record<string, number[]>;
-}
-/**
- * Merge sources sampled on different grids into rows the chart can draw.
- *
- * Merged ON THE ABSCISSA VALUE ITSELF, never interpolated onto a common grid: a line
- * through invented points looks exactly like one through measured ones. Where a source
- * has no sample the key is absent, and `connectNulls` bridges the hole with the same
- * straight segment an interpolation would have drawn — without claiming a measurement.
- */
-declare function mergeSeries(sources: SeriesSource[]): Record<string, number>[];
-/**
- * A series key built out of parts — as a CSS identifier.
- *
- * The chart shell paints each series through `--color-<key>`, and skips (with a
- * console warning) any key that is not `[A-Za-z_][A-Za-z0-9_-]*`. A line whose colour
- * was skipped has no stroke at all: an axis, a grid and nothing between them. So a key
- * assembled out of DATA — an id, an enum, a side — goes through here: every other
- * character becomes `_`, the parts are joined with `_`, and a key that would start with
- * a digit or a hyphen gets a leading `_`.
- */
-declare function seriesKey(...parts: (string | number)[]): string;
-/**
- * The band an axis carrying bars or areas draws: the data's extent with ZERO in it,
- * padded only on the sides that are not zero — bars standing on a frame's bottom edge,
- * not floating four per cent above it on a band of air nobody asked for.
- * `undefined` when there is nothing to fit.
- */
-declare function anchoredBand(extent: readonly [number, number] | undefined): [number, number] | undefined;
-/**
- * Series with their colours settled BEFORE any are switched off.
- *
- * A series with no `color` takes `paletteFor(its position)` — and a legend toggle that
- * hands the chart a shorter list moves every later series one position up, repainting
- * it in its neighbour's colour on each click. Resolving the colours on the full list
- * and filtering after keeps each series in the colour its legend entry shows.
- */
-declare function visibleSeries(series: readonly SeriesChartSeries[], hidden: ReadonlySet<string>): SeriesChartSeries[];
 /** Where a legend learns which axes are not drawn — see {@link seriesLegendEntries}. */
-interface SeriesLegendAxes {
+export interface SeriesLegendAxes {
     /** The chart's axes. A series on one that is `hide`, or `budgeted`, says its unit. */
     axes?: readonly SeriesChartAxis[];
     /** What the chart's `onAxisBudget` last said. */
@@ -719,19 +571,17 @@ interface SeriesLegendAxes {
  * series whose axis is not drawn says the unit that axis would have: "Velocity (mm/s)"
  * — see {@link SeriesChartAxis.unit}. Without them, the labels are as given.
  */
-declare function seriesLegendEntries(series: readonly SeriesChartSeries[], { axes, budgeted }?: SeriesLegendAxes): LegendEntry[];
+export declare function seriesLegendEntries(series: readonly SeriesChartSeries[], { axes, budgeted }?: SeriesLegendAxes): LegendEntry[];
 /**
  * {@link SeriesChart} without the zoom: the same picture, no drag layer, no reset
  * button. For a thumbnail, a print view, or a chart the consumer wraps in its own
  * interaction.
  */
-declare function StaticSeriesChart(props: SeriesChartProps): react.JSX.Element;
+export declare function StaticSeriesChart(props: SeriesChartProps): import("react").JSX.Element;
 /**
  * The series chart, zoomable. Drag across the plot to zoom (the drag's shape picks the
  * axes), double-click or press the reset button to go back; wrap several in
  * `SharedXZoom` to move their x windows together. Which axes zoom depends on the marks
  * — see {@link SeriesChartProps.zoomAxes}.
  */
-declare function SeriesChart(props: SeriesChartProps): react.JSX.Element;
-
-export { AXIS_TICK_WIDTH, AXIS_TITLE_STRIP, SeriesChart, type SeriesChartAxis, SeriesChartAxisBudget, type SeriesChartHit, type SeriesChartMarker, type SeriesChartPoint, type SeriesChartProps, type SeriesChartReference, type SeriesChartRow, type SeriesChartSeries, type SeriesChartSpan, type SeriesChartTickValues, type SeriesChartTone, type SeriesChartTooltip, type SeriesChartTooltipPlacement, type SeriesChartType, type SeriesChartX, type SeriesChartXTick, type SeriesChartXValue, type SeriesLegendAxes, type SeriesSource, StaticSeriesChart, TimeTickUnit, anchoredBand, axisBandWidth, mergeSeries, oneAxis, padBand, paddedDomain, resolveTooltipPlacement, seriesKey, seriesLegendEntries, soleSeriesColor, visibleSeries };
+export declare function SeriesChart(props: SeriesChartProps): import("react").JSX.Element;