@ids-group-ltd/ids-design-system 0.13.1 → 0.13.2
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 +361 -0
- package/components.md +17 -5
- package/docs/agent/INDEX.md +1 -0
- package/docs/agent/charts/ds-line-chart.md +2 -1
- package/docs/agent/feedback/ds-meter.md +11 -0
- package/docs/agent/feedback/ds-progress.md +4 -1
- package/docs/agent/forms/ds-button.md +1 -1
- package/docs/agent/forms/ds-icon-button.md +1 -1
- package/docs/agent/surfaces/ds-card.md +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-bar-chart.mjs +77 -8
- package/fesm2022/ids-group-ltd-ids-design-system-components-bar-chart.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-button.mjs +3 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-button.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-chart-legend.mjs +47 -5
- package/fesm2022/ids-group-ltd-ids-design-system-components-chart-legend.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-chart-tooltip.mjs +141 -22
- package/fesm2022/ids-group-ltd-ids-design-system-components-chart-tooltip.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-column-chart.mjs +49 -9
- package/fesm2022/ids-group-ltd-ids-design-system-components-column-chart.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-donut-chart.mjs +47 -7
- package/fesm2022/ids-group-ltd-ids-design-system-components-donut-chart.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-funnel-chart.mjs +74 -8
- package/fesm2022/ids-group-ltd-ids-design-system-components-funnel-chart.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-line-chart.mjs +182 -18
- package/fesm2022/ids-group-ltd-ids-design-system-components-line-chart.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components-meter.mjs +61 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-meter.mjs.map +1 -0
- package/fesm2022/ids-group-ltd-ids-design-system-components-progress.mjs +34 -10
- package/fesm2022/ids-group-ltd-ids-design-system-components-progress.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-components.mjs +71 -13
- package/fesm2022/ids-group-ltd-ids-design-system-components.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system-core.mjs.map +1 -1
- package/fesm2022/ids-group-ltd-ids-design-system.mjs +1 -0
- package/fesm2022/ids-group-ltd-ids-design-system.mjs.map +1 -1
- package/migrations/0.13.2.json +269 -0
- package/package.json +9 -1
- package/styles/_chart-frame.scss +101 -4
- package/styles/_chart-interactive.scss +12 -3
- package/styles/_overlay-motion.scss +7 -6
- package/types/ids-group-ltd-ids-design-system-components-bar-chart.d.ts +66 -4
- package/types/ids-group-ltd-ids-design-system-components-button.d.ts +1 -0
- package/types/ids-group-ltd-ids-design-system-components-chart-legend.d.ts +25 -2
- package/types/ids-group-ltd-ids-design-system-components-chart-tooltip.d.ts +16 -2
- package/types/ids-group-ltd-ids-design-system-components-column-chart.d.ts +34 -3
- package/types/ids-group-ltd-ids-design-system-components-donut-chart.d.ts +29 -3
- package/types/ids-group-ltd-ids-design-system-components-funnel-chart.d.ts +46 -3
- package/types/ids-group-ltd-ids-design-system-components-line-chart.d.ts +83 -6
- package/types/ids-group-ltd-ids-design-system-components-meter.d.ts +36 -0
- package/types/ids-group-ltd-ids-design-system-components-progress.d.ts +21 -3
- package/types/ids-group-ltd-ids-design-system-components.d.ts +35 -9
- package/types/ids-group-ltd-ids-design-system-core.d.ts +19 -3
- package/types/ids-group-ltd-ids-design-system.d.ts +5 -4
|
@@ -2,7 +2,7 @@ import * as _ids_group_ltd_ids_design_system_components_chart_tooltip from '@ids
|
|
|
2
2
|
import { ChartItemTooltipTrigger, ChartTooltipContext } from '@ids-group-ltd/ids-design-system/components/chart-tooltip';
|
|
3
3
|
import * as _angular_core from '@angular/core';
|
|
4
4
|
import { TemplateRef } from '@angular/core';
|
|
5
|
-
import { ChartDataTable, ChartValueFormat } from '@ids-group-ltd/ids-design-system/core';
|
|
5
|
+
import { ChartFrame, ChartDataTable, ChartValueFormat } from '@ids-group-ltd/ids-design-system/core';
|
|
6
6
|
|
|
7
7
|
interface DonutChartSlice {
|
|
8
8
|
id: string;
|
|
@@ -32,6 +32,20 @@ declare class DonutChartComponent {
|
|
|
32
32
|
readonly otherLabel: _angular_core.InputSignal<string>;
|
|
33
33
|
/** Ring width as a fraction of the radius. */
|
|
34
34
|
readonly thickness: _angular_core.InputSignalWithTransform<number, unknown>;
|
|
35
|
+
/** Whether the chart draws its own bordered, padded box. `'auto'`, the default, draws it;
|
|
36
|
+
* `'none'` leaves the chart bare, for one placed inside a card the page has already drawn.
|
|
37
|
+
* Unset falls back to `DS_CONFIG.chart.frame`, then `'auto'` — whether charts live inside cards
|
|
38
|
+
* is one decision per app rather than per plot. */
|
|
39
|
+
readonly frame: _angular_core.InputSignal<ChartFrame | null>;
|
|
40
|
+
/** How long the tooltip stays after the pointer leaves the mark, in milliseconds. Zero, the
|
|
41
|
+
* default, takes it away at once: a panel that outlives the pointer sits over the plot the
|
|
42
|
+
* reader has moved on to.
|
|
43
|
+
*
|
|
44
|
+
* Raise it only for a panel a reader has to REACH — one carrying a link, a figure, or anything
|
|
45
|
+
* selectable — which is WCAG 1.4.13's hoverable clause. The panel is portaled to the body, so
|
|
46
|
+
* crossing the gap to it at an ordinary pointer speed needs about 140. Unset falls back to
|
|
47
|
+
* `DS_CONFIG.chart.tooltipLingerMs`, then 0. */
|
|
48
|
+
readonly tooltipLingerMs: _angular_core.InputSignalWithTransform<number | null, number | null>;
|
|
35
49
|
/** Printed above the plot as the chart's visible title, and reused as the annex table's
|
|
36
50
|
* caption. */
|
|
37
51
|
readonly caption: _angular_core.InputSignal<string | null>;
|
|
@@ -40,7 +54,7 @@ declare class DonutChartComponent {
|
|
|
40
54
|
/** The label-and-value table under the plot: `'toggle'` puts it behind a disclosure,
|
|
41
55
|
* `'visible'` opens it, `'none'` renders none. It is the non-visual route to the numbers, so
|
|
42
56
|
* `'none'` belongs only where the same data is already in a table on the page.
|
|
43
|
-
* Unset falls back to `DS_CONFIG.chart.dataTable`, then `'
|
|
57
|
+
* Unset falls back to `DS_CONFIG.chart.dataTable`, then `'none'`. */
|
|
44
58
|
readonly dataTable: _angular_core.InputSignal<ChartDataTable | null>;
|
|
45
59
|
/** Draws skeleton marks in place of the data, at the same count, so the chart does not resize
|
|
46
60
|
* when the data lands. */
|
|
@@ -59,6 +73,7 @@ declare class DonutChartComponent {
|
|
|
59
73
|
* included. Unset falls back to `DS_CONFIG.chart.valueFormat`, then the browser's locale
|
|
60
74
|
* grouping with a K/M/B suffix past four digits. */
|
|
61
75
|
readonly valueFormat: _angular_core.InputSignal<ChartValueFormat | null>;
|
|
76
|
+
readonly frameResolved: _angular_core.Signal<ChartFrame>;
|
|
62
77
|
readonly dataTableResolved: _angular_core.Signal<ChartDataTable>;
|
|
63
78
|
readonly emptyTextResolved: _angular_core.Signal<string>;
|
|
64
79
|
readonly errorTextResolved: _angular_core.Signal<string>;
|
|
@@ -70,6 +85,11 @@ declare class DonutChartComponent {
|
|
|
70
85
|
/** The slice that was clicked, or activated with Enter or Space. Fires whether or not
|
|
71
86
|
* `interactive` is set. */
|
|
72
87
|
readonly sliceClicked: _angular_core.OutputEmitterRef<DonutChartSlice>;
|
|
88
|
+
/** Holds the hovered mark and its tooltip in place when it is clicked, until Escape or a press
|
|
89
|
+
* outside releases it. Off by default: a click is already the drill-down hook, and a mark left
|
|
90
|
+
* lit after the pointer has gone needs a reader who knows why it is lit. `sliceClicked` fires
|
|
91
|
+
* either way — pinning is a state, not a handler. */
|
|
92
|
+
readonly pinOnClick: _angular_core.InputSignalWithTransform<boolean, unknown>;
|
|
73
93
|
/** Dims every OTHER mark while one is hovered or focused, so the reader's eye is held on the
|
|
74
94
|
* one under the pointer. Off by default: the dimming costs the separation BETWEEN the dimmed
|
|
75
95
|
* marks — measured 2026-09-13, the worst pair of three dimmed series falls from dE 14.8 at full
|
|
@@ -86,7 +106,9 @@ declare class DonutChartComponent {
|
|
|
86
106
|
protected readonly tooltipTemplate: _angular_core.Signal<TemplateRef<{
|
|
87
107
|
$implicit: ChartTooltipContext;
|
|
88
108
|
}> | undefined>;
|
|
109
|
+
private readonly tooltipLingerResolved;
|
|
89
110
|
protected readonly activeMark: _ids_group_ltd_ids_design_system_components_chart_tooltip.ChartActiveMark;
|
|
111
|
+
protected onMarkClick(payload: DonutChartSlice, index: number, event: Event): void;
|
|
90
112
|
/** One tab stop per chart, not one per slice: WCAG 2.1.1's Understanding is explicit that not
|
|
91
113
|
* every mouse-operable control has to be separately focusable. */
|
|
92
114
|
protected readonly rovingIndex: _angular_core.WritableSignal<number>;
|
|
@@ -99,6 +121,10 @@ declare class DonutChartComponent {
|
|
|
99
121
|
protected readonly visibleSlices: _angular_core.Signal<DonutChartSlice[]>;
|
|
100
122
|
protected readonly slices: _angular_core.Signal<{
|
|
101
123
|
slice: DonutChartSlice;
|
|
124
|
+
center: {
|
|
125
|
+
x: number;
|
|
126
|
+
y: number;
|
|
127
|
+
};
|
|
102
128
|
path: string;
|
|
103
129
|
color: string;
|
|
104
130
|
formattedValue: string;
|
|
@@ -120,7 +146,7 @@ declare class DonutChartComponent {
|
|
|
120
146
|
* is still empty. */
|
|
121
147
|
protected readonly skeletonRows: _angular_core.Signal<unknown[]>;
|
|
122
148
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<DonutChartComponent, never>;
|
|
123
|
-
static ɵcmp: _angular_core.ɵɵComponentDeclaration<DonutChartComponent, "ds-donut-chart", never, { "data": { "alias": "data"; "required": true; "isSignal": true; }; "centerValue": { "alias": "centerValue"; "required": false; "isSignal": true; }; "centerLabel": { "alias": "centerLabel"; "required": false; "isSignal": true; }; "legend": { "alias": "legend"; "required": false; "isSignal": true; }; "maxSlices": { "alias": "maxSlices"; "required": false; "isSignal": true; }; "otherLabel": { "alias": "otherLabel"; "required": false; "isSignal": true; }; "thickness": { "alias": "thickness"; "required": false; "isSignal": true; }; "caption": { "alias": "caption"; "required": false; "isSignal": true; }; "summary": { "alias": "summary"; "required": false; "isSignal": true; }; "dataTable": { "alias": "dataTable"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; "emptyText": { "alias": "emptyText"; "required": false; "isSignal": true; }; "error": { "alias": "error"; "required": false; "isSignal": true; }; "errorText": { "alias": "errorText"; "required": false; "isSignal": true; }; "valueFormat": { "alias": "valueFormat"; "required": false; "isSignal": true; }; "interactive": { "alias": "interactive"; "required": false; "isSignal": true; }; "dimOthers": { "alias": "dimOthers"; "required": false; "isSignal": true; }; "staggerMs": { "alias": "staggerMs"; "required": false; "isSignal": true; }; "tooltip": { "alias": "tooltip"; "required": false; "isSignal": true; }; }, { "sliceClicked": "sliceClicked"; }, ["tooltipTemplate"], never, true, never>;
|
|
149
|
+
static ɵcmp: _angular_core.ɵɵComponentDeclaration<DonutChartComponent, "ds-donut-chart", never, { "data": { "alias": "data"; "required": true; "isSignal": true; }; "centerValue": { "alias": "centerValue"; "required": false; "isSignal": true; }; "centerLabel": { "alias": "centerLabel"; "required": false; "isSignal": true; }; "legend": { "alias": "legend"; "required": false; "isSignal": true; }; "maxSlices": { "alias": "maxSlices"; "required": false; "isSignal": true; }; "otherLabel": { "alias": "otherLabel"; "required": false; "isSignal": true; }; "thickness": { "alias": "thickness"; "required": false; "isSignal": true; }; "frame": { "alias": "frame"; "required": false; "isSignal": true; }; "tooltipLingerMs": { "alias": "tooltipLingerMs"; "required": false; "isSignal": true; }; "caption": { "alias": "caption"; "required": false; "isSignal": true; }; "summary": { "alias": "summary"; "required": false; "isSignal": true; }; "dataTable": { "alias": "dataTable"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; "emptyText": { "alias": "emptyText"; "required": false; "isSignal": true; }; "error": { "alias": "error"; "required": false; "isSignal": true; }; "errorText": { "alias": "errorText"; "required": false; "isSignal": true; }; "valueFormat": { "alias": "valueFormat"; "required": false; "isSignal": true; }; "interactive": { "alias": "interactive"; "required": false; "isSignal": true; }; "pinOnClick": { "alias": "pinOnClick"; "required": false; "isSignal": true; }; "dimOthers": { "alias": "dimOthers"; "required": false; "isSignal": true; }; "staggerMs": { "alias": "staggerMs"; "required": false; "isSignal": true; }; "tooltip": { "alias": "tooltip"; "required": false; "isSignal": true; }; }, { "sliceClicked": "sliceClicked"; }, ["tooltipTemplate"], never, true, never>;
|
|
124
150
|
}
|
|
125
151
|
|
|
126
152
|
export { DonutChartComponent };
|
|
@@ -2,13 +2,20 @@ import * as _ids_group_ltd_ids_design_system_components_chart_tooltip from '@ids
|
|
|
2
2
|
import { ChartItemTooltipTrigger, ChartTooltipContext } from '@ids-group-ltd/ids-design-system/components/chart-tooltip';
|
|
3
3
|
import * as _angular_core from '@angular/core';
|
|
4
4
|
import { TemplateRef } from '@angular/core';
|
|
5
|
-
import { ChartDataTable, ChartValueFormat } from '@ids-group-ltd/ids-design-system/core';
|
|
5
|
+
import { ChartFrame, ChartDataTable, ChartValueFormat } from '@ids-group-ltd/ids-design-system/core';
|
|
6
6
|
|
|
7
7
|
interface FunnelChartStage {
|
|
8
8
|
id: string;
|
|
9
9
|
label: string;
|
|
10
10
|
value: number;
|
|
11
11
|
}
|
|
12
|
+
/** What the Drop column reports. `'relative'` is the share that leaked at this stage,
|
|
13
|
+
* `'absolute'` the COUNT that leaked, `'none'` drops the column.
|
|
14
|
+
*
|
|
15
|
+
* Both answer real questions and they are not the same question: on a settlement funnel the share
|
|
16
|
+
* is a talking point and the count is a re-targeting job. The count is recoverable by subtracting
|
|
17
|
+
* two rows, but a reader should not have to. */
|
|
18
|
+
type FunnelChartDrop = 'relative' | 'absolute' | 'none';
|
|
12
19
|
/** How a stage's geometry encodes its value. `'area'` is the default; `'taper'` encodes nothing —
|
|
13
20
|
* the silhouette is fixed whatever the data. See `funnelGeometry`. */
|
|
14
21
|
type FunnelChartShape = 'taper' | 'width' | 'area';
|
|
@@ -27,6 +34,20 @@ declare class FunnelChartComponent {
|
|
|
27
34
|
* `dataTable`: while this is on, the disclosure every chart carries would
|
|
28
35
|
* repeat a strict subset of these same numbers, so it is not rendered. */
|
|
29
36
|
readonly showTable: _angular_core.InputSignalWithTransform<boolean, unknown>;
|
|
37
|
+
/** Whether the chart draws its own bordered, padded box. `'auto'`, the default, draws it;
|
|
38
|
+
* `'none'` leaves the chart bare, for one placed inside a card the page has already drawn.
|
|
39
|
+
* Unset falls back to `DS_CONFIG.chart.frame`, then `'auto'` — whether charts live inside cards
|
|
40
|
+
* is one decision per app rather than per plot. */
|
|
41
|
+
readonly frame: _angular_core.InputSignal<ChartFrame | null>;
|
|
42
|
+
/** How long the tooltip stays after the pointer leaves the mark, in milliseconds. Zero, the
|
|
43
|
+
* default, takes it away at once: a panel that outlives the pointer sits over the plot the
|
|
44
|
+
* reader has moved on to.
|
|
45
|
+
*
|
|
46
|
+
* Raise it only for a panel a reader has to REACH — one carrying a link, a figure, or anything
|
|
47
|
+
* selectable — which is WCAG 1.4.13's hoverable clause. The panel is portaled to the body, so
|
|
48
|
+
* crossing the gap to it at an ordinary pointer speed needs about 140. Unset falls back to
|
|
49
|
+
* `DS_CONFIG.chart.tooltipLingerMs`, then 0. */
|
|
50
|
+
readonly tooltipLingerMs: _angular_core.InputSignalWithTransform<number | null, number | null>;
|
|
30
51
|
/** Printed above the plot as the chart's visible title, and reused as the annex table's
|
|
31
52
|
* caption. */
|
|
32
53
|
readonly caption: _angular_core.InputSignal<string | null>;
|
|
@@ -36,6 +57,9 @@ declare class FunnelChartComponent {
|
|
|
36
57
|
* already prints every label and value. Unset falls back to `DS_CONFIG.chart.dataTable`, then
|
|
37
58
|
* `'toggle'`. */
|
|
38
59
|
readonly dataTable: _angular_core.InputSignal<ChartDataTable | null>;
|
|
60
|
+
/** What the Drop column reports: `'relative'` (the default) the share that leaked at this
|
|
61
|
+
* stage, `'absolute'` the count, `'none'` no column at all. */
|
|
62
|
+
readonly drop: _angular_core.InputSignal<FunnelChartDrop>;
|
|
39
63
|
/** Draws skeleton marks in place of the data, at the same count, so the chart does not resize
|
|
40
64
|
* when the data lands. */
|
|
41
65
|
readonly loading: _angular_core.InputSignalWithTransform<boolean, unknown>;
|
|
@@ -53,6 +77,7 @@ declare class FunnelChartComponent {
|
|
|
53
77
|
* included. Unset falls back to `DS_CONFIG.chart.valueFormat`, then the browser's locale
|
|
54
78
|
* grouping with a K/M/B suffix past four digits. */
|
|
55
79
|
readonly valueFormat: _angular_core.InputSignal<ChartValueFormat | null>;
|
|
80
|
+
readonly frameResolved: _angular_core.Signal<ChartFrame>;
|
|
56
81
|
readonly dataTableResolved: _angular_core.Signal<ChartDataTable>;
|
|
57
82
|
readonly emptyTextResolved: _angular_core.Signal<string>;
|
|
58
83
|
readonly errorTextResolved: _angular_core.Signal<string>;
|
|
@@ -64,6 +89,11 @@ declare class FunnelChartComponent {
|
|
|
64
89
|
/** The stage that was clicked, or activated with Enter or Space. Fires whether or not
|
|
65
90
|
* `interactive` is set. */
|
|
66
91
|
readonly stageClicked: _angular_core.OutputEmitterRef<FunnelChartStage>;
|
|
92
|
+
/** Holds the hovered mark and its tooltip in place when it is clicked, until Escape or a press
|
|
93
|
+
* outside releases it. Off by default: a click is already the drill-down hook, and a mark left
|
|
94
|
+
* lit after the pointer has gone needs a reader who knows why it is lit. `stageClicked` fires
|
|
95
|
+
* either way — pinning is a state, not a handler. */
|
|
96
|
+
readonly pinOnClick: _angular_core.InputSignalWithTransform<boolean, unknown>;
|
|
67
97
|
/** Dims every OTHER mark while one is hovered or focused, so the reader's eye is held on the
|
|
68
98
|
* one under the pointer. Off by default: the dimming costs the separation BETWEEN the dimmed
|
|
69
99
|
* marks — measured 2026-09-13, the worst pair of three dimmed series falls from dE 14.8 at full
|
|
@@ -81,7 +111,16 @@ declare class FunnelChartComponent {
|
|
|
81
111
|
protected readonly tooltipTemplate: _angular_core.Signal<TemplateRef<{
|
|
82
112
|
$implicit: ChartTooltipContext;
|
|
83
113
|
}> | undefined>;
|
|
114
|
+
private readonly tooltipLingerResolved;
|
|
84
115
|
protected readonly activeMark: _ids_group_ltd_ids_design_system_components_chart_tooltip.ChartActiveMark;
|
|
116
|
+
/** Where the badge goes, as a percentage of the shape's box. Percentages rather than viewBox
|
|
117
|
+
* units because this svg is `preserveAspectRatio="none"`: it stretches horizontally with the
|
|
118
|
+
* card, and anything measured in user units stretches with it. */
|
|
119
|
+
protected readonly pinnedCenter: _angular_core.Signal<{
|
|
120
|
+
xPercent: number;
|
|
121
|
+
yPercent: number;
|
|
122
|
+
} | null>;
|
|
123
|
+
protected onMarkClick(payload: FunnelChartStage, index: number, event: Event): void;
|
|
85
124
|
/** One tab stop per chart, not one per mark: WCAG 2.1.1's Understanding is explicit that not
|
|
86
125
|
* every mouse-operable control has to be separately focusable, and that is what keeps a
|
|
87
126
|
* twenty-five mark chart from being twenty-five stops in the page's tab order. */
|
|
@@ -97,6 +136,10 @@ declare class FunnelChartComponent {
|
|
|
97
136
|
protected readonly hitGapUnits: _angular_core.Signal<number>;
|
|
98
137
|
protected readonly stages: _angular_core.Signal<{
|
|
99
138
|
stage: FunnelChartStage;
|
|
139
|
+
center: {
|
|
140
|
+
x: number;
|
|
141
|
+
y: number;
|
|
142
|
+
};
|
|
100
143
|
points: string;
|
|
101
144
|
formattedValue: string;
|
|
102
145
|
formattedPercent: string;
|
|
@@ -121,8 +164,8 @@ declare class FunnelChartComponent {
|
|
|
121
164
|
* table's skeleton rows. */
|
|
122
165
|
protected readonly skeletonStages: _angular_core.Signal<("88%" | "62%" | "80%" | "54%" | "72%")[]>;
|
|
123
166
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<FunnelChartComponent, never>;
|
|
124
|
-
static ɵcmp: _angular_core.ɵɵComponentDeclaration<FunnelChartComponent, "ds-funnel-chart", never, { "data": { "alias": "data"; "required": true; "isSignal": true; }; "shape": { "alias": "shape"; "required": false; "isSignal": true; }; "showTable": { "alias": "showTable"; "required": false; "isSignal": true; }; "caption": { "alias": "caption"; "required": false; "isSignal": true; }; "summary": { "alias": "summary"; "required": false; "isSignal": true; }; "dataTable": { "alias": "dataTable"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; "emptyText": { "alias": "emptyText"; "required": false; "isSignal": true; }; "error": { "alias": "error"; "required": false; "isSignal": true; }; "errorText": { "alias": "errorText"; "required": false; "isSignal": true; }; "valueFormat": { "alias": "valueFormat"; "required": false; "isSignal": true; }; "interactive": { "alias": "interactive"; "required": false; "isSignal": true; }; "dimOthers": { "alias": "dimOthers"; "required": false; "isSignal": true; }; "staggerMs": { "alias": "staggerMs"; "required": false; "isSignal": true; }; "tooltip": { "alias": "tooltip"; "required": false; "isSignal": true; }; }, { "stageClicked": "stageClicked"; }, ["tooltipTemplate"], never, true, never>;
|
|
167
|
+
static ɵcmp: _angular_core.ɵɵComponentDeclaration<FunnelChartComponent, "ds-funnel-chart", never, { "data": { "alias": "data"; "required": true; "isSignal": true; }; "shape": { "alias": "shape"; "required": false; "isSignal": true; }; "showTable": { "alias": "showTable"; "required": false; "isSignal": true; }; "frame": { "alias": "frame"; "required": false; "isSignal": true; }; "tooltipLingerMs": { "alias": "tooltipLingerMs"; "required": false; "isSignal": true; }; "caption": { "alias": "caption"; "required": false; "isSignal": true; }; "summary": { "alias": "summary"; "required": false; "isSignal": true; }; "dataTable": { "alias": "dataTable"; "required": false; "isSignal": true; }; "drop": { "alias": "drop"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; "emptyText": { "alias": "emptyText"; "required": false; "isSignal": true; }; "error": { "alias": "error"; "required": false; "isSignal": true; }; "errorText": { "alias": "errorText"; "required": false; "isSignal": true; }; "valueFormat": { "alias": "valueFormat"; "required": false; "isSignal": true; }; "interactive": { "alias": "interactive"; "required": false; "isSignal": true; }; "pinOnClick": { "alias": "pinOnClick"; "required": false; "isSignal": true; }; "dimOthers": { "alias": "dimOthers"; "required": false; "isSignal": true; }; "staggerMs": { "alias": "staggerMs"; "required": false; "isSignal": true; }; "tooltip": { "alias": "tooltip"; "required": false; "isSignal": true; }; }, { "stageClicked": "stageClicked"; }, ["tooltipTemplate"], never, true, never>;
|
|
125
168
|
}
|
|
126
169
|
|
|
127
170
|
export { FunnelChartComponent };
|
|
128
|
-
export type { FunnelChartShape, FunnelChartStage };
|
|
171
|
+
export type { FunnelChartDrop, FunnelChartShape, FunnelChartStage };
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as _ids_group_ltd_ids_design_system_components from '@ids-group-ltd/ids-design-system/components';
|
|
2
2
|
import * as _angular_core from '@angular/core';
|
|
3
3
|
import { TemplateRef } from '@angular/core';
|
|
4
|
-
import { ChartDataTable, ChartValueFormat } from '@ids-group-ltd/ids-design-system/core';
|
|
4
|
+
import { ChartFrame, ChartDataTable, ChartValueFormat } from '@ids-group-ltd/ids-design-system/core';
|
|
5
5
|
import { ChartLegendItem } from '@ids-group-ltd/ids-design-system/components/chart-legend';
|
|
6
6
|
import { ChartTooltipTrigger, ChartTooltipContext, ChartTooltipOrigin } from '@ids-group-ltd/ids-design-system/components/chart-tooltip';
|
|
7
7
|
|
|
@@ -29,6 +29,17 @@ interface LineChartSeries {
|
|
|
29
29
|
type LineChartAxisMode = 'rounded' | 'exact' | 'independent' | 'stacked';
|
|
30
30
|
/** What a `null` reading draws: a hole in the line, or a point at zero. */
|
|
31
31
|
type LineChartGaps = 'break' | 'zero';
|
|
32
|
+
/** A label pinned to one reading, so the point it names is legible with no pointer — a peak, a
|
|
33
|
+
* launch, the month a number turned. The tooltip answers "what is this?" on hover; an annotation
|
|
34
|
+
* answers it in a printed page or a screenshot. */
|
|
35
|
+
interface LineChartAnnotation {
|
|
36
|
+
/** 0-based position along the category axis. */
|
|
37
|
+
readonly categoryIndex: number;
|
|
38
|
+
readonly label: string;
|
|
39
|
+
/** Which series the reading belongs to. Left out, the first plotted one. An annotation whose
|
|
40
|
+
* series is hidden, or whose reading is `null`, draws nothing. */
|
|
41
|
+
readonly seriesId?: string;
|
|
42
|
+
}
|
|
32
43
|
/** One reading, named by the series it belongs to and the category it sits under. */
|
|
33
44
|
interface LineChartPoint {
|
|
34
45
|
readonly series: LineChartSeries;
|
|
@@ -99,6 +110,10 @@ declare class LineChartComponent {
|
|
|
99
110
|
readonly yAxisMode: _angular_core.InputSignal<LineChartAxisMode>;
|
|
100
111
|
/** Draws a dot at every reading. Off, the dots appear on hover and on focus only. */
|
|
101
112
|
readonly showMarkers: _angular_core.InputSignalWithTransform<boolean, unknown>;
|
|
113
|
+
/** Labels pinned over their readings, for the points that have to read without a pointer. They
|
|
114
|
+
* are drawn, not announced: the data table already carries every reading, and repeating one in
|
|
115
|
+
* the plot makes a screen reader say it twice. */
|
|
116
|
+
readonly annotations: _angular_core.InputSignal<readonly LineChartAnnotation[]>;
|
|
102
117
|
/** Makes every reading focusable and clickable. A series drawn without markers grows invisible
|
|
103
118
|
* ones so there is something to land on; they appear on hover and on focus.
|
|
104
119
|
*
|
|
@@ -108,6 +123,12 @@ declare class LineChartComponent {
|
|
|
108
123
|
/** The point that was clicked, or activated with Enter or Space. Fires whether or not
|
|
109
124
|
* `interactive` is set. */
|
|
110
125
|
readonly pointClicked: _angular_core.OutputEmitterRef<LineChartPoint>;
|
|
126
|
+
/** Holds the crosshair and its tooltip on the category that was clicked, until Escape or a
|
|
127
|
+
* press outside releases it. Off by default: a click is already the drill-down hook, and a
|
|
128
|
+
* crosshair left standing after the pointer has gone needs a reader who knows why. `pointClicked`
|
|
129
|
+
* fires either way — pinning is a state, not a handler. */
|
|
130
|
+
readonly pinOnClick: _angular_core.InputSignalWithTransform<boolean, unknown>;
|
|
131
|
+
protected readonly pinnedCategory: _angular_core.WritableSignal<boolean>;
|
|
111
132
|
/** Dims every OTHER mark while one is hovered or focused, so the reader's eye is held on the
|
|
112
133
|
* one under the pointer. Off by default: the dimming costs the separation BETWEEN the dimmed
|
|
113
134
|
* marks — measured 2026-09-13, the worst pair of three dimmed series falls from dE 14.8 at full
|
|
@@ -120,6 +141,20 @@ declare class LineChartComponent {
|
|
|
120
141
|
/** How many value-axis ticks to aim for. A hint, not a count: ticks snap to a round step, so
|
|
121
142
|
* the axis may carry one more or one fewer. */
|
|
122
143
|
readonly tickCount: _angular_core.InputSignalWithTransform<number, unknown>;
|
|
144
|
+
/** Whether the chart draws its own bordered, padded box. `'auto'`, the default, draws it;
|
|
145
|
+
* `'none'` leaves the chart bare, for one placed inside a card the page has already drawn.
|
|
146
|
+
* Unset falls back to `DS_CONFIG.chart.frame`, then `'auto'` — whether charts live inside cards
|
|
147
|
+
* is one decision per app rather than per plot. */
|
|
148
|
+
readonly frame: _angular_core.InputSignal<ChartFrame | null>;
|
|
149
|
+
/** How long the tooltip stays after the pointer leaves the mark, in milliseconds. Zero, the
|
|
150
|
+
* default, takes it away at once: a panel that outlives the pointer sits over the plot the
|
|
151
|
+
* reader has moved on to.
|
|
152
|
+
*
|
|
153
|
+
* Raise it only for a panel a reader has to REACH — one carrying a link, a figure, or anything
|
|
154
|
+
* selectable — which is WCAG 1.4.13's hoverable clause. The panel is portaled to the body, so
|
|
155
|
+
* crossing the gap to it at an ordinary pointer speed needs about 140. Unset falls back to
|
|
156
|
+
* `DS_CONFIG.chart.tooltipLingerMs`, then 0. */
|
|
157
|
+
readonly tooltipLingerMs: _angular_core.InputSignalWithTransform<number | null, number | null>;
|
|
123
158
|
/** Printed above the plot as the chart's visible title, and reused as the annex table's
|
|
124
159
|
* caption. */
|
|
125
160
|
readonly caption: _angular_core.InputSignal<string | null>;
|
|
@@ -128,8 +163,20 @@ declare class LineChartComponent {
|
|
|
128
163
|
/** The label-and-value table under the plot: `'toggle'` puts it behind a disclosure,
|
|
129
164
|
* `'visible'` opens it, `'none'` renders none. It is the non-visual route to the numbers, so
|
|
130
165
|
* `'none'` belongs only where the same data is already in a table on the page.
|
|
131
|
-
* Unset falls back to `DS_CONFIG.chart.dataTable`, then `'
|
|
166
|
+
* Unset falls back to `DS_CONFIG.chart.dataTable`, then `'none'`. */
|
|
132
167
|
readonly dataTable: _angular_core.InputSignal<ChartDataTable | null>;
|
|
168
|
+
/** Pins the value axis instead of deriving it from the data. A panel opened one subject at a
|
|
169
|
+
* time — one agent, one microsite — derives a different axis for each of them, so two plots with
|
|
170
|
+
* the same gentle wiggle can be four times apart in value and nothing on screen says so. A fixed
|
|
171
|
+
* maximum is what makes two renders comparable.
|
|
172
|
+
*
|
|
173
|
+
* Null, the default, keeps the derived axis. Applies to the primary axis; `maxSecondary` pins
|
|
174
|
+
* the second one where a series sets `axis: 'secondary'`. A maximum below the data does not clip
|
|
175
|
+
* it — the larger of the two wins, because silently hiding a reading is worse than a taller axis
|
|
176
|
+
* than you asked for. */
|
|
177
|
+
readonly max: _angular_core.InputSignal<number | null>;
|
|
178
|
+
/** Pins the secondary value axis. See `max`. */
|
|
179
|
+
readonly maxSecondary: _angular_core.InputSignal<number | null>;
|
|
133
180
|
/** Draws skeleton marks in place of the data, at the same count, so the chart does not resize
|
|
134
181
|
* when the data lands. */
|
|
135
182
|
readonly loading: _angular_core.InputSignalWithTransform<boolean, unknown>;
|
|
@@ -147,6 +194,7 @@ declare class LineChartComponent {
|
|
|
147
194
|
* included. Unset falls back to `DS_CONFIG.chart.valueFormat`, then the browser's locale
|
|
148
195
|
* grouping with a K/M/B suffix past four digits. */
|
|
149
196
|
readonly valueFormat: _angular_core.InputSignal<ChartValueFormat | null>;
|
|
197
|
+
readonly frameResolved: _angular_core.Signal<ChartFrame>;
|
|
150
198
|
readonly dataTableResolved: _angular_core.Signal<ChartDataTable>;
|
|
151
199
|
readonly emptyTextResolved: _angular_core.Signal<string>;
|
|
152
200
|
readonly errorTextResolved: _angular_core.Signal<string>;
|
|
@@ -162,6 +210,12 @@ declare class LineChartComponent {
|
|
|
162
210
|
readonly rescaleOnHide: _angular_core.InputSignalWithTransform<boolean, unknown>;
|
|
163
211
|
/** Whether the legend switches series off. Off leaves it a plain key. */
|
|
164
212
|
readonly legendFilters: _angular_core.InputSignalWithTransform<boolean, unknown>;
|
|
213
|
+
/** What a legend control does. `'isolate'` shows one series and hides the rest — one action to
|
|
214
|
+
* answer "show me only this" rather than one per series. `'toggle'` hides one and leaves the
|
|
215
|
+
* rest, for taking a dominant series out so the others can be read at a usable scale.
|
|
216
|
+
* Forwarded to `ds-chart-legend`, which renders radios for the first and checkboxes for the
|
|
217
|
+
* second. */
|
|
218
|
+
readonly legendMode: _angular_core.InputSignal<"toggle" | "isolate">;
|
|
165
219
|
/** Shown in place of the plot once the legend has switched every series off. Without it the
|
|
166
220
|
* reader is left with an empty grid and nothing saying why. */
|
|
167
221
|
readonly noVisibleSeriesText: _angular_core.InputSignal<string>;
|
|
@@ -184,6 +238,16 @@ declare class LineChartComponent {
|
|
|
184
238
|
protected readonly axes: _angular_core.Signal<AxisLayout>;
|
|
185
239
|
protected readonly categoryPositions: _angular_core.Signal<number[]>;
|
|
186
240
|
protected readonly plottedSeries: _angular_core.Signal<readonly PlottedSeries[]>;
|
|
241
|
+
/** Annotations resolved onto the markers the plot already computed, so a label sits exactly on
|
|
242
|
+
* its reading and moves with it. One whose series is hidden or whose reading is missing has no
|
|
243
|
+
* marker and is dropped — a hidden series must not leave its label floating over the plot. */
|
|
244
|
+
protected readonly placedAnnotations: _angular_core.Signal<{
|
|
245
|
+
key: string;
|
|
246
|
+
label: string;
|
|
247
|
+
x: number;
|
|
248
|
+
y: number;
|
|
249
|
+
anchor: string;
|
|
250
|
+
}[]>;
|
|
187
251
|
protected readonly primaryTicks: _angular_core.Signal<AxisTick[]>;
|
|
188
252
|
protected readonly secondaryTicks: _angular_core.Signal<readonly AxisTick[]>;
|
|
189
253
|
/** Drawn only when the two axes do not share the primary's gridlines, and only
|
|
@@ -192,8 +256,9 @@ declare class LineChartComponent {
|
|
|
192
256
|
protected readonly stacked: _angular_core.Signal<boolean>;
|
|
193
257
|
protected readonly categoryLabelY: _angular_core.Signal<number>;
|
|
194
258
|
/** The category under the pointer, or -1. */
|
|
259
|
+
private readonly host;
|
|
195
260
|
protected readonly activeCategory: _angular_core.WritableSignal<number>;
|
|
196
|
-
protected readonly categoryBands: _angular_core.Signal<_ids_group_ltd_ids_design_system_components.
|
|
261
|
+
protected readonly categoryBands: _angular_core.Signal<_ids_group_ltd_ids_design_system_components.PointScale>;
|
|
197
262
|
protected readonly activeBandX: _angular_core.Signal<number>;
|
|
198
263
|
protected readonly activeBandWidth: _angular_core.Signal<number>;
|
|
199
264
|
protected readonly activeCategoryX: _angular_core.Signal<number>;
|
|
@@ -203,6 +268,14 @@ declare class LineChartComponent {
|
|
|
203
268
|
* it over the readings it names instead of over the finger. */
|
|
204
269
|
private readingAnchor;
|
|
205
270
|
protected clearActiveCategory(): void;
|
|
271
|
+
/** The panel is portaled to the body, so the plot never sees the pointer arrive on it. This is
|
|
272
|
+
* the other half of the grace period: reaching the panel keeps it open, and leaving the panel for
|
|
273
|
+
* anything that is not the plot starts the clear the plot can no longer start itself. */
|
|
274
|
+
protected onPointerAnywhere(event: PointerEvent): void;
|
|
275
|
+
private cancelCategoryClear;
|
|
276
|
+
private readonly tooltipLingerResolved;
|
|
277
|
+
private pendingCategoryClear;
|
|
278
|
+
protected releaseCategoryPin(): void;
|
|
206
279
|
/** Whether the plot opens a tooltip, and for what. `'axis'` names every series at the
|
|
207
280
|
* category under the pointer, which is the reading a multi-series line is compared on;
|
|
208
281
|
* `'item'` names only the marker itself. */
|
|
@@ -241,7 +314,7 @@ declare class LineChartComponent {
|
|
|
241
314
|
protected readonly cursorBottomY: _angular_core.Signal<number>;
|
|
242
315
|
protected readonly primaryLabelX: _angular_core.Signal<number>;
|
|
243
316
|
protected readonly secondaryLabelX: _angular_core.Signal<number>;
|
|
244
|
-
protected readonly secondaryLabelAnchor: _angular_core.Signal<"
|
|
317
|
+
protected readonly secondaryLabelAnchor: _angular_core.Signal<"start" | "end">;
|
|
245
318
|
protected readonly categoryLabels: _angular_core.Signal<readonly CategoryLabel[]>;
|
|
246
319
|
protected readonly tableRows: _angular_core.Signal<{
|
|
247
320
|
category: string;
|
|
@@ -251,6 +324,10 @@ declare class LineChartComponent {
|
|
|
251
324
|
protected pointOf(entry: PlottedSeries, marker: LinePoint): LineChartPoint;
|
|
252
325
|
protected markerLabel(entry: PlottedSeries, marker: LinePoint): string;
|
|
253
326
|
protected onMarkerKey(entry: PlottedSeries, marker: LinePoint, event: Event): void;
|
|
327
|
+
/** The pin hangs off the MARKER, not off the plot: the marker is already focusable and already
|
|
328
|
+
* answers Enter and Space, so the keyboard gets the pin for free. A click handler on the plot
|
|
329
|
+
* would have no keyboard route at all. A second activation of the pinned category releases it. */
|
|
330
|
+
protected onMarkerClick(entry: PlottedSeries, marker: LinePoint): void;
|
|
254
331
|
protected readonly isEmpty: _angular_core.Signal<boolean>;
|
|
255
332
|
protected readonly showLegend: _angular_core.Signal<boolean>;
|
|
256
333
|
protected readonly noVisibleSeries: _angular_core.Signal<boolean>;
|
|
@@ -261,8 +338,8 @@ declare class LineChartComponent {
|
|
|
261
338
|
private plotFor;
|
|
262
339
|
private ticksFor;
|
|
263
340
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<LineChartComponent, never>;
|
|
264
|
-
static ɵcmp: _angular_core.ɵɵComponentDeclaration<LineChartComponent, "ds-line-chart", never, { "categories": { "alias": "categories"; "required": true; "isSignal": true; }; "series": { "alias": "series"; "required": true; "isSignal": true; }; "yAxisMode": { "alias": "yAxisMode"; "required": false; "isSignal": true; }; "showMarkers": { "alias": "showMarkers"; "required": false; "isSignal": true; }; "interactive": { "alias": "interactive"; "required": false; "isSignal": true; }; "dimOthers": { "alias": "dimOthers"; "required": false; "isSignal": true; }; "gaps": { "alias": "gaps"; "required": false; "isSignal": true; }; "tickCount": { "alias": "tickCount"; "required": false; "isSignal": true; }; "caption": { "alias": "caption"; "required": false; "isSignal": true; }; "summary": { "alias": "summary"; "required": false; "isSignal": true; }; "dataTable": { "alias": "dataTable"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; "emptyText": { "alias": "emptyText"; "required": false; "isSignal": true; }; "error": { "alias": "error"; "required": false; "isSignal": true; }; "errorText": { "alias": "errorText"; "required": false; "isSignal": true; }; "valueFormat": { "alias": "valueFormat"; "required": false; "isSignal": true; }; "hiddenSeries": { "alias": "hiddenSeries"; "required": false; "isSignal": true; }; "rescaleOnHide": { "alias": "rescaleOnHide"; "required": false; "isSignal": true; }; "legendFilters": { "alias": "legendFilters"; "required": false; "isSignal": true; }; "noVisibleSeriesText": { "alias": "noVisibleSeriesText"; "required": false; "isSignal": true; }; "patterns": { "alias": "patterns"; "required": false; "isSignal": true; }; "staggerMs": { "alias": "staggerMs"; "required": false; "isSignal": true; }; "tooltip": { "alias": "tooltip"; "required": false; "isSignal": true; }; "tooltipAnchor": { "alias": "tooltipAnchor"; "required": false; "isSignal": true; }; }, { "pointClicked": "pointClicked"; "hiddenSeries": "hiddenSeriesChange"; }, ["tooltipTemplate"], never, true, never>;
|
|
341
|
+
static ɵcmp: _angular_core.ɵɵComponentDeclaration<LineChartComponent, "ds-line-chart", never, { "categories": { "alias": "categories"; "required": true; "isSignal": true; }; "series": { "alias": "series"; "required": true; "isSignal": true; }; "yAxisMode": { "alias": "yAxisMode"; "required": false; "isSignal": true; }; "showMarkers": { "alias": "showMarkers"; "required": false; "isSignal": true; }; "annotations": { "alias": "annotations"; "required": false; "isSignal": true; }; "interactive": { "alias": "interactive"; "required": false; "isSignal": true; }; "pinOnClick": { "alias": "pinOnClick"; "required": false; "isSignal": true; }; "dimOthers": { "alias": "dimOthers"; "required": false; "isSignal": true; }; "gaps": { "alias": "gaps"; "required": false; "isSignal": true; }; "tickCount": { "alias": "tickCount"; "required": false; "isSignal": true; }; "frame": { "alias": "frame"; "required": false; "isSignal": true; }; "tooltipLingerMs": { "alias": "tooltipLingerMs"; "required": false; "isSignal": true; }; "caption": { "alias": "caption"; "required": false; "isSignal": true; }; "summary": { "alias": "summary"; "required": false; "isSignal": true; }; "dataTable": { "alias": "dataTable"; "required": false; "isSignal": true; }; "max": { "alias": "max"; "required": false; "isSignal": true; }; "maxSecondary": { "alias": "maxSecondary"; "required": false; "isSignal": true; }; "loading": { "alias": "loading"; "required": false; "isSignal": true; }; "emptyText": { "alias": "emptyText"; "required": false; "isSignal": true; }; "error": { "alias": "error"; "required": false; "isSignal": true; }; "errorText": { "alias": "errorText"; "required": false; "isSignal": true; }; "valueFormat": { "alias": "valueFormat"; "required": false; "isSignal": true; }; "hiddenSeries": { "alias": "hiddenSeries"; "required": false; "isSignal": true; }; "rescaleOnHide": { "alias": "rescaleOnHide"; "required": false; "isSignal": true; }; "legendFilters": { "alias": "legendFilters"; "required": false; "isSignal": true; }; "legendMode": { "alias": "legendMode"; "required": false; "isSignal": true; }; "noVisibleSeriesText": { "alias": "noVisibleSeriesText"; "required": false; "isSignal": true; }; "patterns": { "alias": "patterns"; "required": false; "isSignal": true; }; "staggerMs": { "alias": "staggerMs"; "required": false; "isSignal": true; }; "tooltip": { "alias": "tooltip"; "required": false; "isSignal": true; }; "tooltipAnchor": { "alias": "tooltipAnchor"; "required": false; "isSignal": true; }; }, { "pointClicked": "pointClicked"; "hiddenSeries": "hiddenSeriesChange"; }, ["tooltipTemplate"], never, true, never>;
|
|
265
342
|
}
|
|
266
343
|
|
|
267
344
|
export { LineChartComponent };
|
|
268
|
-
export type { LineChartAxisMode, LineChartGaps, LineChartPoint, LineChartSeries };
|
|
345
|
+
export type { LineChartAnnotation, LineChartAxisMode, LineChartGaps, LineChartPoint, LineChartSeries };
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import * as _angular_core from '@angular/core';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* One track and one fill, for a measurement inside a table cell.
|
|
5
|
+
*
|
|
6
|
+
* A chart is a block with a caption, a legend and an annex table; in a 60px cell that chrome is
|
|
7
|
+
* the whole cell. This is the mark on its own — no caption, no legend, no tooltip, no table.
|
|
8
|
+
*
|
|
9
|
+
* It is NOT `ds-progress`, which reports how far a task has got and says so with
|
|
10
|
+
* `role="progressbar"`. A rate, a score or a count against a ceiling is a measurement: it has no
|
|
11
|
+
* beginning and no completion, and a table of two hundred of them would announce two hundred
|
|
12
|
+
* progress bars. Here the mark is hidden from assistive technology unless `ariaLabel` names it,
|
|
13
|
+
* because the cell beside it almost always prints the number already.
|
|
14
|
+
*/
|
|
15
|
+
declare class MeterComponent {
|
|
16
|
+
/** The measurement, in units of `max`. Clamped to the track. */
|
|
17
|
+
readonly value: _angular_core.InputSignalWithTransform<number, unknown>;
|
|
18
|
+
/** The ceiling `value` is read against — the column's own largest, or the scale the number
|
|
19
|
+
* means something on. Left at 100, `value` is a percentage. Zero or less falls back to 100,
|
|
20
|
+
* because a scale with no width has no fraction to draw. */
|
|
21
|
+
readonly max: _angular_core.InputSignalWithTransform<number, unknown>;
|
|
22
|
+
/** The fill's colour. Unset takes `--ds-meter-fill-color`, so a column is coloured once in a
|
|
23
|
+
* stylesheet rather than per row; set it per row where the colour carries meaning. */
|
|
24
|
+
readonly color: _angular_core.InputSignal<string | null>;
|
|
25
|
+
/** Names the measurement, and is what decides whether it is announced at all. Unset, the mark
|
|
26
|
+
* is `aria-hidden` — right where the cell prints the figure beside it, and wrong where the bar
|
|
27
|
+
* is the only place the number appears. */
|
|
28
|
+
readonly ariaLabel: _angular_core.InputSignal<string | null>;
|
|
29
|
+
protected readonly scale: _angular_core.Signal<number>;
|
|
30
|
+
protected readonly clamped: _angular_core.Signal<number>;
|
|
31
|
+
protected readonly percent: _angular_core.Signal<number>;
|
|
32
|
+
static ɵfac: _angular_core.ɵɵFactoryDeclaration<MeterComponent, never>;
|
|
33
|
+
static ɵcmp: _angular_core.ɵɵComponentDeclaration<MeterComponent, "ds-meter", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "max": { "alias": "max"; "required": false; "isSignal": true; }; "color": { "alias": "color"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
export { MeterComponent };
|
|
@@ -4,18 +4,36 @@ import { DsStatus } from '@ids-group-ltd/ids-design-system/core';
|
|
|
4
4
|
type ProgressVariant = 'default' | Exclude<DsStatus, 'info'>;
|
|
5
5
|
|
|
6
6
|
declare class ProgressComponent {
|
|
7
|
-
/** Progress 0–100; clamped, and ignored while
|
|
7
|
+
/** Progress in units of `max`, so 0–100 by default; clamped, and ignored while
|
|
8
|
+
* `indeterminate`. */
|
|
8
9
|
readonly value: _angular_core.InputSignal<number>;
|
|
10
|
+
/** The full scale `value` and `target` are read against. Left at 100 they are percentages, which
|
|
11
|
+
* is why nothing existing changes. Set it to the real total — `[value]="37" [max]="80"` — and
|
|
12
|
+
* the accessible name carries "37 of 80" rather than the 46% a caller would otherwise have to
|
|
13
|
+
* compute and a screen reader would read instead. Zero or less falls back to 100, because a
|
|
14
|
+
* scale with no width has no fraction to draw. */
|
|
15
|
+
readonly max: _angular_core.InputSignal<number>;
|
|
9
16
|
/** Colour variant — drives the success/warning/error styling. */
|
|
10
17
|
readonly variant: _angular_core.InputSignal<ProgressVariant>;
|
|
11
18
|
/** Indeterminate (unknown-duration) animation instead of a fixed `value`. */
|
|
12
19
|
readonly indeterminate: _angular_core.InputSignalWithTransform<boolean, unknown>;
|
|
13
|
-
/** Accessible name for the progress bar (e.g. "Upload progress").
|
|
20
|
+
/** Accessible name for the progress bar (e.g. "Upload progress"). With a `target` set, name the
|
|
21
|
+
* comparison here — the mark is drawn, and `role="progressbar"` has no second value to announce,
|
|
22
|
+
* so "Resolved 62% against a 75% target" is what reaches a screen reader. */
|
|
14
23
|
readonly ariaLabel: _angular_core.InputSignal<string | null>;
|
|
24
|
+
/** A second point on the same scale as `value`, drawn as a hairline across the track — a goal or
|
|
25
|
+
* a baseline to read `value` against. Clamped like `value`, ignored while `indeterminate`, and
|
|
26
|
+
* unset draws nothing. */
|
|
27
|
+
readonly target: _angular_core.InputSignal<number | null>;
|
|
28
|
+
protected readonly scale: _angular_core.Signal<number>;
|
|
15
29
|
protected readonly clampedValue: _angular_core.Signal<number>;
|
|
30
|
+
/** Width and offset are percentages of the track whatever the scale is. */
|
|
31
|
+
protected readonly valuePercent: _angular_core.Signal<number>;
|
|
32
|
+
protected readonly clampedTarget: _angular_core.Signal<number | null>;
|
|
33
|
+
protected readonly targetPercent: _angular_core.Signal<number | null>;
|
|
16
34
|
protected readonly isIndet: _angular_core.Signal<boolean>;
|
|
17
35
|
static ɵfac: _angular_core.ɵɵFactoryDeclaration<ProgressComponent, never>;
|
|
18
|
-
static ɵcmp: _angular_core.ɵɵComponentDeclaration<ProgressComponent, "ds-progress", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "variant": { "alias": "variant"; "required": false; "isSignal": true; }; "indeterminate": { "alias": "indeterminate"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
36
|
+
static ɵcmp: _angular_core.ɵɵComponentDeclaration<ProgressComponent, "ds-progress", never, { "value": { "alias": "value"; "required": false; "isSignal": true; }; "max": { "alias": "max"; "required": false; "isSignal": true; }; "variant": { "alias": "variant"; "required": false; "isSignal": true; }; "indeterminate": { "alias": "indeterminate"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "target": { "alias": "target"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
19
37
|
}
|
|
20
38
|
|
|
21
39
|
export { ProgressComponent };
|
|
@@ -56,13 +56,16 @@ declare function formatPercent(value: number, total: number): string;
|
|
|
56
56
|
declare function largestRemainder(values: readonly number[]): number[];
|
|
57
57
|
/** @internal */
|
|
58
58
|
declare function formatTick(value: number, step: number): string;
|
|
59
|
-
/** One mark's share of the total its siblings add up to.
|
|
59
|
+
/** One mark's share of the total its siblings add up to, as a bare percentage.
|
|
60
60
|
*
|
|
61
|
-
*
|
|
62
|
-
* that number tells the reader nothing they are not already looking at. The share is arithmetic
|
|
63
|
-
* the reader should not have to do. Empty for a lone mark, and empty for a reading that is not
|
|
61
|
+
* Empty for a lone mark, which is the whole of its own total, and empty for a reading that is not
|
|
64
62
|
* part of a total anyone can see: negatives and non-finite values are excluded from the total
|
|
65
|
-
* rather than subtracted from it.
|
|
63
|
+
* rather than subtracted from it, so a negative mark has no share rather than a misleading one.
|
|
64
|
+
*
|
|
65
|
+
* @internal */
|
|
66
|
+
declare function shareOfTotal(values: readonly number[], index: number): string;
|
|
67
|
+
/** The same share, phrased for a tooltip line, where no column header stands above it to say what
|
|
68
|
+
* the percentage is OF.
|
|
66
69
|
*
|
|
67
70
|
* @internal */
|
|
68
71
|
declare function describeShare(values: readonly number[], index: number): string;
|
|
@@ -85,6 +88,13 @@ declare function tickStep(ticks: readonly number[]): number;
|
|
|
85
88
|
/** @internal */
|
|
86
89
|
declare function linearScale(domainMax: number, rangeSize: number): (value: number) => number;
|
|
87
90
|
/** @internal */
|
|
91
|
+
interface PointScale {
|
|
92
|
+
readonly step: number;
|
|
93
|
+
readonly count: number;
|
|
94
|
+
position(index: number): number;
|
|
95
|
+
indexAt(offset: number): number;
|
|
96
|
+
}
|
|
97
|
+
/** @internal */
|
|
88
98
|
interface BandScale {
|
|
89
99
|
readonly bandWidth: number;
|
|
90
100
|
/** Centre to centre, so it exceeds `bandWidth` by the padding. */
|
|
@@ -96,6 +106,15 @@ interface BandScale {
|
|
|
96
106
|
* a caller branches on rather than clamps. */
|
|
97
107
|
indexAt(offset: number): number;
|
|
98
108
|
}
|
|
109
|
+
/** Positions for marks that sit AT a category rather than inside it — the readings of a line.
|
|
110
|
+
* The first is at the plot's start and the last at its end, so the run fills the axis rather than
|
|
111
|
+
* floating half a slot inside it. A single reading has no run to fill and takes the middle.
|
|
112
|
+
*
|
|
113
|
+
* `step` is the distance between neighbours, which is what a crosshair band is a slot of; at the
|
|
114
|
+
* two ends that slot is half outside the plot and the caller clamps it.
|
|
115
|
+
*
|
|
116
|
+
* @internal */
|
|
117
|
+
declare function pointScale(count: number, rangeSize: number): PointScale;
|
|
99
118
|
/** @internal */
|
|
100
119
|
declare function bandScale(count: number, rangeSize: number, paddingRatio: number): BandScale;
|
|
101
120
|
|
|
@@ -173,12 +192,19 @@ declare abstract class DsMessageBase {
|
|
|
173
192
|
/** Advisory text, shown when there is no error. */
|
|
174
193
|
readonly warning: i0.InputSignalWithTransform<string, string | null | undefined>;
|
|
175
194
|
/** Reserve the message-row height even when empty, so the control doesn't shift
|
|
176
|
-
* the layout below it when a hint/error appears.
|
|
177
|
-
* `
|
|
195
|
+
* the layout below it when a hint/error appears. What an unset value falls back
|
|
196
|
+
* to is the subclass's call, in `reserveMessageResolved`: a field takes
|
|
197
|
+
* `DS_CONFIG.field.reserveMessage`, a button does not. */
|
|
178
198
|
readonly reserveMessage: i0.InputSignalWithTransform<boolean | null, unknown>;
|
|
179
199
|
/** Glyph on the message line, overriding what the state resolves to. Unset
|
|
180
200
|
* follows `DS_CONFIG.field.stateIcons`; `false` removes the glyph here alone. */
|
|
181
201
|
readonly messageIcon: i0.InputSignal<false | IconName | null>;
|
|
202
|
+
/** Whether an unset `reserveMessage` falls back to `DS_CONFIG.field.reserveMessage`.
|
|
203
|
+
* True for a field, whose row reserves so its neighbours do not shift; `ds-button`
|
|
204
|
+
* turns it off, because a button is not in that column and an app-wide field
|
|
205
|
+
* setting would otherwise give every button an empty message row. Read lazily, so
|
|
206
|
+
* a subclass initializer running after this one still decides it. */
|
|
207
|
+
protected readonly reserveFollowsFieldDefault: boolean;
|
|
182
208
|
readonly reserveMessageResolved: i0.Signal<boolean>;
|
|
183
209
|
static ɵfac: i0.ɵɵFactoryDeclaration<DsMessageBase, never>;
|
|
184
210
|
static ɵdir: i0.ɵɵDirectiveDeclaration<DsMessageBase, never, never, { "hint": { "alias": "hint"; "required": false; "isSignal": true; }; "error": { "alias": "error"; "required": false; "isSignal": true; }; "warning": { "alias": "warning"; "required": false; "isSignal": true; }; "reserveMessage": { "alias": "reserveMessage"; "required": false; "isSignal": true; }; "messageIcon": { "alias": "messageIcon"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
@@ -801,5 +827,5 @@ interface DsTypeAhead {
|
|
|
801
827
|
/** @internal */
|
|
802
828
|
declare function createTypeAhead(): DsTypeAhead;
|
|
803
829
|
|
|
804
|
-
export { CHART_RAMP_COLORS, CHART_SERIES_COLORS, DS_FIELD_WARNING_KIND, DsBooleanControlValueAccessor, DsChipTemplateDirective, DsControlValueAccessor, DsCreateTemplateDirective, DsEmptyTemplateDirective, DsFieldBase, DsGroupLabelTemplateDirective, DsMessageBase, DsOptionTemplateDirective, DsPanelFooterTemplateDirective, DsPanelHeaderTemplateDirective, DsPickerTriggerDirective, DsStaticPreview, FieldClickFocusDirective, ProjectionDroppedDirective, announceOptionCount, bandScale, chartColors, chipFit, clearOnDetach, closeOnOutsidePointer, closeOnScroll, createTypeAhead, describeSeries, describeShare, disposeWithLeave, dropdownOverlay, dsAriaCurrent, dsDestination, elementWidth, focusIsInside, focusMark, formatPercent, formatTick, formatValue, forwardOverlayTokens, largestRemainder, linearScale, nextControlId, nextRovingIndex, niceMax, overlayPlacementOf, panelClassesOf, prepareOverlayEnter, resolveBrandValue, resolveFieldMessage, scrollActiveOptionIntoView, staggerDelay, tickStep, tickValues, trimmedText, valueControlBridge };
|
|
805
|
-
export type { BandScale, DsAriaCurrent, DsDestination, DsFieldError, DsFieldErrorsInput, DsFieldMessage, DsLinkModifiers, DsOverlayCloseCause, DsRouterLink, SummaryPoint };
|
|
830
|
+
export { CHART_RAMP_COLORS, CHART_SERIES_COLORS, DS_FIELD_WARNING_KIND, DsBooleanControlValueAccessor, DsChipTemplateDirective, DsControlValueAccessor, DsCreateTemplateDirective, DsEmptyTemplateDirective, DsFieldBase, DsGroupLabelTemplateDirective, DsMessageBase, DsOptionTemplateDirective, DsPanelFooterTemplateDirective, DsPanelHeaderTemplateDirective, DsPickerTriggerDirective, DsStaticPreview, FieldClickFocusDirective, ProjectionDroppedDirective, announceOptionCount, bandScale, chartColors, chipFit, clearOnDetach, closeOnOutsidePointer, closeOnScroll, createTypeAhead, describeSeries, describeShare, disposeWithLeave, dropdownOverlay, dsAriaCurrent, dsDestination, elementWidth, focusIsInside, focusMark, formatPercent, formatTick, formatValue, forwardOverlayTokens, largestRemainder, linearScale, nextControlId, nextRovingIndex, niceMax, overlayPlacementOf, panelClassesOf, pointScale, prepareOverlayEnter, resolveBrandValue, resolveFieldMessage, scrollActiveOptionIntoView, shareOfTotal, staggerDelay, tickStep, tickValues, trimmedText, valueControlBridge };
|
|
831
|
+
export type { BandScale, DsAriaCurrent, DsDestination, DsFieldError, DsFieldErrorsInput, DsFieldMessage, DsLinkModifiers, DsOverlayCloseCause, DsRouterLink, PointScale, SummaryPoint };
|
|
@@ -23,6 +23,9 @@ type CardPadding = 'none' | 'sm' | 'md' | 'lg';
|
|
|
23
23
|
* route to the numbers, so `'none'` belongs only where the same data is already in a table on the
|
|
24
24
|
* page. */
|
|
25
25
|
type ChartDataTable = 'toggle' | 'visible' | 'none';
|
|
26
|
+
/** Whether a chart draws its own bordered, padded box. `'auto'` draws it; `'none'` leaves the
|
|
27
|
+
* chart bare, for a chart placed inside a card the page has already drawn. */
|
|
28
|
+
type ChartFrame = 'auto' | 'none';
|
|
26
29
|
/** Formats every value a chart prints — the annex table and the generated description included. */
|
|
27
30
|
type ChartValueFormat = (value: number) => string;
|
|
28
31
|
|
|
@@ -245,10 +248,23 @@ interface DsConfig {
|
|
|
245
248
|
withDot?: boolean;
|
|
246
249
|
};
|
|
247
250
|
chart?: {
|
|
248
|
-
/** Default `dataTable` for all five charts. Default `'
|
|
251
|
+
/** Default `dataTable` for all five charts. Default `'none'`. It is an accessibility policy
|
|
249
252
|
* rather than a per-chart taste — whether the numbers behind a plot have a non-visual route is
|
|
250
|
-
* decided once for an app, not thirty times
|
|
253
|
+
* decided once for an app, not thirty times, so an app that wants the annex everywhere sets
|
|
254
|
+
* `'toggle'` here once rather than on every chart. Off by default: a chart usually sits in a
|
|
255
|
+
* page that already carries its numbers, and an unasked-for disclosure under every plot is
|
|
256
|
+
* chrome the page did not ask for. */
|
|
251
257
|
dataTable?: ChartDataTable;
|
|
258
|
+
/** Whether every chart draws its own bordered, padded box. Default `'auto'`, which draws it.
|
|
259
|
+
* Whether charts live inside cards is decided once for an app — a page that puts every chart
|
|
260
|
+
* in a card sets `'none'` here rather than reaching into five components' chrome from a
|
|
261
|
+
* global stylesheet. */
|
|
262
|
+
frame?: ChartFrame;
|
|
263
|
+
/** How long every chart's tooltip stays after the pointer leaves the mark, in milliseconds.
|
|
264
|
+
* Default 0. Raise it only where the panels carry something a reader has to reach — WCAG
|
|
265
|
+
* 1.4.13's hoverable clause — which is a property of what an app puts in its tooltips rather
|
|
266
|
+
* than of one plot. About 140 is enough to cross the gap at an ordinary pointer speed. */
|
|
267
|
+
tooltipLingerMs?: number;
|
|
252
268
|
/** Shown in place of the plot when a chart's data is empty. Default `'No data'`. */
|
|
253
269
|
emptyText?: string;
|
|
254
270
|
/** Shown in place of the plot when a chart has `error` set. Default
|
|
@@ -472,4 +488,4 @@ type DsTriggerDisplay = 'full' | 'count' | 'labels';
|
|
|
472
488
|
type DsControlWidth = 'fill' | 'content';
|
|
473
489
|
|
|
474
490
|
export { DS_CONFIG, ICONS, backdropDismiss, boundOr, devWarn, firstEnabledIndex, flattenDsOptions, inheritDsConfig, isDsOptionGroup, isTextClipped, isTextEntryTarget, lastEnabledIndex, nextEnabledIndex, optionalBound, provideDsConfig, resolveWithConfig };
|
|
475
|
-
export type { CardElevation, CardPadding, ChartDataTable, ChartValueFormat, DsConfig, DsControlWidth, DsOption, DsOptionGroup, DsOptionItem, DsSize, DsStatus, DsStatusKey, DsStatusRegistry, DsToastHorizontalPosition, DsToastPosition, DsToastVerticalPosition, DsTriggerDisplay, IconName };
|
|
491
|
+
export type { CardElevation, CardPadding, ChartDataTable, ChartFrame, ChartValueFormat, DsConfig, DsControlWidth, DsOption, DsOptionGroup, DsOptionItem, DsSize, DsStatus, DsStatusKey, DsStatusRegistry, DsToastHorizontalPosition, DsToastPosition, DsToastVerticalPosition, DsTriggerDisplay, IconName };
|