@devicechain/widgets 0.21.1-rc.1 → 0.22.0-rc.1
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/README.md +28 -7
- package/dist/aggregate-feed.d.ts +14 -0
- package/dist/aggregate-fold.d.ts +11 -0
- package/dist/aggregate-reading.d.ts +19 -0
- package/dist/aggregate-strings.d.ts +16 -0
- package/dist/binding-policy.d.ts +3 -1
- package/dist/builtin-descriptors.d.ts +1210 -8
- package/dist/builtin-registry.d.ts +1197 -8
- package/dist/category-geometry.d.ts +19 -0
- package/dist/category-items.d.ts +10 -0
- package/dist/chunks/aggregate-feed-6ZYKOQOB.js +130 -0
- package/dist/chunks/aggregate-feed-6ZYKOQOB.js.map +7 -0
- package/dist/chunks/aggregate-widgets-WVXAW3UL.js +895 -0
- package/dist/chunks/aggregate-widgets-WVXAW3UL.js.map +7 -0
- package/dist/chunks/chunk-2D7JNKFE.js +65 -0
- package/dist/chunks/chunk-2D7JNKFE.js.map +7 -0
- package/dist/chunks/chunk-S2OMBJLI.js +200 -0
- package/dist/chunks/chunk-S2OMBJLI.js.map +7 -0
- package/dist/chunks/chunk-XQQQNTBX.js +76 -0
- package/dist/chunks/chunk-XQQQNTBX.js.map +7 -0
- package/dist/chunks/chunk-YPFB6DAL.js +157 -0
- package/dist/chunks/chunk-YPFB6DAL.js.map +7 -0
- package/dist/chunks/chunk-ZR74ORIT.js +35 -0
- package/dist/chunks/chunk-ZR74ORIT.js.map +7 -0
- package/dist/chunks/control-widgets-UDS4ET3T.js +775 -0
- package/dist/chunks/control-widgets-UDS4ET3T.js.map +7 -0
- package/dist/chunks/fleet-feed-FK4ZMKIK.js +252 -0
- package/dist/chunks/fleet-feed-FK4ZMKIK.js.map +7 -0
- package/dist/chunks/level-widgets-MJB7TOLU.js +833 -0
- package/dist/chunks/level-widgets-MJB7TOLU.js.map +7 -0
- package/dist/command-control-core.d.ts +68 -0
- package/dist/command-control-strings.d.ts +32 -0
- package/dist/command-control.d.ts +31 -0
- package/dist/dashboard-renderer.d.ts +15 -4
- package/dist/fleet-feed.d.ts +21 -0
- package/dist/fleet-model.d.ts +43 -0
- package/dist/fleet-seed.d.ts +7 -0
- package/dist/fleet-strings.d.ts +25 -0
- package/dist/heading.d.ts +3 -0
- package/dist/index.d.ts +3 -2
- package/dist/index.js +1774 -676
- package/dist/index.js.map +4 -4
- package/dist/level-reading.d.ts +29 -0
- package/dist/level-readout.d.ts +25 -0
- package/dist/level-strings.d.ts +13 -0
- package/dist/options.d.ts +1 -1
- package/dist/time-range-bar.d.ts +28 -0
- package/dist/use-held.d.ts +1 -0
- package/dist/value-scale.d.ts +30 -0
- package/dist/widgets/aggregate-lazy.d.ts +305 -0
- package/dist/widgets/aggregate-widgets.d.ts +4 -0
- package/dist/widgets/alarm-count.d.ts +1 -0
- package/dist/widgets/alarm-table.d.ts +4 -1
- package/dist/widgets/bar-chart.d.ts +5 -0
- package/dist/widgets/battery.d.ts +7 -0
- package/dist/widgets/command-slider.d.ts +2 -0
- package/dist/widgets/command-toggle.d.ts +4 -0
- package/dist/widgets/compass.d.ts +2 -0
- package/dist/widgets/control-lazy.d.ts +92 -0
- package/dist/widgets/control-widgets.d.ts +2 -0
- package/dist/widgets/fleet-table.d.ts +13 -0
- package/dist/widgets/gauge.d.ts +52 -0
- package/dist/widgets/label.d.ts +1 -1
- package/dist/widgets/latest-card.d.ts +44 -1
- package/dist/widgets/lazy-chunk.d.ts +8 -0
- package/dist/widgets/level-gauge.d.ts +2 -0
- package/dist/widgets/level-lazy.d.ts +647 -0
- package/dist/widgets/level-widgets.d.ts +7 -0
- package/dist/widgets/linear-gauge.d.ts +2 -0
- package/dist/widgets/pie-chart.d.ts +2 -0
- package/dist/widgets/progress-ring.d.ts +3 -0
- package/dist/widgets/severity.d.ts +2 -1
- package/dist/widgets/signal-bars.d.ts +3 -0
- package/dist/widgets/stat-card.d.ts +3 -0
- package/dist/widgets/status-light.d.ts +7 -0
- package/dist/widgets/table.d.ts +9 -1
- package/dist/widgets/time-series-chart.d.ts +62 -4
- package/package.json +8 -8
|
@@ -5,13 +5,71 @@ export declare const builtinWidgetDefinitions: readonly [import("@devicechain/wi
|
|
|
5
5
|
readonly labelId: 'widgetLabelTitle';
|
|
6
6
|
readonly doc: 'Heading shown in the widget frame. Blank hides the frame heading.';
|
|
7
7
|
};
|
|
8
|
-
readonly
|
|
8
|
+
readonly unit: {
|
|
9
|
+
readonly kind: 'string';
|
|
10
|
+
readonly labelId: 'widgetLabelUnit';
|
|
11
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
12
|
+
};
|
|
13
|
+
readonly precision: {
|
|
14
|
+
readonly kind: 'number';
|
|
15
|
+
readonly integer: true;
|
|
16
|
+
readonly min: 0;
|
|
17
|
+
readonly max: 100;
|
|
18
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
19
|
+
readonly helpId: 'widgetHintPrecision';
|
|
20
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
21
|
+
};
|
|
22
|
+
readonly thresholds: {
|
|
23
|
+
readonly kind: 'list';
|
|
24
|
+
readonly maxItems: 12;
|
|
25
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
26
|
+
readonly helpId: 'widgetHintThresholds';
|
|
27
|
+
readonly doc: 'Severity bands over the value. Each entry starts a band at its value that runs to the next entry; below the first, and in a normal band, the widget keeps its own colour.';
|
|
28
|
+
readonly item: {
|
|
29
|
+
readonly value: {
|
|
30
|
+
readonly kind: 'number';
|
|
31
|
+
readonly required: true;
|
|
32
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
33
|
+
readonly doc: 'The value at which this band starts.';
|
|
34
|
+
};
|
|
35
|
+
readonly level: {
|
|
36
|
+
readonly kind: 'enum';
|
|
37
|
+
readonly required: true;
|
|
38
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
39
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
40
|
+
readonly valueLabelIds: {
|
|
41
|
+
readonly normal: 'widgetSeverityNormal';
|
|
42
|
+
readonly warning: 'widgetSeverityWarning';
|
|
43
|
+
readonly minor: 'widgetSeverityMinor';
|
|
44
|
+
readonly major: 'widgetSeverityMajor';
|
|
45
|
+
readonly critical: 'widgetSeverityCritical';
|
|
46
|
+
};
|
|
47
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
48
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
49
|
+
};
|
|
50
|
+
readonly label: {
|
|
51
|
+
readonly kind: 'string';
|
|
52
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
53
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
54
|
+
};
|
|
55
|
+
};
|
|
56
|
+
};
|
|
57
|
+
readonly staleAfterSeconds: {
|
|
9
58
|
readonly kind: 'number';
|
|
10
59
|
readonly integer: true;
|
|
11
60
|
readonly min: 1;
|
|
12
|
-
readonly labelId: '
|
|
13
|
-
readonly helpId: '
|
|
14
|
-
readonly doc: '
|
|
61
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
62
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
63
|
+
readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
|
|
64
|
+
};
|
|
65
|
+
readonly windowSeconds: {
|
|
66
|
+
readonly kind: 'number';
|
|
67
|
+
readonly integer: true;
|
|
68
|
+
readonly min: 60;
|
|
69
|
+
readonly max: 604800;
|
|
70
|
+
readonly labelId: 'widgetLabelWindowSeconds';
|
|
71
|
+
readonly helpId: 'widgetHintWindowSeconds';
|
|
72
|
+
readonly doc: 'Seconds of history the widget covers, back from now. Leave unset to follow the board’s time range; set it to pin this widget to a fixed span that the viewer’s range picker does not change. 60 to 604800.';
|
|
15
73
|
};
|
|
16
74
|
}>, import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
17
75
|
readonly title: {
|
|
@@ -37,7 +95,42 @@ export declare const builtinWidgetDefinitions: readonly [import("@devicechain/wi
|
|
|
37
95
|
readonly max: 100;
|
|
38
96
|
readonly labelId: 'widgetLabelPrecision';
|
|
39
97
|
readonly helpId: 'widgetHintPrecision';
|
|
40
|
-
readonly doc: 'Decimal places to round displayed values to. Unset
|
|
98
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
99
|
+
};
|
|
100
|
+
readonly thresholds: {
|
|
101
|
+
readonly kind: 'list';
|
|
102
|
+
readonly maxItems: 12;
|
|
103
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
104
|
+
readonly helpId: 'widgetHintThresholds';
|
|
105
|
+
readonly doc: 'Severity bands over the value. Each entry starts a band at its value that runs to the next entry; below the first, and in a normal band, the widget keeps its own colour.';
|
|
106
|
+
readonly item: {
|
|
107
|
+
readonly value: {
|
|
108
|
+
readonly kind: 'number';
|
|
109
|
+
readonly required: true;
|
|
110
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
111
|
+
readonly doc: 'The value at which this band starts.';
|
|
112
|
+
};
|
|
113
|
+
readonly level: {
|
|
114
|
+
readonly kind: 'enum';
|
|
115
|
+
readonly required: true;
|
|
116
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
117
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
118
|
+
readonly valueLabelIds: {
|
|
119
|
+
readonly normal: 'widgetSeverityNormal';
|
|
120
|
+
readonly warning: 'widgetSeverityWarning';
|
|
121
|
+
readonly minor: 'widgetSeverityMinor';
|
|
122
|
+
readonly major: 'widgetSeverityMajor';
|
|
123
|
+
readonly critical: 'widgetSeverityCritical';
|
|
124
|
+
};
|
|
125
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
126
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
127
|
+
};
|
|
128
|
+
readonly label: {
|
|
129
|
+
readonly kind: 'string';
|
|
130
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
131
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
132
|
+
};
|
|
133
|
+
};
|
|
41
134
|
};
|
|
42
135
|
readonly flashOnChange: {
|
|
43
136
|
readonly kind: 'boolean';
|
|
@@ -45,6 +138,14 @@ export declare const builtinWidgetDefinitions: readonly [import("@devicechain/wi
|
|
|
45
138
|
readonly helpId: 'widgetFlashOnChangeHint';
|
|
46
139
|
readonly doc: 'Briefly tint a value green on a rise and red on a fall when it changes.';
|
|
47
140
|
};
|
|
141
|
+
readonly staleAfterSeconds: {
|
|
142
|
+
readonly kind: 'number';
|
|
143
|
+
readonly integer: true;
|
|
144
|
+
readonly min: 1;
|
|
145
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
146
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
147
|
+
readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
|
|
148
|
+
};
|
|
48
149
|
readonly window: {
|
|
49
150
|
readonly kind: 'number';
|
|
50
151
|
readonly integer: true;
|
|
@@ -80,12 +181,64 @@ export declare const builtinWidgetDefinitions: readonly [import("@devicechain/wi
|
|
|
80
181
|
readonly labelId: 'widgetLabelUnit';
|
|
81
182
|
readonly doc: 'Unit suffix shown beside the value.';
|
|
82
183
|
};
|
|
184
|
+
readonly precision: {
|
|
185
|
+
readonly kind: 'number';
|
|
186
|
+
readonly integer: true;
|
|
187
|
+
readonly min: 0;
|
|
188
|
+
readonly max: 100;
|
|
189
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
190
|
+
readonly helpId: 'widgetHintPrecision';
|
|
191
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
192
|
+
};
|
|
193
|
+
readonly thresholds: {
|
|
194
|
+
readonly kind: 'list';
|
|
195
|
+
readonly maxItems: 12;
|
|
196
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
197
|
+
readonly helpId: 'widgetHintThresholds';
|
|
198
|
+
readonly doc: 'Severity bands over the value. Each entry starts a band at its value that runs to the next entry; below the first, and in a normal band, the widget keeps its own colour.';
|
|
199
|
+
readonly item: {
|
|
200
|
+
readonly value: {
|
|
201
|
+
readonly kind: 'number';
|
|
202
|
+
readonly required: true;
|
|
203
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
204
|
+
readonly doc: 'The value at which this band starts.';
|
|
205
|
+
};
|
|
206
|
+
readonly level: {
|
|
207
|
+
readonly kind: 'enum';
|
|
208
|
+
readonly required: true;
|
|
209
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
210
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
211
|
+
readonly valueLabelIds: {
|
|
212
|
+
readonly normal: 'widgetSeverityNormal';
|
|
213
|
+
readonly warning: 'widgetSeverityWarning';
|
|
214
|
+
readonly minor: 'widgetSeverityMinor';
|
|
215
|
+
readonly major: 'widgetSeverityMajor';
|
|
216
|
+
readonly critical: 'widgetSeverityCritical';
|
|
217
|
+
};
|
|
218
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
219
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
220
|
+
};
|
|
221
|
+
readonly label: {
|
|
222
|
+
readonly kind: 'string';
|
|
223
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
224
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
225
|
+
};
|
|
226
|
+
};
|
|
227
|
+
};
|
|
83
228
|
readonly flashOnChange: {
|
|
84
229
|
readonly kind: 'boolean';
|
|
85
230
|
readonly labelId: 'widgetFlashOnChange';
|
|
86
231
|
readonly helpId: 'widgetFlashOnChangeHint';
|
|
87
232
|
readonly doc: 'Briefly tint a value green on a rise and red on a fall when it changes.';
|
|
88
233
|
};
|
|
234
|
+
readonly staleAfterSeconds: {
|
|
235
|
+
readonly kind: 'number';
|
|
236
|
+
readonly integer: true;
|
|
237
|
+
readonly min: 1;
|
|
238
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
239
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
240
|
+
readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
|
|
241
|
+
};
|
|
89
242
|
readonly window: {
|
|
90
243
|
readonly kind: 'number';
|
|
91
244
|
readonly integer: true;
|
|
@@ -107,7 +260,7 @@ export declare const builtinWidgetDefinitions: readonly [import("@devicechain/wi
|
|
|
107
260
|
readonly max: 100;
|
|
108
261
|
readonly labelId: 'widgetLabelPrecision';
|
|
109
262
|
readonly helpId: 'widgetHintPrecision';
|
|
110
|
-
readonly doc: 'Decimal places to round displayed values to. Unset
|
|
263
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
111
264
|
};
|
|
112
265
|
readonly flashOnChange: {
|
|
113
266
|
readonly kind: 'boolean';
|
|
@@ -115,6 +268,14 @@ export declare const builtinWidgetDefinitions: readonly [import("@devicechain/wi
|
|
|
115
268
|
readonly helpId: 'widgetFlashOnChangeHint';
|
|
116
269
|
readonly doc: 'Briefly tint a value green on a rise and red on a fall when it changes.';
|
|
117
270
|
};
|
|
271
|
+
readonly staleAfterSeconds: {
|
|
272
|
+
readonly kind: 'number';
|
|
273
|
+
readonly integer: true;
|
|
274
|
+
readonly min: 1;
|
|
275
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
276
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
277
|
+
readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
|
|
278
|
+
};
|
|
118
279
|
readonly window: {
|
|
119
280
|
readonly kind: 'number';
|
|
120
281
|
readonly integer: true;
|
|
@@ -152,7 +313,7 @@ export declare const builtinWidgetDefinitions: readonly [import("@devicechain/wi
|
|
|
152
313
|
readonly min: 1;
|
|
153
314
|
readonly labelId: "widgetLabelFontSize";
|
|
154
315
|
readonly helpId: "widgetHintFontSize";
|
|
155
|
-
readonly doc: "Text size in pixels. Default 16.";
|
|
316
|
+
readonly doc: "Text size in pixels at the comfortable density; it scales with the board density. Default 16.";
|
|
156
317
|
};
|
|
157
318
|
}>, import("@devicechain/widget-sdk").WidgetDefinition<"none", {
|
|
158
319
|
readonly title: {
|
|
@@ -243,7 +404,7 @@ export declare const builtinWidgetDefinitions: readonly [import("@devicechain/wi
|
|
|
243
404
|
readonly max: 100;
|
|
244
405
|
readonly labelId: 'widgetLabelPrecision';
|
|
245
406
|
readonly helpId: 'widgetHintPrecision';
|
|
246
|
-
readonly doc: 'Decimal places to round displayed values to. Unset
|
|
407
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
247
408
|
};
|
|
248
409
|
readonly flashOnChange: {
|
|
249
410
|
readonly kind: 'boolean';
|
|
@@ -374,5 +535,1033 @@ export declare const builtinWidgetDefinitions: readonly [import("@devicechain/wi
|
|
|
374
535
|
readonly control: "basemap";
|
|
375
536
|
readonly doc: "Credit line the tile source requires, shown on the map. Set whatever the provider you chose asks for.";
|
|
376
537
|
};
|
|
538
|
+
}>, import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
539
|
+
readonly title: {
|
|
540
|
+
readonly kind: 'string';
|
|
541
|
+
readonly labelId: 'widgetLabelTitle';
|
|
542
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
543
|
+
};
|
|
544
|
+
readonly measurement: {
|
|
545
|
+
readonly kind: 'string';
|
|
546
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
547
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
548
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
549
|
+
};
|
|
550
|
+
readonly min: {
|
|
551
|
+
readonly kind: 'number';
|
|
552
|
+
readonly required: true;
|
|
553
|
+
readonly labelId: 'widgetLabelMin';
|
|
554
|
+
readonly helpId: 'widgetHintScaleMin';
|
|
555
|
+
readonly doc: 'Value at the empty end of the scale. Required: the widget does not guess a range.';
|
|
556
|
+
};
|
|
557
|
+
readonly max: {
|
|
558
|
+
readonly kind: 'number';
|
|
559
|
+
readonly required: true;
|
|
560
|
+
readonly labelId: 'widgetLabelMax';
|
|
561
|
+
readonly helpId: 'widgetHintScaleMax';
|
|
562
|
+
readonly doc: 'Value at the full end of the scale. Required, and above min.';
|
|
563
|
+
};
|
|
564
|
+
readonly style: {
|
|
565
|
+
readonly kind: "enum";
|
|
566
|
+
readonly values: readonly ["bar", "thermometer"];
|
|
567
|
+
readonly labelId: "widgetLabelLinearStyle";
|
|
568
|
+
readonly valueLabelIds: {
|
|
569
|
+
readonly bar: "widgetLinearStyleBar";
|
|
570
|
+
readonly thermometer: "widgetLinearStyleThermometer";
|
|
571
|
+
};
|
|
572
|
+
readonly placeholderId: "widgetPlaceholderDefault";
|
|
573
|
+
readonly doc: "A plain bar (default) or a thermometer: a vertical tube with a bulb. A thermometer is always vertical.";
|
|
574
|
+
};
|
|
575
|
+
readonly orientation: {
|
|
576
|
+
readonly kind: "enum";
|
|
577
|
+
readonly values: readonly ["horizontal", "vertical"];
|
|
578
|
+
readonly labelId: "widgetLabelOrientation";
|
|
579
|
+
readonly valueLabelIds: {
|
|
580
|
+
readonly horizontal: "widgetOrientationHorizontal";
|
|
581
|
+
readonly vertical: "widgetOrientationVertical";
|
|
582
|
+
};
|
|
583
|
+
readonly placeholderId: "widgetPlaceholderDefault";
|
|
584
|
+
readonly doc: "Direction of a bar: horizontal (default) or vertical. Ignored by a thermometer.";
|
|
585
|
+
};
|
|
586
|
+
readonly unit: {
|
|
587
|
+
readonly kind: 'string';
|
|
588
|
+
readonly labelId: 'widgetLabelUnit';
|
|
589
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
590
|
+
};
|
|
591
|
+
readonly precision: {
|
|
592
|
+
readonly kind: 'number';
|
|
593
|
+
readonly integer: true;
|
|
594
|
+
readonly min: 0;
|
|
595
|
+
readonly max: 100;
|
|
596
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
597
|
+
readonly helpId: 'widgetHintPrecision';
|
|
598
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
599
|
+
};
|
|
600
|
+
readonly thresholds: {
|
|
601
|
+
readonly kind: 'list';
|
|
602
|
+
readonly maxItems: 12;
|
|
603
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
604
|
+
readonly helpId: 'widgetHintThresholds';
|
|
605
|
+
readonly doc: 'Severity bands over the value. Each entry starts a band at its value that runs to the next entry; below the first, and in a normal band, the widget keeps its own colour.';
|
|
606
|
+
readonly item: {
|
|
607
|
+
readonly value: {
|
|
608
|
+
readonly kind: 'number';
|
|
609
|
+
readonly required: true;
|
|
610
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
611
|
+
readonly doc: 'The value at which this band starts.';
|
|
612
|
+
};
|
|
613
|
+
readonly level: {
|
|
614
|
+
readonly kind: 'enum';
|
|
615
|
+
readonly required: true;
|
|
616
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
617
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
618
|
+
readonly valueLabelIds: {
|
|
619
|
+
readonly normal: 'widgetSeverityNormal';
|
|
620
|
+
readonly warning: 'widgetSeverityWarning';
|
|
621
|
+
readonly minor: 'widgetSeverityMinor';
|
|
622
|
+
readonly major: 'widgetSeverityMajor';
|
|
623
|
+
readonly critical: 'widgetSeverityCritical';
|
|
624
|
+
};
|
|
625
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
626
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
627
|
+
};
|
|
628
|
+
readonly label: {
|
|
629
|
+
readonly kind: 'string';
|
|
630
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
631
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
632
|
+
};
|
|
633
|
+
};
|
|
634
|
+
};
|
|
635
|
+
readonly staleAfterSeconds: {
|
|
636
|
+
readonly kind: 'number';
|
|
637
|
+
readonly integer: true;
|
|
638
|
+
readonly min: 1;
|
|
639
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
640
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
641
|
+
readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
|
|
642
|
+
};
|
|
643
|
+
readonly window: {
|
|
644
|
+
readonly kind: 'number';
|
|
645
|
+
readonly integer: true;
|
|
646
|
+
readonly min: 1;
|
|
647
|
+
readonly labelId: 'widgetLabelWindow';
|
|
648
|
+
readonly helpId: 'widgetHintWindow';
|
|
649
|
+
readonly doc: 'Samples retained across ALL of the widget\'s measurements before the oldest are dropped. Bounds memory; only the chart draws them. Default 300.';
|
|
650
|
+
};
|
|
651
|
+
}>, import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
652
|
+
readonly title: {
|
|
653
|
+
readonly kind: 'string';
|
|
654
|
+
readonly labelId: 'widgetLabelTitle';
|
|
655
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
656
|
+
};
|
|
657
|
+
readonly measurement: {
|
|
658
|
+
readonly kind: 'string';
|
|
659
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
660
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
661
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
662
|
+
};
|
|
663
|
+
readonly min: {
|
|
664
|
+
readonly kind: 'number';
|
|
665
|
+
readonly required: true;
|
|
666
|
+
readonly labelId: 'widgetLabelMin';
|
|
667
|
+
readonly helpId: 'widgetHintScaleMin';
|
|
668
|
+
readonly doc: 'Value at the empty end of the scale. Required: the widget does not guess a range.';
|
|
669
|
+
};
|
|
670
|
+
readonly max: {
|
|
671
|
+
readonly kind: 'number';
|
|
672
|
+
readonly required: true;
|
|
673
|
+
readonly labelId: 'widgetLabelMax';
|
|
674
|
+
readonly helpId: 'widgetHintScaleMax';
|
|
675
|
+
readonly doc: 'Value at the full end of the scale. Required, and above min.';
|
|
676
|
+
};
|
|
677
|
+
readonly readout: {
|
|
678
|
+
readonly kind: "enum";
|
|
679
|
+
readonly values: readonly ["value", "percent"];
|
|
680
|
+
readonly labelId: "widgetLabelReadout";
|
|
681
|
+
readonly valueLabelIds: {
|
|
682
|
+
readonly value: "widgetReadoutValue";
|
|
683
|
+
readonly percent: "widgetReadoutPercent";
|
|
684
|
+
};
|
|
685
|
+
readonly placeholderId: "widgetPlaceholderDefault";
|
|
686
|
+
readonly doc: "What the readout shows: the value with its unit (default) or the percent of the scale.";
|
|
687
|
+
};
|
|
688
|
+
readonly unit: {
|
|
689
|
+
readonly kind: 'string';
|
|
690
|
+
readonly labelId: 'widgetLabelUnit';
|
|
691
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
692
|
+
};
|
|
693
|
+
readonly precision: {
|
|
694
|
+
readonly kind: 'number';
|
|
695
|
+
readonly integer: true;
|
|
696
|
+
readonly min: 0;
|
|
697
|
+
readonly max: 100;
|
|
698
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
699
|
+
readonly helpId: 'widgetHintPrecision';
|
|
700
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
701
|
+
};
|
|
702
|
+
readonly thresholds: {
|
|
703
|
+
readonly kind: 'list';
|
|
704
|
+
readonly maxItems: 12;
|
|
705
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
706
|
+
readonly helpId: 'widgetHintThresholds';
|
|
707
|
+
readonly doc: 'Severity bands over the value. Each entry starts a band at its value that runs to the next entry; below the first, and in a normal band, the widget keeps its own colour.';
|
|
708
|
+
readonly item: {
|
|
709
|
+
readonly value: {
|
|
710
|
+
readonly kind: 'number';
|
|
711
|
+
readonly required: true;
|
|
712
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
713
|
+
readonly doc: 'The value at which this band starts.';
|
|
714
|
+
};
|
|
715
|
+
readonly level: {
|
|
716
|
+
readonly kind: 'enum';
|
|
717
|
+
readonly required: true;
|
|
718
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
719
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
720
|
+
readonly valueLabelIds: {
|
|
721
|
+
readonly normal: 'widgetSeverityNormal';
|
|
722
|
+
readonly warning: 'widgetSeverityWarning';
|
|
723
|
+
readonly minor: 'widgetSeverityMinor';
|
|
724
|
+
readonly major: 'widgetSeverityMajor';
|
|
725
|
+
readonly critical: 'widgetSeverityCritical';
|
|
726
|
+
};
|
|
727
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
728
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
729
|
+
};
|
|
730
|
+
readonly label: {
|
|
731
|
+
readonly kind: 'string';
|
|
732
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
733
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
734
|
+
};
|
|
735
|
+
};
|
|
736
|
+
};
|
|
737
|
+
readonly staleAfterSeconds: {
|
|
738
|
+
readonly kind: 'number';
|
|
739
|
+
readonly integer: true;
|
|
740
|
+
readonly min: 1;
|
|
741
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
742
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
743
|
+
readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
|
|
744
|
+
};
|
|
745
|
+
readonly window: {
|
|
746
|
+
readonly kind: 'number';
|
|
747
|
+
readonly integer: true;
|
|
748
|
+
readonly min: 1;
|
|
749
|
+
readonly labelId: 'widgetLabelWindow';
|
|
750
|
+
readonly helpId: 'widgetHintWindow';
|
|
751
|
+
readonly doc: 'Samples retained across ALL of the widget\'s measurements before the oldest are dropped. Bounds memory; only the chart draws them. Default 300.';
|
|
752
|
+
};
|
|
753
|
+
}>, import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
754
|
+
readonly title: {
|
|
755
|
+
readonly kind: 'string';
|
|
756
|
+
readonly labelId: 'widgetLabelTitle';
|
|
757
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
758
|
+
};
|
|
759
|
+
readonly measurement: {
|
|
760
|
+
readonly kind: 'string';
|
|
761
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
762
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
763
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
764
|
+
};
|
|
765
|
+
readonly min: {
|
|
766
|
+
readonly kind: "number";
|
|
767
|
+
readonly labelId: "widgetLabelMin";
|
|
768
|
+
readonly helpId: "widgetHintBatteryRange";
|
|
769
|
+
readonly doc: "Value of an empty battery. Default 0 (the scale is percent unless you set min and max).";
|
|
770
|
+
};
|
|
771
|
+
readonly max: {
|
|
772
|
+
readonly kind: "number";
|
|
773
|
+
readonly labelId: "widgetLabelMax";
|
|
774
|
+
readonly helpId: "widgetHintBatteryRange";
|
|
775
|
+
readonly doc: "Value of a full battery. Default 100 (the scale is percent unless you set min and max).";
|
|
776
|
+
};
|
|
777
|
+
readonly unit: {
|
|
778
|
+
readonly kind: 'string';
|
|
779
|
+
readonly labelId: 'widgetLabelUnit';
|
|
780
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
781
|
+
};
|
|
782
|
+
readonly precision: {
|
|
783
|
+
readonly kind: 'number';
|
|
784
|
+
readonly integer: true;
|
|
785
|
+
readonly min: 0;
|
|
786
|
+
readonly max: 100;
|
|
787
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
788
|
+
readonly helpId: 'widgetHintPrecision';
|
|
789
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
790
|
+
};
|
|
791
|
+
readonly thresholds: {
|
|
792
|
+
readonly kind: 'list';
|
|
793
|
+
readonly maxItems: 12;
|
|
794
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
795
|
+
readonly helpId: 'widgetHintThresholds';
|
|
796
|
+
readonly doc: 'Severity bands over the value. Each entry starts a band at its value that runs to the next entry; below the first, and in a normal band, the widget keeps its own colour.';
|
|
797
|
+
readonly item: {
|
|
798
|
+
readonly value: {
|
|
799
|
+
readonly kind: 'number';
|
|
800
|
+
readonly required: true;
|
|
801
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
802
|
+
readonly doc: 'The value at which this band starts.';
|
|
803
|
+
};
|
|
804
|
+
readonly level: {
|
|
805
|
+
readonly kind: 'enum';
|
|
806
|
+
readonly required: true;
|
|
807
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
808
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
809
|
+
readonly valueLabelIds: {
|
|
810
|
+
readonly normal: 'widgetSeverityNormal';
|
|
811
|
+
readonly warning: 'widgetSeverityWarning';
|
|
812
|
+
readonly minor: 'widgetSeverityMinor';
|
|
813
|
+
readonly major: 'widgetSeverityMajor';
|
|
814
|
+
readonly critical: 'widgetSeverityCritical';
|
|
815
|
+
};
|
|
816
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
817
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
818
|
+
};
|
|
819
|
+
readonly label: {
|
|
820
|
+
readonly kind: 'string';
|
|
821
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
822
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
823
|
+
};
|
|
824
|
+
};
|
|
825
|
+
};
|
|
826
|
+
readonly staleAfterSeconds: {
|
|
827
|
+
readonly kind: 'number';
|
|
828
|
+
readonly integer: true;
|
|
829
|
+
readonly min: 1;
|
|
830
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
831
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
832
|
+
readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
|
|
833
|
+
};
|
|
834
|
+
readonly window: {
|
|
835
|
+
readonly kind: 'number';
|
|
836
|
+
readonly integer: true;
|
|
837
|
+
readonly min: 1;
|
|
838
|
+
readonly labelId: 'widgetLabelWindow';
|
|
839
|
+
readonly helpId: 'widgetHintWindow';
|
|
840
|
+
readonly doc: 'Samples retained across ALL of the widget\'s measurements before the oldest are dropped. Bounds memory; only the chart draws them. Default 300.';
|
|
841
|
+
};
|
|
842
|
+
}>, import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
843
|
+
readonly title: {
|
|
844
|
+
readonly kind: 'string';
|
|
845
|
+
readonly labelId: 'widgetLabelTitle';
|
|
846
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
847
|
+
};
|
|
848
|
+
readonly measurement: {
|
|
849
|
+
readonly kind: 'string';
|
|
850
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
851
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
852
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
853
|
+
};
|
|
854
|
+
readonly onAt: {
|
|
855
|
+
readonly kind: "number";
|
|
856
|
+
readonly labelId: "widgetLabelOnAt";
|
|
857
|
+
readonly helpId: "widgetHintOnAt";
|
|
858
|
+
readonly doc: "For an on/off signal: the lamp is lit at or above this value and dark below it. Unset keeps the lamp lit while a value is present, coloured by its threshold band.";
|
|
859
|
+
};
|
|
860
|
+
readonly unit: {
|
|
861
|
+
readonly kind: 'string';
|
|
862
|
+
readonly labelId: 'widgetLabelUnit';
|
|
863
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
864
|
+
};
|
|
865
|
+
readonly precision: {
|
|
866
|
+
readonly kind: 'number';
|
|
867
|
+
readonly integer: true;
|
|
868
|
+
readonly min: 0;
|
|
869
|
+
readonly max: 100;
|
|
870
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
871
|
+
readonly helpId: 'widgetHintPrecision';
|
|
872
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
873
|
+
};
|
|
874
|
+
readonly thresholds: {
|
|
875
|
+
readonly kind: 'list';
|
|
876
|
+
readonly maxItems: 12;
|
|
877
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
878
|
+
readonly helpId: 'widgetHintThresholds';
|
|
879
|
+
readonly doc: 'Severity bands over the value. Each entry starts a band at its value that runs to the next entry; below the first, and in a normal band, the widget keeps its own colour.';
|
|
880
|
+
readonly item: {
|
|
881
|
+
readonly value: {
|
|
882
|
+
readonly kind: 'number';
|
|
883
|
+
readonly required: true;
|
|
884
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
885
|
+
readonly doc: 'The value at which this band starts.';
|
|
886
|
+
};
|
|
887
|
+
readonly level: {
|
|
888
|
+
readonly kind: 'enum';
|
|
889
|
+
readonly required: true;
|
|
890
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
891
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
892
|
+
readonly valueLabelIds: {
|
|
893
|
+
readonly normal: 'widgetSeverityNormal';
|
|
894
|
+
readonly warning: 'widgetSeverityWarning';
|
|
895
|
+
readonly minor: 'widgetSeverityMinor';
|
|
896
|
+
readonly major: 'widgetSeverityMajor';
|
|
897
|
+
readonly critical: 'widgetSeverityCritical';
|
|
898
|
+
};
|
|
899
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
900
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
901
|
+
};
|
|
902
|
+
readonly label: {
|
|
903
|
+
readonly kind: 'string';
|
|
904
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
905
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
906
|
+
};
|
|
907
|
+
};
|
|
908
|
+
};
|
|
909
|
+
readonly staleAfterSeconds: {
|
|
910
|
+
readonly kind: 'number';
|
|
911
|
+
readonly integer: true;
|
|
912
|
+
readonly min: 1;
|
|
913
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
914
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
915
|
+
readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
|
|
916
|
+
};
|
|
917
|
+
readonly window: {
|
|
918
|
+
readonly kind: 'number';
|
|
919
|
+
readonly integer: true;
|
|
920
|
+
readonly min: 1;
|
|
921
|
+
readonly labelId: 'widgetLabelWindow';
|
|
922
|
+
readonly helpId: 'widgetHintWindow';
|
|
923
|
+
readonly doc: 'Samples retained across ALL of the widget\'s measurements before the oldest are dropped. Bounds memory; only the chart draws them. Default 300.';
|
|
924
|
+
};
|
|
925
|
+
}>, import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
926
|
+
readonly title: {
|
|
927
|
+
readonly kind: 'string';
|
|
928
|
+
readonly labelId: 'widgetLabelTitle';
|
|
929
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
930
|
+
};
|
|
931
|
+
readonly measurement: {
|
|
932
|
+
readonly kind: 'string';
|
|
933
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
934
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
935
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
936
|
+
};
|
|
937
|
+
readonly unit: {
|
|
938
|
+
readonly kind: 'string';
|
|
939
|
+
readonly labelId: 'widgetLabelUnit';
|
|
940
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
941
|
+
};
|
|
942
|
+
readonly precision: {
|
|
943
|
+
readonly kind: 'number';
|
|
944
|
+
readonly integer: true;
|
|
945
|
+
readonly min: 0;
|
|
946
|
+
readonly max: 100;
|
|
947
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
948
|
+
readonly helpId: 'widgetHintPrecision';
|
|
949
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
950
|
+
};
|
|
951
|
+
readonly thresholds: {
|
|
952
|
+
readonly kind: 'list';
|
|
953
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
954
|
+
readonly item: {
|
|
955
|
+
readonly value: {
|
|
956
|
+
readonly kind: 'number';
|
|
957
|
+
readonly required: true;
|
|
958
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
959
|
+
readonly doc: 'The value at which this band starts.';
|
|
960
|
+
};
|
|
961
|
+
readonly level: {
|
|
962
|
+
readonly kind: 'enum';
|
|
963
|
+
readonly required: true;
|
|
964
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
965
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
966
|
+
readonly valueLabelIds: {
|
|
967
|
+
readonly normal: 'widgetSeverityNormal';
|
|
968
|
+
readonly warning: 'widgetSeverityWarning';
|
|
969
|
+
readonly minor: 'widgetSeverityMinor';
|
|
970
|
+
readonly major: 'widgetSeverityMajor';
|
|
971
|
+
readonly critical: 'widgetSeverityCritical';
|
|
972
|
+
};
|
|
973
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
974
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
975
|
+
};
|
|
976
|
+
readonly label: {
|
|
977
|
+
readonly kind: 'string';
|
|
978
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
979
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
980
|
+
};
|
|
981
|
+
};
|
|
982
|
+
readonly maxItems: 8;
|
|
983
|
+
readonly required: true;
|
|
984
|
+
readonly helpId: "widgetHintSignalThresholds";
|
|
985
|
+
readonly doc: "The steps of the signal, lowest first: one bar per entry, lit once the value reaches it and coloured by its level. At least two, at most eight.";
|
|
986
|
+
};
|
|
987
|
+
readonly staleAfterSeconds: {
|
|
988
|
+
readonly kind: 'number';
|
|
989
|
+
readonly integer: true;
|
|
990
|
+
readonly min: 1;
|
|
991
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
992
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
993
|
+
readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
|
|
994
|
+
};
|
|
995
|
+
readonly window: {
|
|
996
|
+
readonly kind: 'number';
|
|
997
|
+
readonly integer: true;
|
|
998
|
+
readonly min: 1;
|
|
999
|
+
readonly labelId: 'widgetLabelWindow';
|
|
1000
|
+
readonly helpId: 'widgetHintWindow';
|
|
1001
|
+
readonly doc: 'Samples retained across ALL of the widget\'s measurements before the oldest are dropped. Bounds memory; only the chart draws them. Default 300.';
|
|
1002
|
+
};
|
|
1003
|
+
}>, import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
1004
|
+
readonly title: {
|
|
1005
|
+
readonly kind: 'string';
|
|
1006
|
+
readonly labelId: 'widgetLabelTitle';
|
|
1007
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
1008
|
+
};
|
|
1009
|
+
readonly measurement: {
|
|
1010
|
+
readonly kind: 'string';
|
|
1011
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
1012
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
1013
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
1014
|
+
};
|
|
1015
|
+
readonly precision: {
|
|
1016
|
+
readonly kind: 'number';
|
|
1017
|
+
readonly integer: true;
|
|
1018
|
+
readonly min: 0;
|
|
1019
|
+
readonly max: 100;
|
|
1020
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
1021
|
+
readonly helpId: 'widgetHintPrecision';
|
|
1022
|
+
readonly doc: "Decimal places of the heading. Default 0 (whole degrees). The heading is rounded first, then folded onto 0 to 360, so it never reads 360.";
|
|
1023
|
+
};
|
|
1024
|
+
readonly thresholds: {
|
|
1025
|
+
readonly kind: 'list';
|
|
1026
|
+
readonly maxItems: 12;
|
|
1027
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
1028
|
+
readonly helpId: 'widgetHintThresholds';
|
|
1029
|
+
readonly item: {
|
|
1030
|
+
readonly value: {
|
|
1031
|
+
readonly kind: 'number';
|
|
1032
|
+
readonly required: true;
|
|
1033
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
1034
|
+
readonly doc: 'The value at which this band starts.';
|
|
1035
|
+
};
|
|
1036
|
+
readonly level: {
|
|
1037
|
+
readonly kind: 'enum';
|
|
1038
|
+
readonly required: true;
|
|
1039
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
1040
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
1041
|
+
readonly valueLabelIds: {
|
|
1042
|
+
readonly normal: 'widgetSeverityNormal';
|
|
1043
|
+
readonly warning: 'widgetSeverityWarning';
|
|
1044
|
+
readonly minor: 'widgetSeverityMinor';
|
|
1045
|
+
readonly major: 'widgetSeverityMajor';
|
|
1046
|
+
readonly critical: 'widgetSeverityCritical';
|
|
1047
|
+
};
|
|
1048
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
1049
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
1050
|
+
};
|
|
1051
|
+
readonly label: {
|
|
1052
|
+
readonly kind: 'string';
|
|
1053
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
1054
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
1055
|
+
};
|
|
1056
|
+
};
|
|
1057
|
+
readonly doc: "Severity bands over the heading in degrees (0 to 360, after folding). Each entry starts a band at its value that runs to the next entry; below the first, and in a normal band, the needle keeps its own colour.";
|
|
1058
|
+
};
|
|
1059
|
+
readonly staleAfterSeconds: {
|
|
1060
|
+
readonly kind: 'number';
|
|
1061
|
+
readonly integer: true;
|
|
1062
|
+
readonly min: 1;
|
|
1063
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
1064
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
1065
|
+
readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
|
|
1066
|
+
};
|
|
1067
|
+
readonly window: {
|
|
1068
|
+
readonly kind: 'number';
|
|
1069
|
+
readonly integer: true;
|
|
1070
|
+
readonly min: 1;
|
|
1071
|
+
readonly labelId: 'widgetLabelWindow';
|
|
1072
|
+
readonly helpId: 'widgetHintWindow';
|
|
1073
|
+
readonly doc: 'Samples retained across ALL of the widget\'s measurements before the oldest are dropped. Bounds memory; only the chart draws them. Default 300.';
|
|
1074
|
+
};
|
|
1075
|
+
}>, import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
1076
|
+
readonly title: {
|
|
1077
|
+
readonly kind: 'string';
|
|
1078
|
+
readonly labelId: 'widgetLabelTitle';
|
|
1079
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
1080
|
+
};
|
|
1081
|
+
readonly measurement: {
|
|
1082
|
+
readonly kind: 'string';
|
|
1083
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
1084
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
1085
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
1086
|
+
};
|
|
1087
|
+
readonly min: {
|
|
1088
|
+
readonly kind: 'number';
|
|
1089
|
+
readonly required: true;
|
|
1090
|
+
readonly labelId: 'widgetLabelMin';
|
|
1091
|
+
readonly helpId: 'widgetHintScaleMin';
|
|
1092
|
+
readonly doc: 'Value at the empty end of the scale. Required: the widget does not guess a range.';
|
|
1093
|
+
};
|
|
1094
|
+
readonly max: {
|
|
1095
|
+
readonly kind: 'number';
|
|
1096
|
+
readonly required: true;
|
|
1097
|
+
readonly labelId: 'widgetLabelMax';
|
|
1098
|
+
readonly helpId: 'widgetHintScaleMax';
|
|
1099
|
+
readonly doc: 'Value at the full end of the scale. Required, and above min.';
|
|
1100
|
+
};
|
|
1101
|
+
readonly readout: {
|
|
1102
|
+
readonly kind: "enum";
|
|
1103
|
+
readonly values: readonly ["percent", "value"];
|
|
1104
|
+
readonly labelId: "widgetLabelReadout";
|
|
1105
|
+
readonly valueLabelIds: {
|
|
1106
|
+
readonly percent: "widgetReadoutPercent";
|
|
1107
|
+
readonly value: "widgetReadoutValue";
|
|
1108
|
+
};
|
|
1109
|
+
readonly placeholderId: "widgetPlaceholderDefault";
|
|
1110
|
+
readonly doc: "What the middle of the ring shows: the percent of the scale (default) or the value with its unit.";
|
|
1111
|
+
};
|
|
1112
|
+
readonly unit: {
|
|
1113
|
+
readonly kind: 'string';
|
|
1114
|
+
readonly labelId: 'widgetLabelUnit';
|
|
1115
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
1116
|
+
};
|
|
1117
|
+
readonly precision: {
|
|
1118
|
+
readonly kind: 'number';
|
|
1119
|
+
readonly integer: true;
|
|
1120
|
+
readonly min: 0;
|
|
1121
|
+
readonly max: 100;
|
|
1122
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
1123
|
+
readonly helpId: 'widgetHintPrecision';
|
|
1124
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
1125
|
+
};
|
|
1126
|
+
readonly thresholds: {
|
|
1127
|
+
readonly kind: 'list';
|
|
1128
|
+
readonly maxItems: 12;
|
|
1129
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
1130
|
+
readonly helpId: 'widgetHintThresholds';
|
|
1131
|
+
readonly doc: 'Severity bands over the value. Each entry starts a band at its value that runs to the next entry; below the first, and in a normal band, the widget keeps its own colour.';
|
|
1132
|
+
readonly item: {
|
|
1133
|
+
readonly value: {
|
|
1134
|
+
readonly kind: 'number';
|
|
1135
|
+
readonly required: true;
|
|
1136
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
1137
|
+
readonly doc: 'The value at which this band starts.';
|
|
1138
|
+
};
|
|
1139
|
+
readonly level: {
|
|
1140
|
+
readonly kind: 'enum';
|
|
1141
|
+
readonly required: true;
|
|
1142
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
1143
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
1144
|
+
readonly valueLabelIds: {
|
|
1145
|
+
readonly normal: 'widgetSeverityNormal';
|
|
1146
|
+
readonly warning: 'widgetSeverityWarning';
|
|
1147
|
+
readonly minor: 'widgetSeverityMinor';
|
|
1148
|
+
readonly major: 'widgetSeverityMajor';
|
|
1149
|
+
readonly critical: 'widgetSeverityCritical';
|
|
1150
|
+
};
|
|
1151
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
1152
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
1153
|
+
};
|
|
1154
|
+
readonly label: {
|
|
1155
|
+
readonly kind: 'string';
|
|
1156
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
1157
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
1158
|
+
};
|
|
1159
|
+
};
|
|
1160
|
+
};
|
|
1161
|
+
readonly staleAfterSeconds: {
|
|
1162
|
+
readonly kind: 'number';
|
|
1163
|
+
readonly integer: true;
|
|
1164
|
+
readonly min: 1;
|
|
1165
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
1166
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
1167
|
+
readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
|
|
1168
|
+
};
|
|
1169
|
+
readonly window: {
|
|
1170
|
+
readonly kind: 'number';
|
|
1171
|
+
readonly integer: true;
|
|
1172
|
+
readonly min: 1;
|
|
1173
|
+
readonly labelId: 'widgetLabelWindow';
|
|
1174
|
+
readonly helpId: 'widgetHintWindow';
|
|
1175
|
+
readonly doc: 'Samples retained across ALL of the widget\'s measurements before the oldest are dropped. Bounds memory; only the chart draws them. Default 300.';
|
|
1176
|
+
};
|
|
1177
|
+
}>, import("@devicechain/widget-sdk").WidgetDefinition<"control", {
|
|
1178
|
+
readonly title: {
|
|
1179
|
+
readonly kind: 'string';
|
|
1180
|
+
readonly labelId: 'widgetLabelTitle';
|
|
1181
|
+
readonly doc: 'Heading shown in the widget frame. Blank hides the frame heading.';
|
|
1182
|
+
};
|
|
1183
|
+
readonly commandName: {
|
|
1184
|
+
readonly kind: 'string';
|
|
1185
|
+
readonly required: true;
|
|
1186
|
+
readonly labelId: 'widgetCommandHeading';
|
|
1187
|
+
readonly helpId: 'widgetCommandFieldHint';
|
|
1188
|
+
readonly control: 'command-vocabulary';
|
|
1189
|
+
readonly doc: 'Command key issued to the target device. Without it the control cannot send.';
|
|
1190
|
+
};
|
|
1191
|
+
readonly commandLabel: {
|
|
1192
|
+
readonly kind: 'string';
|
|
1193
|
+
readonly labelId: 'widgetCommandHeading';
|
|
1194
|
+
readonly helpId: 'widgetCommandFieldHint';
|
|
1195
|
+
readonly control: 'command-vocabulary';
|
|
1196
|
+
readonly doc: 'Name of the control for assistive technology. Defaults to the command key.';
|
|
1197
|
+
};
|
|
1198
|
+
readonly parameterSchema: {
|
|
1199
|
+
readonly kind: 'string';
|
|
1200
|
+
readonly format: 'json';
|
|
1201
|
+
readonly labelId: 'widgetCommandHeading';
|
|
1202
|
+
readonly helpId: 'widgetCommandFieldHint';
|
|
1203
|
+
readonly control: 'command-vocabulary';
|
|
1204
|
+
readonly doc: "The command's parameter descriptors, baked in as JSON at author time. Gives the control its range and its refusals.";
|
|
1205
|
+
};
|
|
1206
|
+
readonly parameter: {
|
|
1207
|
+
readonly kind: 'string';
|
|
1208
|
+
readonly labelId: 'widgetLabelParameter';
|
|
1209
|
+
readonly helpId: 'widgetHintControlParameter';
|
|
1210
|
+
readonly doc: 'Which parameter of the command this control sets. May be left blank when the command has exactly one parameter of the right type.';
|
|
1211
|
+
};
|
|
1212
|
+
readonly min: {
|
|
1213
|
+
readonly kind: "number";
|
|
1214
|
+
readonly labelId: "widgetLabelMin";
|
|
1215
|
+
readonly helpId: "widgetHintSliderRange";
|
|
1216
|
+
readonly doc: "Lowest value, used only when the command's parameter declares no minimum.";
|
|
1217
|
+
};
|
|
1218
|
+
readonly max: {
|
|
1219
|
+
readonly kind: "number";
|
|
1220
|
+
readonly labelId: "widgetLabelMax";
|
|
1221
|
+
readonly helpId: "widgetHintSliderRange";
|
|
1222
|
+
readonly doc: "Highest value, used only when the command's parameter declares no maximum.";
|
|
1223
|
+
};
|
|
1224
|
+
readonly step: {
|
|
1225
|
+
readonly kind: "number";
|
|
1226
|
+
readonly min: 0;
|
|
1227
|
+
readonly labelId: "widgetLabelStep";
|
|
1228
|
+
readonly helpId: "widgetHintSliderStep";
|
|
1229
|
+
readonly doc: "Distance between values. Defaults to 1 for a whole-number parameter, else a hundredth of the range.";
|
|
1230
|
+
};
|
|
1231
|
+
}>, import("@devicechain/widget-sdk").WidgetDefinition<"control", {
|
|
1232
|
+
readonly title: {
|
|
1233
|
+
readonly kind: 'string';
|
|
1234
|
+
readonly labelId: 'widgetLabelTitle';
|
|
1235
|
+
readonly doc: 'Heading shown in the widget frame. Blank hides the frame heading.';
|
|
1236
|
+
};
|
|
1237
|
+
readonly commandName: {
|
|
1238
|
+
readonly kind: 'string';
|
|
1239
|
+
readonly required: true;
|
|
1240
|
+
readonly labelId: 'widgetCommandHeading';
|
|
1241
|
+
readonly helpId: 'widgetCommandFieldHint';
|
|
1242
|
+
readonly control: 'command-vocabulary';
|
|
1243
|
+
readonly doc: 'Command key issued to the target device. Without it the control cannot send.';
|
|
1244
|
+
};
|
|
1245
|
+
readonly commandLabel: {
|
|
1246
|
+
readonly kind: 'string';
|
|
1247
|
+
readonly labelId: 'widgetCommandHeading';
|
|
1248
|
+
readonly helpId: 'widgetCommandFieldHint';
|
|
1249
|
+
readonly control: 'command-vocabulary';
|
|
1250
|
+
readonly doc: 'Name of the control for assistive technology. Defaults to the command key.';
|
|
1251
|
+
};
|
|
1252
|
+
readonly parameterSchema: {
|
|
1253
|
+
readonly kind: 'string';
|
|
1254
|
+
readonly format: 'json';
|
|
1255
|
+
readonly labelId: 'widgetCommandHeading';
|
|
1256
|
+
readonly helpId: 'widgetCommandFieldHint';
|
|
1257
|
+
readonly control: 'command-vocabulary';
|
|
1258
|
+
readonly doc: "The command's parameter descriptors, baked in as JSON at author time. Gives the control its range and its refusals.";
|
|
1259
|
+
};
|
|
1260
|
+
readonly parameter: {
|
|
1261
|
+
readonly kind: 'string';
|
|
1262
|
+
readonly labelId: 'widgetLabelParameter';
|
|
1263
|
+
readonly helpId: 'widgetHintControlParameter';
|
|
1264
|
+
readonly doc: 'Which parameter of the command this control sets. May be left blank when the command has exactly one parameter of the right type.';
|
|
1265
|
+
};
|
|
1266
|
+
}>, import("@devicechain/widget-sdk").WidgetDefinition<"aggregate", {
|
|
1267
|
+
readonly title: {
|
|
1268
|
+
readonly kind: 'string';
|
|
1269
|
+
readonly labelId: 'widgetLabelTitle';
|
|
1270
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
1271
|
+
};
|
|
1272
|
+
readonly measurement: {
|
|
1273
|
+
readonly kind: 'string';
|
|
1274
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
1275
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
1276
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
1277
|
+
};
|
|
1278
|
+
readonly stat: {
|
|
1279
|
+
readonly kind: "enum";
|
|
1280
|
+
readonly values: readonly ["avg", "min", "max", "sum", "count", "last"];
|
|
1281
|
+
readonly labelId: "widgetLabelStat";
|
|
1282
|
+
readonly helpId: "widgetHintStat";
|
|
1283
|
+
readonly valueLabelIds: {
|
|
1284
|
+
readonly avg: "widgetStatAvg";
|
|
1285
|
+
readonly min: "widgetStatMin";
|
|
1286
|
+
readonly max: "widgetStatMax";
|
|
1287
|
+
readonly sum: "widgetStatSum";
|
|
1288
|
+
readonly count: "widgetStatCount";
|
|
1289
|
+
readonly last: "widgetStatLast";
|
|
1290
|
+
};
|
|
1291
|
+
readonly placeholderId: "widgetPlaceholderDefault";
|
|
1292
|
+
readonly doc: "Which figure to show. Default average.";
|
|
1293
|
+
};
|
|
1294
|
+
readonly unit: {
|
|
1295
|
+
readonly kind: 'string';
|
|
1296
|
+
readonly labelId: 'widgetLabelUnit';
|
|
1297
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
1298
|
+
};
|
|
1299
|
+
readonly precision: {
|
|
1300
|
+
readonly kind: 'number';
|
|
1301
|
+
readonly integer: true;
|
|
1302
|
+
readonly min: 0;
|
|
1303
|
+
readonly max: 100;
|
|
1304
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
1305
|
+
readonly helpId: 'widgetHintPrecision';
|
|
1306
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
1307
|
+
};
|
|
1308
|
+
readonly thresholds: {
|
|
1309
|
+
readonly kind: 'list';
|
|
1310
|
+
readonly maxItems: 12;
|
|
1311
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
1312
|
+
readonly helpId: 'widgetHintThresholds';
|
|
1313
|
+
readonly doc: 'Severity bands over the value. Each entry starts a band at its value that runs to the next entry; below the first, and in a normal band, the widget keeps its own colour.';
|
|
1314
|
+
readonly item: {
|
|
1315
|
+
readonly value: {
|
|
1316
|
+
readonly kind: 'number';
|
|
1317
|
+
readonly required: true;
|
|
1318
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
1319
|
+
readonly doc: 'The value at which this band starts.';
|
|
1320
|
+
};
|
|
1321
|
+
readonly level: {
|
|
1322
|
+
readonly kind: 'enum';
|
|
1323
|
+
readonly required: true;
|
|
1324
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
1325
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
1326
|
+
readonly valueLabelIds: {
|
|
1327
|
+
readonly normal: 'widgetSeverityNormal';
|
|
1328
|
+
readonly warning: 'widgetSeverityWarning';
|
|
1329
|
+
readonly minor: 'widgetSeverityMinor';
|
|
1330
|
+
readonly major: 'widgetSeverityMajor';
|
|
1331
|
+
readonly critical: 'widgetSeverityCritical';
|
|
1332
|
+
};
|
|
1333
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
1334
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
1335
|
+
};
|
|
1336
|
+
readonly label: {
|
|
1337
|
+
readonly kind: 'string';
|
|
1338
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
1339
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
1340
|
+
};
|
|
1341
|
+
};
|
|
1342
|
+
};
|
|
1343
|
+
readonly windowSeconds: {
|
|
1344
|
+
readonly kind: 'number';
|
|
1345
|
+
readonly integer: true;
|
|
1346
|
+
readonly min: 60;
|
|
1347
|
+
readonly max: 604800;
|
|
1348
|
+
readonly labelId: 'widgetLabelWindowSeconds';
|
|
1349
|
+
readonly helpId: 'widgetHintWindowSeconds';
|
|
1350
|
+
readonly doc: 'Seconds of history the widget covers, back from now. Leave unset to follow the board’s time range; set it to pin this widget to a fixed span that the viewer’s range picker does not change. 60 to 604800.';
|
|
1351
|
+
};
|
|
1352
|
+
}>, import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
1353
|
+
readonly title: {
|
|
1354
|
+
readonly kind: 'string';
|
|
1355
|
+
readonly labelId: 'widgetLabelTitle';
|
|
1356
|
+
readonly doc: 'Heading shown in the widget frame. Blank hides the frame heading.';
|
|
1357
|
+
};
|
|
1358
|
+
readonly groupBy: {
|
|
1359
|
+
readonly kind: "enum";
|
|
1360
|
+
readonly values: readonly ["measurement", "device"];
|
|
1361
|
+
readonly labelId: "widgetLabelGroupBy";
|
|
1362
|
+
readonly helpId: "widgetHintGroupBy";
|
|
1363
|
+
readonly valueLabelIds: {
|
|
1364
|
+
readonly measurement: "widgetGroupByMeasurement";
|
|
1365
|
+
readonly device: "widgetGroupByDevice";
|
|
1366
|
+
};
|
|
1367
|
+
readonly placeholderId: "widgetPlaceholderDefault";
|
|
1368
|
+
readonly doc: "One bar per measurement (the default), or per device of the group for the measurement set below.";
|
|
1369
|
+
};
|
|
1370
|
+
readonly measurement: {
|
|
1371
|
+
readonly kind: 'string';
|
|
1372
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
1373
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
1374
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
1375
|
+
};
|
|
1376
|
+
readonly unit: {
|
|
1377
|
+
readonly kind: 'string';
|
|
1378
|
+
readonly labelId: 'widgetLabelUnit';
|
|
1379
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
1380
|
+
};
|
|
1381
|
+
readonly precision: {
|
|
1382
|
+
readonly kind: 'number';
|
|
1383
|
+
readonly integer: true;
|
|
1384
|
+
readonly min: 0;
|
|
1385
|
+
readonly max: 100;
|
|
1386
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
1387
|
+
readonly helpId: 'widgetHintPrecision';
|
|
1388
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
1389
|
+
};
|
|
1390
|
+
readonly sort: {
|
|
1391
|
+
readonly kind: 'enum';
|
|
1392
|
+
readonly values: readonly ["none", "ascending", "descending"];
|
|
1393
|
+
readonly labelId: 'widgetLabelSort';
|
|
1394
|
+
readonly valueLabelIds: {
|
|
1395
|
+
readonly none: 'widgetSortNone';
|
|
1396
|
+
readonly ascending: 'widgetSortAscending';
|
|
1397
|
+
readonly descending: 'widgetSortDescending';
|
|
1398
|
+
};
|
|
1399
|
+
readonly placeholderId: 'widgetPlaceholderDefault';
|
|
1400
|
+
readonly doc: 'Order of the categories. Default: as the data source lists them.';
|
|
1401
|
+
};
|
|
1402
|
+
}>, import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
1403
|
+
readonly title: {
|
|
1404
|
+
readonly kind: 'string';
|
|
1405
|
+
readonly labelId: 'widgetLabelTitle';
|
|
1406
|
+
readonly doc: 'Heading shown in the widget frame. Blank hides the frame heading.';
|
|
1407
|
+
};
|
|
1408
|
+
readonly unit: {
|
|
1409
|
+
readonly kind: 'string';
|
|
1410
|
+
readonly labelId: 'widgetLabelUnit';
|
|
1411
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
1412
|
+
};
|
|
1413
|
+
readonly precision: {
|
|
1414
|
+
readonly kind: 'number';
|
|
1415
|
+
readonly integer: true;
|
|
1416
|
+
readonly min: 0;
|
|
1417
|
+
readonly max: 100;
|
|
1418
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
1419
|
+
readonly helpId: 'widgetHintPrecision';
|
|
1420
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
1421
|
+
};
|
|
1422
|
+
readonly sort: {
|
|
1423
|
+
readonly kind: 'enum';
|
|
1424
|
+
readonly values: readonly ["none", "ascending", "descending"];
|
|
1425
|
+
readonly labelId: 'widgetLabelSort';
|
|
1426
|
+
readonly valueLabelIds: {
|
|
1427
|
+
readonly none: 'widgetSortNone';
|
|
1428
|
+
readonly ascending: 'widgetSortAscending';
|
|
1429
|
+
readonly descending: 'widgetSortDescending';
|
|
1430
|
+
};
|
|
1431
|
+
readonly placeholderId: 'widgetPlaceholderDefault';
|
|
1432
|
+
readonly doc: 'Order of the categories. Default: as the data source lists them.';
|
|
1433
|
+
};
|
|
1434
|
+
}>, import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
1435
|
+
readonly title: {
|
|
1436
|
+
readonly kind: 'string';
|
|
1437
|
+
readonly labelId: 'widgetLabelTitle';
|
|
1438
|
+
readonly doc: 'Heading shown in the widget frame. Blank hides the frame heading.';
|
|
1439
|
+
};
|
|
1440
|
+
readonly columns: {
|
|
1441
|
+
readonly kind: 'list';
|
|
1442
|
+
readonly maxItems: 24;
|
|
1443
|
+
readonly labelId: 'widgetLabelColumns';
|
|
1444
|
+
readonly helpId: 'widgetHintColumns';
|
|
1445
|
+
readonly doc: 'Heading, unit and precision per measurement column; a column with none shows its name.';
|
|
1446
|
+
readonly item: {
|
|
1447
|
+
readonly measurement: {
|
|
1448
|
+
readonly kind: 'string';
|
|
1449
|
+
readonly required: true;
|
|
1450
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
1451
|
+
readonly doc: 'The measurement column this entry applies to.';
|
|
1452
|
+
};
|
|
1453
|
+
readonly label: {
|
|
1454
|
+
readonly kind: 'string';
|
|
1455
|
+
readonly labelId: 'widgetLabelColumnHeading';
|
|
1456
|
+
readonly doc: 'Column heading. Defaults to the measurement name.';
|
|
1457
|
+
};
|
|
1458
|
+
readonly unit: {
|
|
1459
|
+
readonly kind: 'string';
|
|
1460
|
+
readonly labelId: 'widgetLabelUnit';
|
|
1461
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
1462
|
+
};
|
|
1463
|
+
readonly precision: {
|
|
1464
|
+
readonly kind: 'number';
|
|
1465
|
+
readonly integer: true;
|
|
1466
|
+
readonly min: 0;
|
|
1467
|
+
readonly max: 100;
|
|
1468
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
1469
|
+
readonly helpId: 'widgetHintPrecision';
|
|
1470
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
1471
|
+
};
|
|
1472
|
+
};
|
|
1473
|
+
};
|
|
1474
|
+
readonly thresholds: {
|
|
1475
|
+
readonly kind: 'list';
|
|
1476
|
+
readonly maxItems: 12;
|
|
1477
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
1478
|
+
readonly helpId: 'widgetHintThresholds';
|
|
1479
|
+
readonly doc: 'Severity bands over the value. Each entry starts a band at its value that runs to the next entry; below the first, and in a normal band, the widget keeps its own colour.';
|
|
1480
|
+
readonly item: {
|
|
1481
|
+
readonly value: {
|
|
1482
|
+
readonly kind: 'number';
|
|
1483
|
+
readonly required: true;
|
|
1484
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
1485
|
+
readonly doc: 'The value at which this band starts.';
|
|
1486
|
+
};
|
|
1487
|
+
readonly level: {
|
|
1488
|
+
readonly kind: 'enum';
|
|
1489
|
+
readonly required: true;
|
|
1490
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
1491
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
1492
|
+
readonly valueLabelIds: {
|
|
1493
|
+
readonly normal: 'widgetSeverityNormal';
|
|
1494
|
+
readonly warning: 'widgetSeverityWarning';
|
|
1495
|
+
readonly minor: 'widgetSeverityMinor';
|
|
1496
|
+
readonly major: 'widgetSeverityMajor';
|
|
1497
|
+
readonly critical: 'widgetSeverityCritical';
|
|
1498
|
+
};
|
|
1499
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
1500
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
1501
|
+
};
|
|
1502
|
+
readonly label: {
|
|
1503
|
+
readonly kind: 'string';
|
|
1504
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
1505
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
1506
|
+
};
|
|
1507
|
+
readonly measurement: {
|
|
1508
|
+
readonly kind: 'string';
|
|
1509
|
+
readonly required: true;
|
|
1510
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
1511
|
+
readonly doc: 'The measurement column this entry applies to.';
|
|
1512
|
+
};
|
|
1513
|
+
};
|
|
1514
|
+
};
|
|
1515
|
+
readonly staleAfterSeconds: {
|
|
1516
|
+
readonly kind: 'number';
|
|
1517
|
+
readonly integer: true;
|
|
1518
|
+
readonly min: 1;
|
|
1519
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
1520
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
1521
|
+
readonly doc: 'Seconds after which the newest sample is called stale: the value is greyed out and badged. Unset shows the sample age only and never marks the widget stale.';
|
|
1522
|
+
};
|
|
1523
|
+
readonly ageLagSeconds: {
|
|
1524
|
+
readonly kind: "number";
|
|
1525
|
+
readonly integer: true;
|
|
1526
|
+
readonly min: 1;
|
|
1527
|
+
readonly labelId: "widgetLabelAgeLag";
|
|
1528
|
+
readonly helpId: "widgetHintAgeLag";
|
|
1529
|
+
readonly doc: "Show a reading's age under it only when the reading is at least this many seconds older than the newest reading in the table (or stale). Unset shows every reading's age.";
|
|
1530
|
+
};
|
|
1531
|
+
readonly sortBy: {
|
|
1532
|
+
readonly kind: "string";
|
|
1533
|
+
readonly labelId: "widgetLabelSortBy";
|
|
1534
|
+
readonly helpId: "widgetHintSortBy";
|
|
1535
|
+
readonly doc: "The measurement the table is ordered by. Blank orders by device name.";
|
|
1536
|
+
};
|
|
1537
|
+
readonly sortDescending: {
|
|
1538
|
+
readonly kind: "boolean";
|
|
1539
|
+
readonly labelId: "widgetLabelSortDescending";
|
|
1540
|
+
readonly doc: "Largest first.";
|
|
1541
|
+
};
|
|
1542
|
+
readonly pageSize: {
|
|
1543
|
+
readonly kind: "number";
|
|
1544
|
+
readonly integer: true;
|
|
1545
|
+
readonly min: 5;
|
|
1546
|
+
readonly max: 100;
|
|
1547
|
+
readonly labelId: "widgetLabelPageSize";
|
|
1548
|
+
readonly doc: "Devices per page. Default 20.";
|
|
1549
|
+
};
|
|
1550
|
+
readonly selectionTarget: {
|
|
1551
|
+
readonly kind: 'string';
|
|
1552
|
+
readonly labelId: 'widgetLabelTargetSlot';
|
|
1553
|
+
readonly helpId: 'widgetTargetSlotHint';
|
|
1554
|
+
readonly control: 'slot-target';
|
|
1555
|
+
readonly doc: 'Name of the slot this widget re-points when the viewer picks an entity.';
|
|
1556
|
+
};
|
|
1557
|
+
readonly windowSeconds: {
|
|
1558
|
+
readonly kind: 'number';
|
|
1559
|
+
readonly integer: true;
|
|
1560
|
+
readonly min: 60;
|
|
1561
|
+
readonly max: 604800;
|
|
1562
|
+
readonly labelId: 'widgetLabelWindowSeconds';
|
|
1563
|
+
readonly helpId: 'widgetHintWindowSeconds';
|
|
1564
|
+
readonly doc: 'Seconds of history the widget covers, back from now. Leave unset to follow the board’s time range; set it to pin this widget to a fixed span that the viewer’s range picker does not change. 60 to 604800.';
|
|
1565
|
+
};
|
|
377
1566
|
}>];
|
|
378
1567
|
export declare function createBuiltinWidgetRegistry(): WidgetRegistry;
|