@umriss-ui/charts 0.15.0 → 0.34.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +43 -3
- package/README.md +18 -8
- package/dist/charts.js +4415 -4309
- package/dist/de.d.ts +8 -5
- package/dist/index.d.ts +76 -195
- package/dist/wording/de.js +2 -0
- package/docs/llms-full.md +120 -218
- package/package.json +4 -3
package/dist/de.d.ts
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
/** Everything the charts put out as text. */
|
|
2
2
|
declare interface ChartsWording {
|
|
3
|
+
/** The BCP 47 tag every number and every date or time label of the chart is
|
|
4
|
+
formatted in (`en-GB`, `de-DE`). The one input for the locale: the
|
|
5
|
+
browser's language is not read. The clock stays 24-hour in both. */
|
|
6
|
+
locale: string;
|
|
3
7
|
/** What a screen reader calls the plot area that takes the keys
|
|
4
8
|
(`aria-roledescription`). */
|
|
5
9
|
roleDescription: string;
|
|
@@ -26,9 +30,9 @@ declare interface ChartsWording {
|
|
|
26
30
|
x: string;
|
|
27
31
|
}[]) => string;
|
|
28
32
|
/** The last row of a stack in the tooltip and the readout: the sum of its
|
|
29
|
-
members at the point
|
|
33
|
+
members at the point. */
|
|
30
34
|
stackTotal: string;
|
|
31
|
-
/** A share in a normalised stack, its number already formatted
|
|
35
|
+
/** A share in a normalised stack, its number already formatted. */
|
|
32
36
|
percent: (value: string) => string;
|
|
33
37
|
/** The keys that walk the chart. */
|
|
34
38
|
walkHelp: string;
|
|
@@ -44,8 +48,7 @@ declare interface ChartsWording {
|
|
|
44
48
|
/** The control over a zoomed plot that brings every zoomed axis back to
|
|
45
49
|
its own domain (component-view 04). */
|
|
46
50
|
showAll: string;
|
|
47
|
-
/** The data table's disclosure key, closed and open
|
|
48
|
-
C1). */
|
|
51
|
+
/** The data table's disclosure key, closed and open. */
|
|
49
52
|
showData: string;
|
|
50
53
|
hideData: string;
|
|
51
54
|
/** The heading of the table's x column where its axis has no `label`, and
|
|
@@ -70,7 +73,7 @@ declare interface ChartsWording {
|
|
|
70
73
|
notch: string;
|
|
71
74
|
count: string;
|
|
72
75
|
outlierList: (values: readonly string[], more: number) => string;
|
|
73
|
-
/** Added to the caption where the table shows the downsampled course
|
|
76
|
+
/** Added to the caption where the table shows the downsampled course:
|
|
74
77
|
how many readings its rows stand for. */
|
|
75
78
|
downsampled: (readings: number) => string;
|
|
76
79
|
}
|
package/dist/index.d.ts
CHANGED
|
@@ -4,21 +4,17 @@ import { ReactNode } from 'react';
|
|
|
4
4
|
/** The props of `Area`. */
|
|
5
5
|
export declare interface AreaProps<T> {
|
|
6
6
|
/** Upper edge - a number field of the row or a function of it;
|
|
7
|
-
null/undefined/NaN/±Infinity means a gap.
|
|
8
|
-
@remarks R-2.5 */
|
|
7
|
+
null/undefined/NaN/±Infinity means a gap. */
|
|
9
8
|
value: Value<T>;
|
|
10
9
|
/** Lower edge - a number field of the row or a function of it. In a `stack` the stack below is the lower edge, and this is
|
|
11
10
|
not read.
|
|
12
11
|
@default a fixed baseline at 0 */
|
|
13
12
|
baseline?: Value<T>;
|
|
14
|
-
/** Binding to an x axis.
|
|
15
|
-
@remarks R-4.12 */
|
|
13
|
+
/** Binding to an x axis. */
|
|
16
14
|
xAxisId?: string;
|
|
17
|
-
/** Binding to a y axis.
|
|
18
|
-
@remarks R-4.12 */
|
|
15
|
+
/** Binding to a y axis. */
|
|
19
16
|
yAxisId?: string;
|
|
20
|
-
/** Series-own data; overrides the container data.
|
|
21
|
-
@remarks R-2.4 */
|
|
17
|
+
/** Series-own data; overrides the container data. */
|
|
22
18
|
data?: readonly T[];
|
|
23
19
|
/** The name in legend and tooltip. Without one a warning stands in DEV - an
|
|
24
20
|
unnamed series is a colour nobody can look up.
|
|
@@ -120,8 +116,7 @@ export declare interface AxisConfig<T = unknown> {
|
|
|
120
116
|
their x axis' domain. */
|
|
121
117
|
domain: "nice" | "data" | "visible" | readonly [number, number];
|
|
122
118
|
/** Whether the axis draws its grid lines.
|
|
123
|
-
@default only the first registered axis per orientation
|
|
124
|
-
@remarks R-4.15 */
|
|
119
|
+
@default only the first registered axis per orientation */
|
|
125
120
|
grid?: boolean;
|
|
126
121
|
/** Fixed tick values instead of the 1-2-5 algorithm, on a numeric axis: an
|
|
127
122
|
hour axis' named hours, a lane grid. */
|
|
@@ -177,17 +172,13 @@ export declare type AxisValue = number | string | Date | null | undefined;
|
|
|
177
172
|
/** The props of `Bar`. */
|
|
178
173
|
export declare interface BarProps<T> {
|
|
179
174
|
/** Height - a number field of the row or a function of it;
|
|
180
|
-
null/undefined/NaN/±Infinity means a gap.
|
|
181
|
-
@remarks R-2.5 */
|
|
175
|
+
null/undefined/NaN/±Infinity means a gap. */
|
|
182
176
|
value: Value<T>;
|
|
183
|
-
/** Binding to an x axis.
|
|
184
|
-
@remarks R-4.12 */
|
|
177
|
+
/** Binding to an x axis. */
|
|
185
178
|
xAxisId?: string;
|
|
186
|
-
/** Binding to a y axis.
|
|
187
|
-
@remarks R-4.12 */
|
|
179
|
+
/** Binding to a y axis. */
|
|
188
180
|
yAxisId?: string;
|
|
189
|
-
/** Series-own data; overrides the container data.
|
|
190
|
-
@remarks R-2.4 */
|
|
181
|
+
/** Series-own data; overrides the container data. */
|
|
191
182
|
data?: readonly T[];
|
|
192
183
|
/** The name in legend and tooltip. Without one a warning stands in DEV - an
|
|
193
184
|
unnamed series is a colour nobody can look up.
|
|
@@ -277,7 +268,7 @@ export declare interface BoxChannels extends BoxNumbers<Float64Array> {
|
|
|
277
268
|
count: Float64Array | null;
|
|
278
269
|
}
|
|
279
270
|
|
|
280
|
-
/** The optional numbers of a box
|
|
271
|
+
/** The optional numbers of a box by name. */
|
|
281
272
|
export declare interface BoxExtras<V = number> {
|
|
282
273
|
mean: V;
|
|
283
274
|
notchLower: V;
|
|
@@ -297,8 +288,7 @@ export declare interface BoxNumbers<V = number> {
|
|
|
297
288
|
function of it; `outliers` a list field or a function. */
|
|
298
289
|
export declare interface BoxPlotProps<T> {
|
|
299
290
|
/** The line across the box; null/undefined/NaN/±Infinity means a gap - no
|
|
300
|
-
box is drawn there, whatever the other numbers say.
|
|
301
|
-
@remarks R-2.5 */
|
|
291
|
+
box is drawn there, whatever the other numbers say. */
|
|
302
292
|
median: Value<T>;
|
|
303
293
|
/** The box's lower edge. */
|
|
304
294
|
lowerQuartile: Value<T>;
|
|
@@ -324,14 +314,11 @@ export declare interface BoxPlotProps<T> {
|
|
|
324
314
|
/** How many values stand behind the box; read in the tooltip and the
|
|
325
315
|
table, not drawn. */
|
|
326
316
|
count?: Value<T>;
|
|
327
|
-
/** Binding to an x axis.
|
|
328
|
-
@remarks R-4.12 */
|
|
317
|
+
/** Binding to an x axis. */
|
|
329
318
|
xAxisId?: string;
|
|
330
|
-
/** Binding to a y axis.
|
|
331
|
-
@remarks R-4.12 */
|
|
319
|
+
/** Binding to a y axis. */
|
|
332
320
|
yAxisId?: string;
|
|
333
|
-
/** Series-own data; overrides the container data.
|
|
334
|
-
@remarks R-2.4 */
|
|
321
|
+
/** Series-own data; overrides the container data. */
|
|
335
322
|
data?: readonly T[];
|
|
336
323
|
/** The name in legend and tooltip. Without one a warning stands in DEV.
|
|
337
324
|
@default "Series n", after its place in the chart */
|
|
@@ -387,16 +374,15 @@ export declare type CalendarInput = WorkingCalendar | readonly WorkingInterval[]
|
|
|
387
374
|
/** What `useChart` takes besides the rows: the view to start from and the
|
|
388
375
|
handler that hears every change of it. */
|
|
389
376
|
export declare interface ChartOptions<Z = unknown> {
|
|
390
|
-
/** The view to start from,
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
do not jump back mid-pan. The chart remembers none: where a view is kept
|
|
395
|
-
is the application's decision. */
|
|
377
|
+
/** The view to start from, read once when the hook first runs; a different
|
|
378
|
+
value on a later render is ignored, as React ignores a changed
|
|
379
|
+
`defaultValue`. To go to a view later, call `setView`. The chart
|
|
380
|
+
remembers none: where a view is kept is the application's decision. */
|
|
396
381
|
initialView?: ChartView;
|
|
397
|
-
/** Every change
|
|
398
|
-
or to hand another chart
|
|
399
|
-
|
|
382
|
+
/** Every change the reader makes, once, always the whole view - the one to
|
|
383
|
+
keep, or to hand another chart's `setView`. A pan or zoom is reported at
|
|
384
|
+
most once per frame. Not called for the view the chart starts with, nor
|
|
385
|
+
for one `setView` applies. */
|
|
400
386
|
onViewChange?: (view: ChartView) => void;
|
|
401
387
|
/** The reader chose a point: a click on a hit (a tap too), or Enter on the
|
|
402
388
|
Active point - the same hit the tooltip's `render` receives. Once per
|
|
@@ -430,6 +416,11 @@ export declare interface ChartParts<Z> {
|
|
|
430
416
|
/** The span each zoomable x axis shows, by axis `id`; an axis absent shows
|
|
431
417
|
its own `domain`. */
|
|
432
418
|
domains: AxisSpans;
|
|
419
|
+
/** Goes to a whole view; what it leaves out is shown whole again. Not
|
|
420
|
+
reported through `onViewChange`: two charts kept in step by
|
|
421
|
+
`onViewChange: (v) => other.setView(v)` in both directions do not answer
|
|
422
|
+
each other. A view with the content already shown changes nothing. */
|
|
423
|
+
setView: (view: ChartView) => void;
|
|
433
424
|
/** Puts a span in view on a zoomable x axis - a lone one is `"x"`; `null`
|
|
434
425
|
shows the axis' own `domain` again. */
|
|
435
426
|
setDomain: (axisId: string, span: readonly [number, number] | null) => void;
|
|
@@ -444,8 +435,7 @@ export declare interface ChartParts<Z> {
|
|
|
444
435
|
showAllSeries: () => void;
|
|
445
436
|
}
|
|
446
437
|
|
|
447
|
-
/** Measurements of the instrumentation for the benchmark page.
|
|
448
|
-
@remarks R-5.1 */
|
|
438
|
+
/** Measurements of the instrumentation for the benchmark page. */
|
|
449
439
|
export declare interface ChartPerf {
|
|
450
440
|
materializeMs: number;
|
|
451
441
|
seriesDrawMs: number;
|
|
@@ -468,8 +458,7 @@ export declare interface ChartProps {
|
|
|
468
458
|
height?: number;
|
|
469
459
|
/** Outer spacing of the plot area in CSS pixels. */
|
|
470
460
|
padding?: number | Partial<Padding>;
|
|
471
|
-
/** Required in DEV through a warning.
|
|
472
|
-
@remarks R-7.6 */
|
|
461
|
+
/** Required in DEV through a warning. */
|
|
473
462
|
ariaLabel?: string;
|
|
474
463
|
/** Goes to the root element, as it does everywhere in this workspace. */
|
|
475
464
|
className?: string;
|
|
@@ -489,7 +478,10 @@ export declare interface ChartProps {
|
|
|
489
478
|
@default false */
|
|
490
479
|
loading?: boolean;
|
|
491
480
|
/** The chart's words (ADR-0031); entries left out fall back to English.
|
|
492
|
-
|
|
481
|
+
Its `locale` also formats every number and every date or time label the
|
|
482
|
+
chart makes itself (`en-GB`, `de-DE`; the browser's language is not
|
|
483
|
+
read) - a `tickFormat` or `format` of your own stays in charge of its
|
|
484
|
+
axis or series. German: `GERMAN_CHARTS_WORDING` from `@umriss-ui/charts/wording/de`.
|
|
493
485
|
@default DEFAULT_CHARTS_WORDING */
|
|
494
486
|
wording?: Partial<ChartsWording>;
|
|
495
487
|
/** How series are told apart. `"color"`: by their colour.
|
|
@@ -503,21 +495,23 @@ export declare interface ChartProps {
|
|
|
503
495
|
/** Charts with the same id share the pointer's x position, in domain units:
|
|
504
496
|
each draws its crosshair there, the tooltip stays with the chart under
|
|
505
497
|
the pointer. Zoom is not shared this way: charts zoom together by
|
|
506
|
-
|
|
507
|
-
`
|
|
498
|
+
sending each other their view (`useChart`'s `onViewChange` and
|
|
499
|
+
`setView`). */
|
|
508
500
|
syncId?: string;
|
|
509
|
-
/** Instrumentation for the benchmark page; not needed otherwise.
|
|
510
|
-
@remarks R-5.1 */
|
|
501
|
+
/** Instrumentation for the benchmark page; not needed otherwise. */
|
|
511
502
|
onPerf?: (perf: ChartPerf) => void;
|
|
512
503
|
/** The axes, series and companions of this chart. They draw nothing
|
|
513
504
|
themselves: each registers its configuration and the scene draws it,
|
|
514
|
-
and the order in the JSX is the drawing order.
|
|
515
|
-
@remarks R-2.1 */
|
|
505
|
+
and the order in the JSX is the drawing order. */
|
|
516
506
|
children?: ReactNode;
|
|
517
507
|
}
|
|
518
508
|
|
|
519
509
|
/** Everything the charts put out as text. */
|
|
520
510
|
export declare interface ChartsWording {
|
|
511
|
+
/** The BCP 47 tag every number and every date or time label of the chart is
|
|
512
|
+
formatted in (`en-GB`, `de-DE`). The one input for the locale: the
|
|
513
|
+
browser's language is not read. The clock stays 24-hour in both. */
|
|
514
|
+
locale: string;
|
|
521
515
|
/** What a screen reader calls the plot area that takes the keys
|
|
522
516
|
(`aria-roledescription`). */
|
|
523
517
|
roleDescription: string;
|
|
@@ -544,9 +538,9 @@ export declare interface ChartsWording {
|
|
|
544
538
|
x: string;
|
|
545
539
|
}[]) => string;
|
|
546
540
|
/** The last row of a stack in the tooltip and the readout: the sum of its
|
|
547
|
-
members at the point
|
|
541
|
+
members at the point. */
|
|
548
542
|
stackTotal: string;
|
|
549
|
-
/** A share in a normalised stack, its number already formatted
|
|
543
|
+
/** A share in a normalised stack, its number already formatted. */
|
|
550
544
|
percent: (value: string) => string;
|
|
551
545
|
/** The keys that walk the chart. */
|
|
552
546
|
walkHelp: string;
|
|
@@ -562,8 +556,7 @@ export declare interface ChartsWording {
|
|
|
562
556
|
/** The control over a zoomed plot that brings every zoomed axis back to
|
|
563
557
|
its own domain (component-view 04). */
|
|
564
558
|
showAll: string;
|
|
565
|
-
/** The data table's disclosure key, closed and open
|
|
566
|
-
C1). */
|
|
559
|
+
/** The data table's disclosure key, closed and open. */
|
|
567
560
|
showData: string;
|
|
568
561
|
hideData: string;
|
|
569
562
|
/** The heading of the table's x column where its axis has no `label`, and
|
|
@@ -588,7 +581,7 @@ export declare interface ChartsWording {
|
|
|
588
581
|
notch: string;
|
|
589
582
|
count: string;
|
|
590
583
|
outlierList: (values: readonly string[], more: number) => string;
|
|
591
|
-
/** Added to the caption where the table shows the downsampled course
|
|
584
|
+
/** Added to the caption where the table shows the downsampled course:
|
|
592
585
|
how many readings its rows stand for. */
|
|
593
586
|
downsampled: (readings: number) => string;
|
|
594
587
|
}
|
|
@@ -605,8 +598,7 @@ export declare interface ChartView {
|
|
|
605
598
|
}
|
|
606
599
|
|
|
607
600
|
declare interface CommonProps {
|
|
608
|
-
/** Axis id, through which series bind themselves.
|
|
609
|
-
@remarks R-4.12 */
|
|
601
|
+
/** Axis id, through which series bind themselves. */
|
|
610
602
|
id?: string;
|
|
611
603
|
/** Axis title. */
|
|
612
604
|
label?: string;
|
|
@@ -618,8 +610,7 @@ declare interface CommonProps {
|
|
|
618
610
|
identity. */
|
|
619
611
|
tickFormat?: (v: number) => string;
|
|
620
612
|
/** Grid lines.
|
|
621
|
-
@default only on the first axis of its orientation
|
|
622
|
-
@remarks R-4.15 */
|
|
613
|
+
@default only on the first axis of its orientation */
|
|
623
614
|
grid?: boolean;
|
|
624
615
|
/** Fixed tick values instead of the 1-2-5 algorithm, on a numeric axis: an
|
|
625
616
|
hour axis' named hours, a lane grid. An axis that reads categories needs
|
|
@@ -656,11 +647,9 @@ export declare interface ControlChartProps<T> {
|
|
|
656
647
|
/** Given, or from a named reference window - never tacitly from everything on
|
|
657
648
|
the screen (ADR-0008). */
|
|
658
649
|
origin: ControlLimitOrigin;
|
|
659
|
-
/** Binding to an x axis.
|
|
660
|
-
@remarks R-4.12 */
|
|
650
|
+
/** Binding to an x axis. */
|
|
661
651
|
xAxisId?: string;
|
|
662
|
-
/** Binding to a y axis.
|
|
663
|
-
@remarks R-4.12 */
|
|
652
|
+
/** Binding to a y axis. */
|
|
664
653
|
yAxisId?: string;
|
|
665
654
|
/** The name in legend and tooltip. Without one a warning stands in DEV - an
|
|
666
655
|
unnamed series is a colour nobody can look up.
|
|
@@ -760,32 +749,6 @@ export declare const DEFAULT_CHARTS_WORDING: ChartsWording;
|
|
|
760
749
|
restriction - whoever has a scale of their own names it. */
|
|
761
750
|
export declare const DEFAULT_GRADIENT: readonly string[];
|
|
762
751
|
|
|
763
|
-
/** All four rules, with Nelson's run lengths: nine points on one side, six
|
|
764
|
-
points in succession rising or falling. Western Electric counts eight; both
|
|
765
|
-
lengths are therefore parameters. */
|
|
766
|
-
export declare const defaultRules: RuleOptions;
|
|
767
|
-
|
|
768
|
-
/** The views a component reported that may still come back, by their
|
|
769
|
-
content key - the chart's and the schedule's (ADR-0047), the table holding
|
|
770
|
-
a copy of its own. An application keeping the view hands
|
|
771
|
-
it back a frame or more late - by then a pan has moved on, and going to the
|
|
772
|
-
view handed in would jump back. So a view handed in that equals one
|
|
773
|
-
reported since the last one handed in, within a second, is the component's
|
|
774
|
-
own state coming back, not a view to go to. The echoes come in order: one drops
|
|
775
|
-
itself and every older report, a view from outside drops them all. The
|
|
776
|
-
second bounds the list where nothing is handed back, and lets such an
|
|
777
|
-
application still restore a view it kept. */
|
|
778
|
-
export declare class Echoes {
|
|
779
|
-
private reports;
|
|
780
|
-
/** Notes a view reported, by its key. */
|
|
781
|
-
reported(key: string): void;
|
|
782
|
-
/** Whether the view handed in is a report coming back. */
|
|
783
|
-
has(key: string): boolean;
|
|
784
|
-
/** Forgets what the view handed in answers. */
|
|
785
|
-
handed(key: string): void;
|
|
786
|
-
private at;
|
|
787
|
-
}
|
|
788
|
-
|
|
789
752
|
/** One hour in milliseconds. */
|
|
790
753
|
export declare const HOUR: number;
|
|
791
754
|
|
|
@@ -848,7 +811,7 @@ export declare interface LimitBandProps extends LimitCommonProps {
|
|
|
848
811
|
|
|
849
812
|
declare interface LimitBase {
|
|
850
813
|
/** Axis on which the value lies; without one, the first axis of its
|
|
851
|
-
orientation
|
|
814
|
+
orientation. */
|
|
852
815
|
axisId?: string;
|
|
853
816
|
orientation: AxisOrientation;
|
|
854
817
|
severity: Severity;
|
|
@@ -953,17 +916,13 @@ export declare class LinearScale implements Scale {
|
|
|
953
916
|
/** The props of `Line`. */
|
|
954
917
|
export declare interface LineProps<T> {
|
|
955
918
|
/** Y value - a number field of the row or a function of it;
|
|
956
|
-
null/undefined/NaN/±Infinity means a gap.
|
|
957
|
-
@remarks R-2.5 */
|
|
919
|
+
null/undefined/NaN/±Infinity means a gap. */
|
|
958
920
|
value: Value<T>;
|
|
959
|
-
/** Binding to an x axis.
|
|
960
|
-
@remarks R-4.12 */
|
|
921
|
+
/** Binding to an x axis. */
|
|
961
922
|
xAxisId?: string;
|
|
962
|
-
/** Binding to a y axis.
|
|
963
|
-
@remarks R-4.12 */
|
|
923
|
+
/** Binding to a y axis. */
|
|
964
924
|
yAxisId?: string;
|
|
965
|
-
/** Series-own data; overrides the container data.
|
|
966
|
-
@remarks R-2.4 */
|
|
925
|
+
/** Series-own data; overrides the container data. */
|
|
967
926
|
data?: readonly T[];
|
|
968
927
|
/** The name in legend and tooltip. Without one a warning stands in DEV - an
|
|
969
928
|
unnamed series is a colour nobody can look up.
|
|
@@ -1020,19 +979,13 @@ export declare type ListValue<T> = ListField<T> | ListFunction<T>;
|
|
|
1020
979
|
for a grid up to the next clock change. */
|
|
1021
980
|
export declare function localOffset(instant: number): number;
|
|
1022
981
|
|
|
1023
|
-
/** Map a whole series inwards - the route materialisation takes when it wants to
|
|
1024
|
-
go it in one piece. Only the first n values are touched. */
|
|
1025
|
-
export declare function mapSeries(input: CalendarInput, source: Float64Array, n: number, target: Float64Array): void;
|
|
1026
|
-
|
|
1027
982
|
/** Materialised series: the draw loop works only on this.
|
|
1028
|
-
Gaps (null/undefined/NaN/±Infinity out of the accessor) are encoded as NaN.
|
|
1029
|
-
@remarks R-2.7, R-2.5 */
|
|
983
|
+
Gaps (null/undefined/NaN/±Infinity out of the accessor) are encoded as NaN. */
|
|
1030
984
|
export declare interface MaterializedSeries {
|
|
1031
985
|
x: Float64Array;
|
|
1032
986
|
y: Float64Array;
|
|
1033
987
|
/** Lower edge, where the baseline is an accessor of its own; otherwise null.
|
|
1034
|
-
A fixed baseline needs no channel - it is a number.
|
|
1035
|
-
@remarks R-2.7 */
|
|
988
|
+
A fixed baseline needs no channel - it is a number. */
|
|
1036
989
|
y0: Float64Array | null;
|
|
1037
990
|
/** Level channel: the third value per point, which today only the matrix
|
|
1038
991
|
needs. Named rather than overloading y0 - a property that only some kinds
|
|
@@ -1078,14 +1031,11 @@ export declare interface MatrixProps<T> {
|
|
|
1078
1031
|
a gradient.
|
|
1079
1032
|
@default { kind: "gradient", stops: DEFAULT_GRADIENT } */
|
|
1080
1033
|
coloring?: MatrixColoring;
|
|
1081
|
-
/** Binding to an x axis.
|
|
1082
|
-
@remarks R-4.12 */
|
|
1034
|
+
/** Binding to an x axis. */
|
|
1083
1035
|
xAxisId?: string;
|
|
1084
|
-
/** Binding to a y axis.
|
|
1085
|
-
@remarks R-4.12 */
|
|
1036
|
+
/** Binding to a y axis. */
|
|
1086
1037
|
yAxisId?: string;
|
|
1087
|
-
/** Series-own data; overrides the container data.
|
|
1088
|
-
@remarks R-2.4 */
|
|
1038
|
+
/** Series-own data; overrides the container data. */
|
|
1089
1039
|
data?: readonly T[];
|
|
1090
1040
|
/** The name in legend and tooltip. Without one a warning stands in DEV - an
|
|
1091
1041
|
unnamed series is a colour nobody can look up.
|
|
@@ -1149,10 +1099,6 @@ export declare interface Padding {
|
|
|
1149
1099
|
which is the third biggest problem. */
|
|
1150
1100
|
export declare function pareto(items: readonly ParetoItem[], options?: ParetoSettings): ParetoResult;
|
|
1151
1101
|
|
|
1152
|
-
/** What `pareto` assumes where a call says nothing: a cutoff of 80 %, and no
|
|
1153
|
-
collecting of the tail. */
|
|
1154
|
-
export declare const paretoDefaults: Omit<ParetoOptions, "remainderName">;
|
|
1155
|
-
|
|
1156
1102
|
/** An item, the way it is drawn. */
|
|
1157
1103
|
export declare interface ParetoEntry {
|
|
1158
1104
|
readonly name: string;
|
|
@@ -1188,10 +1134,7 @@ export declare interface ParetoOptions {
|
|
|
1188
1134
|
one.
|
|
1189
1135
|
@default Infinity */
|
|
1190
1136
|
readonly collectRank: number;
|
|
1191
|
-
/** Name of the collected remainder.
|
|
1192
|
-
- every string it draws comes from the caller - and no module is introduced
|
|
1193
|
-
for a single label. Until library-audit 03 the name here was
|
|
1194
|
-
"Sonstige", the one German word the package brought along itself.
|
|
1137
|
+
/** Name of the collected remainder. The helper has no default wording for it.
|
|
1195
1138
|
@default none - the caller names it */
|
|
1196
1139
|
readonly remainderName?: string;
|
|
1197
1140
|
}
|
|
@@ -1290,26 +1233,6 @@ export declare interface RuleOptions {
|
|
|
1290
1233
|
readonly trendLength: number;
|
|
1291
1234
|
}
|
|
1292
1235
|
|
|
1293
|
-
/** Rule 1 (Nelson 1, Western Electric 1): one point beyond three sigma.
|
|
1294
|
-
Beyond, not on it - a point exactly on the limit violates nothing. */
|
|
1295
|
-
export declare function ruleOutlier(values: readonly number[], limits: ControlLimits): number[];
|
|
1296
|
-
|
|
1297
|
-
/** Rule 2 (Nelson 2): a run of points on one side of the centre line. The
|
|
1298
|
-
default length is nine - Nelson. Western Electric counts eight; that is why
|
|
1299
|
-
the length is a parameter and not a literal, so that a works with a rule of
|
|
1300
|
-
its own need not argue with the library. */
|
|
1301
|
-
export declare function ruleRun(values: readonly number[], limits: ControlLimits, length?: number): number[];
|
|
1302
|
-
|
|
1303
|
-
/** Rule 3 (Nelson 3): a run of nothing but rises or nothing but falls. The
|
|
1304
|
-
default length is six points, so five steps - Nelson. Two equal values are
|
|
1305
|
-
neither a rise nor a fall and break the run. */
|
|
1306
|
-
export declare function ruleTrend(values: readonly number[], length?: number): number[];
|
|
1307
|
-
|
|
1308
|
-
/** Rule 4 (Nelson 5): two of three consecutive points beyond two sigma on the
|
|
1309
|
-
same side. Reported are the points beyond the zone, not the one in between -
|
|
1310
|
-
that one is unremarkable and, marked, would look like a measurement error. */
|
|
1311
|
-
export declare function ruleTwoOfThree(values: readonly number[], limits: ControlLimits): number[];
|
|
1312
|
-
|
|
1313
1236
|
/** The mapping of an axis' values onto pixels and back, with its ticks. Every
|
|
1314
1237
|
scale of the library is affine; `LinearScale` implements it. */
|
|
1315
1238
|
export declare interface Scale {
|
|
@@ -1332,17 +1255,13 @@ export declare interface Scale {
|
|
|
1332
1255
|
/** The props of `Scatter`. */
|
|
1333
1256
|
export declare interface ScatterProps<T> {
|
|
1334
1257
|
/** Y value - a number field of the row or a function of it;
|
|
1335
|
-
null/undefined/NaN/±Infinity means a gap.
|
|
1336
|
-
@remarks R-2.5 */
|
|
1258
|
+
null/undefined/NaN/±Infinity means a gap. */
|
|
1337
1259
|
value: Value<T>;
|
|
1338
|
-
/** Binding to an x axis.
|
|
1339
|
-
@remarks R-4.12 */
|
|
1260
|
+
/** Binding to an x axis. */
|
|
1340
1261
|
xAxisId?: string;
|
|
1341
|
-
/** Binding to a y axis.
|
|
1342
|
-
@remarks R-4.12 */
|
|
1262
|
+
/** Binding to a y axis. */
|
|
1343
1263
|
yAxisId?: string;
|
|
1344
|
-
/** Series-own data; overrides the container data.
|
|
1345
|
-
@remarks R-2.4 */
|
|
1264
|
+
/** Series-own data; overrides the container data. */
|
|
1346
1265
|
data?: readonly T[];
|
|
1347
1266
|
/** The name in legend and tooltip. Without one a warning stands in DEV - an
|
|
1348
1267
|
unnamed series is a colour nobody can look up.
|
|
@@ -1373,11 +1292,9 @@ export declare const SECOND = 1000;
|
|
|
1373
1292
|
/** What every series registers, whatever its kind: where its values come from,
|
|
1374
1293
|
which axes it stands on, and how it is named and coloured. */
|
|
1375
1294
|
export declare interface SeriesBase<T = unknown> {
|
|
1376
|
-
/** Y value; null/undefined/NaN/±Infinity means a gap.
|
|
1377
|
-
@remarks R-2.5 */
|
|
1295
|
+
/** Y value; null/undefined/NaN/±Infinity means a gap. */
|
|
1378
1296
|
accessor: ValueFunction<T>;
|
|
1379
|
-
/** Series-own data; overrides the container data.
|
|
1380
|
-
@remarks R-2.4 */
|
|
1297
|
+
/** Series-own data; overrides the container data. */
|
|
1381
1298
|
data?: readonly T[];
|
|
1382
1299
|
xAxisId: string;
|
|
1383
1300
|
yAxisId: string;
|
|
@@ -1408,16 +1325,12 @@ export declare type Severity = "warning" | "alarm";
|
|
|
1408
1325
|
/** Whether a limit is an upper or a lower bound. */
|
|
1409
1326
|
export declare type Side = "upper" | "lower";
|
|
1410
1327
|
|
|
1411
|
-
/**
|
|
1412
|
-
baseline has been handed down as a centre line and a control limit. */
|
|
1413
|
-
export declare function sigmaFromLimit(center: number, upper: number): number;
|
|
1414
|
-
|
|
1415
|
-
/** What the two filled kinds share: a place in a stack (charts-stacking). */
|
|
1328
|
+
/** What the two filled kinds share: a place in a stack. */
|
|
1416
1329
|
declare interface Stackable {
|
|
1417
1330
|
/** The stack this series stands in: series with the same id, on the same x
|
|
1418
|
-
and y axis, stack in registration order
|
|
1331
|
+
and y axis, stack in registration order. */
|
|
1419
1332
|
stack?: string;
|
|
1420
|
-
/** On any member, the whole stack sums to 100 at every x
|
|
1333
|
+
/** On any member, the whole stack sums to 100 at every x. */
|
|
1421
1334
|
normalize?: boolean;
|
|
1422
1335
|
}
|
|
1423
1336
|
|
|
@@ -1431,14 +1344,11 @@ export declare interface StateBandProps<T> {
|
|
|
1431
1344
|
value: Value<T>;
|
|
1432
1345
|
/** The closed set of states, in the order of their codes. */
|
|
1433
1346
|
states: readonly StateEntry[];
|
|
1434
|
-
/** Binding to an x axis.
|
|
1435
|
-
@remarks R-4.12 */
|
|
1347
|
+
/** Binding to an x axis. */
|
|
1436
1348
|
xAxisId?: string;
|
|
1437
|
-
/** Binding to a y axis.
|
|
1438
|
-
@remarks R-4.12 */
|
|
1349
|
+
/** Binding to a y axis. */
|
|
1439
1350
|
yAxisId?: string;
|
|
1440
|
-
/** Series-own data; overrides the container data.
|
|
1441
|
-
@remarks R-2.4 */
|
|
1351
|
+
/** Series-own data; overrides the container data. */
|
|
1442
1352
|
data?: readonly T[];
|
|
1443
1353
|
/** The name in legend and tooltip. Without one a warning stands in DEV - an
|
|
1444
1354
|
unnamed series is a colour nobody can look up.
|
|
@@ -1514,8 +1424,7 @@ export declare interface TooltipHit<T = unknown> {
|
|
|
1514
1424
|
yPx: number;
|
|
1515
1425
|
}
|
|
1516
1426
|
|
|
1517
|
-
/** One hit per series in the tooltip.
|
|
1518
|
-
@remarks R-4.4 */
|
|
1427
|
+
/** One hit per series in the tooltip. */
|
|
1519
1428
|
export declare interface TooltipPoint<T = unknown> {
|
|
1520
1429
|
seriesName: string;
|
|
1521
1430
|
color: string;
|
|
@@ -1573,30 +1482,13 @@ export declare interface TooltipProps<T> {
|
|
|
1573
1482
|
interval has no next and comes back as itself. */
|
|
1574
1483
|
export declare function toWallClock(workingTime: number, input: CalendarInput): number;
|
|
1575
1484
|
|
|
1576
|
-
/** Wall clock time → working time.
|
|
1577
|
-
|
|
1578
|
-
A point in a removed interval is a gap and becomes `NaN` - the encoding every
|
|
1579
|
-
gap of this library already uses, and the drawing loop breaks the mark at it
|
|
1580
|
-
of its own accord. Not the edge of the interval: a measurement from a time
|
|
1581
|
-
which, according to the calendar, did not exist could not be laid there
|
|
1582
|
-
honestly; it would pile up on what really does lie there. The same holds
|
|
1583
|
-
before the first and after the last interval.
|
|
1584
|
-
|
|
1585
|
-
The end of one interval and the beginning of the next fall on the same value:
|
|
1586
|
-
in working time they are neighbours, and the line between two points on
|
|
1587
|
-
either side is drawn. That is not a lie but the whole purpose of the axis; the
|
|
1588
|
-
mark in the axis band tells the reader that time was taken out there. */
|
|
1589
|
-
export declare function toWorkingTime(wallClock: number, input: CalendarInput): number;
|
|
1590
|
-
|
|
1591
1485
|
/** Wall clock time → working time, but without NaN: whatever lies in removed
|
|
1592
1486
|
time falls onto the seam that this span collapses onto anyway; whatever lies
|
|
1593
1487
|
before the first or after the last interval onto 0 or onto the whole
|
|
1594
1488
|
working time respectively.
|
|
1595
1489
|
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
with NaN is false, so that a search over a block of NaN silently lands on the
|
|
1599
|
-
wrong point. The clamped value is a POSITION, not a statement: the point
|
|
1490
|
+
The materialised x values must stay ascending: binary search assumes it, and
|
|
1491
|
+
a search over NaN silently lands on the wrong point. The clamped value is a POSITION, not a statement: the point
|
|
1600
1492
|
itself is carried as a gap and is never drawn and never hit. */
|
|
1601
1493
|
export declare function toWorkingTimeClamped(wallClock: number, input: CalendarInput): number;
|
|
1602
1494
|
|
|
@@ -1676,17 +1568,6 @@ export declare interface WorkingInterval {
|
|
|
1676
1568
|
readonly to: number;
|
|
1677
1569
|
}
|
|
1678
1570
|
|
|
1679
|
-
/** Tick values for an axis extent that already stands in WORKING TIME - the
|
|
1680
|
-
route the axis layout takes.
|
|
1681
|
-
|
|
1682
|
-
The extent is trimmed to the working time that exists (an extent widened to
|
|
1683
|
-
nice boundaries reaches beyond it), calculated back into wall clock time, and
|
|
1684
|
-
the candidates arise there. The step comes from the span in working time and
|
|
1685
|
-
not from the one in wall clock time: roughly one candidate per step of
|
|
1686
|
-
working time survives, and calculated from the wall clock span, four out of
|
|
1687
|
-
ten wanted ticks would be left. */
|
|
1688
|
-
export declare function workingTicks(input: CalendarInput, from: number, to: number, count: number, offset?: number): number[];
|
|
1689
|
-
|
|
1690
1571
|
/** A tick: where it stands on the clock and where it lies on the axis. */
|
|
1691
1572
|
export declare interface WorkingTimeTick {
|
|
1692
1573
|
readonly wallClock: number;
|
|
@@ -1757,7 +1638,7 @@ export declare interface XAxisProps<T> extends CommonProps {
|
|
|
1757
1638
|
click goes back to `domain`; with the focus on the chart, + and − zoom,
|
|
1758
1639
|
Shift with ← or → pans and 0 goes back. The span shown is part of the
|
|
1759
1640
|
chart's view, by this axis' `id` (`useChart`'s `initialView`,
|
|
1760
|
-
`onViewChange`, `setDomain`). The plain wheel always scrolls the page.
|
|
1641
|
+
`onViewChange`, `setView`, `setDomain`). The plain wheel always scrolls the page.
|
|
1761
1642
|
@default false */
|
|
1762
1643
|
zoomable?: boolean;
|
|
1763
1644
|
/** The narrowest and the widest span zoom may reach, in the axis' units -
|