@devicechain/widgets 0.21.1 → 0.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/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
|
@@ -0,0 +1,647 @@
|
|
|
1
|
+
export declare const loadLevelWidgets: () => Promise<typeof import("./level-widgets")>;
|
|
2
|
+
export declare const linearGaugeWidget: import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
3
|
+
readonly title: {
|
|
4
|
+
readonly kind: 'string';
|
|
5
|
+
readonly labelId: 'widgetLabelTitle';
|
|
6
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
7
|
+
};
|
|
8
|
+
readonly measurement: {
|
|
9
|
+
readonly kind: 'string';
|
|
10
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
11
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
12
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
13
|
+
};
|
|
14
|
+
readonly min: {
|
|
15
|
+
readonly kind: 'number';
|
|
16
|
+
readonly required: true;
|
|
17
|
+
readonly labelId: 'widgetLabelMin';
|
|
18
|
+
readonly helpId: 'widgetHintScaleMin';
|
|
19
|
+
readonly doc: 'Value at the empty end of the scale. Required: the widget does not guess a range.';
|
|
20
|
+
};
|
|
21
|
+
readonly max: {
|
|
22
|
+
readonly kind: 'number';
|
|
23
|
+
readonly required: true;
|
|
24
|
+
readonly labelId: 'widgetLabelMax';
|
|
25
|
+
readonly helpId: 'widgetHintScaleMax';
|
|
26
|
+
readonly doc: 'Value at the full end of the scale. Required, and above min.';
|
|
27
|
+
};
|
|
28
|
+
readonly style: {
|
|
29
|
+
readonly kind: "enum";
|
|
30
|
+
readonly values: readonly ["bar", "thermometer"];
|
|
31
|
+
readonly labelId: "widgetLabelLinearStyle";
|
|
32
|
+
readonly valueLabelIds: {
|
|
33
|
+
readonly bar: "widgetLinearStyleBar";
|
|
34
|
+
readonly thermometer: "widgetLinearStyleThermometer";
|
|
35
|
+
};
|
|
36
|
+
readonly placeholderId: "widgetPlaceholderDefault";
|
|
37
|
+
readonly doc: "A plain bar (default) or a thermometer: a vertical tube with a bulb. A thermometer is always vertical.";
|
|
38
|
+
};
|
|
39
|
+
readonly orientation: {
|
|
40
|
+
readonly kind: "enum";
|
|
41
|
+
readonly values: readonly ["horizontal", "vertical"];
|
|
42
|
+
readonly labelId: "widgetLabelOrientation";
|
|
43
|
+
readonly valueLabelIds: {
|
|
44
|
+
readonly horizontal: "widgetOrientationHorizontal";
|
|
45
|
+
readonly vertical: "widgetOrientationVertical";
|
|
46
|
+
};
|
|
47
|
+
readonly placeholderId: "widgetPlaceholderDefault";
|
|
48
|
+
readonly doc: "Direction of a bar: horizontal (default) or vertical. Ignored by a thermometer.";
|
|
49
|
+
};
|
|
50
|
+
readonly unit: {
|
|
51
|
+
readonly kind: 'string';
|
|
52
|
+
readonly labelId: 'widgetLabelUnit';
|
|
53
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
54
|
+
};
|
|
55
|
+
readonly precision: {
|
|
56
|
+
readonly kind: 'number';
|
|
57
|
+
readonly integer: true;
|
|
58
|
+
readonly min: 0;
|
|
59
|
+
readonly max: 100;
|
|
60
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
61
|
+
readonly helpId: 'widgetHintPrecision';
|
|
62
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
63
|
+
};
|
|
64
|
+
readonly thresholds: {
|
|
65
|
+
readonly kind: 'list';
|
|
66
|
+
readonly maxItems: 12;
|
|
67
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
68
|
+
readonly helpId: 'widgetHintThresholds';
|
|
69
|
+
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.';
|
|
70
|
+
readonly item: {
|
|
71
|
+
readonly value: {
|
|
72
|
+
readonly kind: 'number';
|
|
73
|
+
readonly required: true;
|
|
74
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
75
|
+
readonly doc: 'The value at which this band starts.';
|
|
76
|
+
};
|
|
77
|
+
readonly level: {
|
|
78
|
+
readonly kind: 'enum';
|
|
79
|
+
readonly required: true;
|
|
80
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
81
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
82
|
+
readonly valueLabelIds: {
|
|
83
|
+
readonly normal: 'widgetSeverityNormal';
|
|
84
|
+
readonly warning: 'widgetSeverityWarning';
|
|
85
|
+
readonly minor: 'widgetSeverityMinor';
|
|
86
|
+
readonly major: 'widgetSeverityMajor';
|
|
87
|
+
readonly critical: 'widgetSeverityCritical';
|
|
88
|
+
};
|
|
89
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
90
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
91
|
+
};
|
|
92
|
+
readonly label: {
|
|
93
|
+
readonly kind: 'string';
|
|
94
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
95
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
};
|
|
99
|
+
readonly staleAfterSeconds: {
|
|
100
|
+
readonly kind: 'number';
|
|
101
|
+
readonly integer: true;
|
|
102
|
+
readonly min: 1;
|
|
103
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
104
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
105
|
+
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.';
|
|
106
|
+
};
|
|
107
|
+
readonly window: {
|
|
108
|
+
readonly kind: 'number';
|
|
109
|
+
readonly integer: true;
|
|
110
|
+
readonly min: 1;
|
|
111
|
+
readonly labelId: 'widgetLabelWindow';
|
|
112
|
+
readonly helpId: 'widgetHintWindow';
|
|
113
|
+
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.';
|
|
114
|
+
};
|
|
115
|
+
}>;
|
|
116
|
+
export declare const levelGaugeWidget: import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
117
|
+
readonly title: {
|
|
118
|
+
readonly kind: 'string';
|
|
119
|
+
readonly labelId: 'widgetLabelTitle';
|
|
120
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
121
|
+
};
|
|
122
|
+
readonly measurement: {
|
|
123
|
+
readonly kind: 'string';
|
|
124
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
125
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
126
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
127
|
+
};
|
|
128
|
+
readonly min: {
|
|
129
|
+
readonly kind: 'number';
|
|
130
|
+
readonly required: true;
|
|
131
|
+
readonly labelId: 'widgetLabelMin';
|
|
132
|
+
readonly helpId: 'widgetHintScaleMin';
|
|
133
|
+
readonly doc: 'Value at the empty end of the scale. Required: the widget does not guess a range.';
|
|
134
|
+
};
|
|
135
|
+
readonly max: {
|
|
136
|
+
readonly kind: 'number';
|
|
137
|
+
readonly required: true;
|
|
138
|
+
readonly labelId: 'widgetLabelMax';
|
|
139
|
+
readonly helpId: 'widgetHintScaleMax';
|
|
140
|
+
readonly doc: 'Value at the full end of the scale. Required, and above min.';
|
|
141
|
+
};
|
|
142
|
+
readonly readout: {
|
|
143
|
+
readonly kind: "enum";
|
|
144
|
+
readonly values: readonly ["value", "percent"];
|
|
145
|
+
readonly labelId: "widgetLabelReadout";
|
|
146
|
+
readonly valueLabelIds: {
|
|
147
|
+
readonly value: "widgetReadoutValue";
|
|
148
|
+
readonly percent: "widgetReadoutPercent";
|
|
149
|
+
};
|
|
150
|
+
readonly placeholderId: "widgetPlaceholderDefault";
|
|
151
|
+
readonly doc: "What the readout shows: the value with its unit (default) or the percent of the scale.";
|
|
152
|
+
};
|
|
153
|
+
readonly unit: {
|
|
154
|
+
readonly kind: 'string';
|
|
155
|
+
readonly labelId: 'widgetLabelUnit';
|
|
156
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
157
|
+
};
|
|
158
|
+
readonly precision: {
|
|
159
|
+
readonly kind: 'number';
|
|
160
|
+
readonly integer: true;
|
|
161
|
+
readonly min: 0;
|
|
162
|
+
readonly max: 100;
|
|
163
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
164
|
+
readonly helpId: 'widgetHintPrecision';
|
|
165
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
166
|
+
};
|
|
167
|
+
readonly thresholds: {
|
|
168
|
+
readonly kind: 'list';
|
|
169
|
+
readonly maxItems: 12;
|
|
170
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
171
|
+
readonly helpId: 'widgetHintThresholds';
|
|
172
|
+
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.';
|
|
173
|
+
readonly item: {
|
|
174
|
+
readonly value: {
|
|
175
|
+
readonly kind: 'number';
|
|
176
|
+
readonly required: true;
|
|
177
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
178
|
+
readonly doc: 'The value at which this band starts.';
|
|
179
|
+
};
|
|
180
|
+
readonly level: {
|
|
181
|
+
readonly kind: 'enum';
|
|
182
|
+
readonly required: true;
|
|
183
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
184
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
185
|
+
readonly valueLabelIds: {
|
|
186
|
+
readonly normal: 'widgetSeverityNormal';
|
|
187
|
+
readonly warning: 'widgetSeverityWarning';
|
|
188
|
+
readonly minor: 'widgetSeverityMinor';
|
|
189
|
+
readonly major: 'widgetSeverityMajor';
|
|
190
|
+
readonly critical: 'widgetSeverityCritical';
|
|
191
|
+
};
|
|
192
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
193
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
194
|
+
};
|
|
195
|
+
readonly label: {
|
|
196
|
+
readonly kind: 'string';
|
|
197
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
198
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
199
|
+
};
|
|
200
|
+
};
|
|
201
|
+
};
|
|
202
|
+
readonly staleAfterSeconds: {
|
|
203
|
+
readonly kind: 'number';
|
|
204
|
+
readonly integer: true;
|
|
205
|
+
readonly min: 1;
|
|
206
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
207
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
208
|
+
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.';
|
|
209
|
+
};
|
|
210
|
+
readonly window: {
|
|
211
|
+
readonly kind: 'number';
|
|
212
|
+
readonly integer: true;
|
|
213
|
+
readonly min: 1;
|
|
214
|
+
readonly labelId: 'widgetLabelWindow';
|
|
215
|
+
readonly helpId: 'widgetHintWindow';
|
|
216
|
+
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.';
|
|
217
|
+
};
|
|
218
|
+
}>;
|
|
219
|
+
export declare const batteryWidget: import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
220
|
+
readonly title: {
|
|
221
|
+
readonly kind: 'string';
|
|
222
|
+
readonly labelId: 'widgetLabelTitle';
|
|
223
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
224
|
+
};
|
|
225
|
+
readonly measurement: {
|
|
226
|
+
readonly kind: 'string';
|
|
227
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
228
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
229
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
230
|
+
};
|
|
231
|
+
readonly min: {
|
|
232
|
+
readonly kind: "number";
|
|
233
|
+
readonly labelId: "widgetLabelMin";
|
|
234
|
+
readonly helpId: "widgetHintBatteryRange";
|
|
235
|
+
readonly doc: "Value of an empty battery. Default 0 (the scale is percent unless you set min and max).";
|
|
236
|
+
};
|
|
237
|
+
readonly max: {
|
|
238
|
+
readonly kind: "number";
|
|
239
|
+
readonly labelId: "widgetLabelMax";
|
|
240
|
+
readonly helpId: "widgetHintBatteryRange";
|
|
241
|
+
readonly doc: "Value of a full battery. Default 100 (the scale is percent unless you set min and max).";
|
|
242
|
+
};
|
|
243
|
+
readonly unit: {
|
|
244
|
+
readonly kind: 'string';
|
|
245
|
+
readonly labelId: 'widgetLabelUnit';
|
|
246
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
247
|
+
};
|
|
248
|
+
readonly precision: {
|
|
249
|
+
readonly kind: 'number';
|
|
250
|
+
readonly integer: true;
|
|
251
|
+
readonly min: 0;
|
|
252
|
+
readonly max: 100;
|
|
253
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
254
|
+
readonly helpId: 'widgetHintPrecision';
|
|
255
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
256
|
+
};
|
|
257
|
+
readonly thresholds: {
|
|
258
|
+
readonly kind: 'list';
|
|
259
|
+
readonly maxItems: 12;
|
|
260
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
261
|
+
readonly helpId: 'widgetHintThresholds';
|
|
262
|
+
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.';
|
|
263
|
+
readonly item: {
|
|
264
|
+
readonly value: {
|
|
265
|
+
readonly kind: 'number';
|
|
266
|
+
readonly required: true;
|
|
267
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
268
|
+
readonly doc: 'The value at which this band starts.';
|
|
269
|
+
};
|
|
270
|
+
readonly level: {
|
|
271
|
+
readonly kind: 'enum';
|
|
272
|
+
readonly required: true;
|
|
273
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
274
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
275
|
+
readonly valueLabelIds: {
|
|
276
|
+
readonly normal: 'widgetSeverityNormal';
|
|
277
|
+
readonly warning: 'widgetSeverityWarning';
|
|
278
|
+
readonly minor: 'widgetSeverityMinor';
|
|
279
|
+
readonly major: 'widgetSeverityMajor';
|
|
280
|
+
readonly critical: 'widgetSeverityCritical';
|
|
281
|
+
};
|
|
282
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
283
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
284
|
+
};
|
|
285
|
+
readonly label: {
|
|
286
|
+
readonly kind: 'string';
|
|
287
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
288
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
289
|
+
};
|
|
290
|
+
};
|
|
291
|
+
};
|
|
292
|
+
readonly staleAfterSeconds: {
|
|
293
|
+
readonly kind: 'number';
|
|
294
|
+
readonly integer: true;
|
|
295
|
+
readonly min: 1;
|
|
296
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
297
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
298
|
+
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.';
|
|
299
|
+
};
|
|
300
|
+
readonly window: {
|
|
301
|
+
readonly kind: 'number';
|
|
302
|
+
readonly integer: true;
|
|
303
|
+
readonly min: 1;
|
|
304
|
+
readonly labelId: 'widgetLabelWindow';
|
|
305
|
+
readonly helpId: 'widgetHintWindow';
|
|
306
|
+
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.';
|
|
307
|
+
};
|
|
308
|
+
}>;
|
|
309
|
+
export declare const statusLightWidget: import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
310
|
+
readonly title: {
|
|
311
|
+
readonly kind: 'string';
|
|
312
|
+
readonly labelId: 'widgetLabelTitle';
|
|
313
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
314
|
+
};
|
|
315
|
+
readonly measurement: {
|
|
316
|
+
readonly kind: 'string';
|
|
317
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
318
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
319
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
320
|
+
};
|
|
321
|
+
readonly onAt: {
|
|
322
|
+
readonly kind: "number";
|
|
323
|
+
readonly labelId: "widgetLabelOnAt";
|
|
324
|
+
readonly helpId: "widgetHintOnAt";
|
|
325
|
+
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.";
|
|
326
|
+
};
|
|
327
|
+
readonly unit: {
|
|
328
|
+
readonly kind: 'string';
|
|
329
|
+
readonly labelId: 'widgetLabelUnit';
|
|
330
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
331
|
+
};
|
|
332
|
+
readonly precision: {
|
|
333
|
+
readonly kind: 'number';
|
|
334
|
+
readonly integer: true;
|
|
335
|
+
readonly min: 0;
|
|
336
|
+
readonly max: 100;
|
|
337
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
338
|
+
readonly helpId: 'widgetHintPrecision';
|
|
339
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
340
|
+
};
|
|
341
|
+
readonly thresholds: {
|
|
342
|
+
readonly kind: 'list';
|
|
343
|
+
readonly maxItems: 12;
|
|
344
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
345
|
+
readonly helpId: 'widgetHintThresholds';
|
|
346
|
+
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.';
|
|
347
|
+
readonly item: {
|
|
348
|
+
readonly value: {
|
|
349
|
+
readonly kind: 'number';
|
|
350
|
+
readonly required: true;
|
|
351
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
352
|
+
readonly doc: 'The value at which this band starts.';
|
|
353
|
+
};
|
|
354
|
+
readonly level: {
|
|
355
|
+
readonly kind: 'enum';
|
|
356
|
+
readonly required: true;
|
|
357
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
358
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
359
|
+
readonly valueLabelIds: {
|
|
360
|
+
readonly normal: 'widgetSeverityNormal';
|
|
361
|
+
readonly warning: 'widgetSeverityWarning';
|
|
362
|
+
readonly minor: 'widgetSeverityMinor';
|
|
363
|
+
readonly major: 'widgetSeverityMajor';
|
|
364
|
+
readonly critical: 'widgetSeverityCritical';
|
|
365
|
+
};
|
|
366
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
367
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
368
|
+
};
|
|
369
|
+
readonly label: {
|
|
370
|
+
readonly kind: 'string';
|
|
371
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
372
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
373
|
+
};
|
|
374
|
+
};
|
|
375
|
+
};
|
|
376
|
+
readonly staleAfterSeconds: {
|
|
377
|
+
readonly kind: 'number';
|
|
378
|
+
readonly integer: true;
|
|
379
|
+
readonly min: 1;
|
|
380
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
381
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
382
|
+
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.';
|
|
383
|
+
};
|
|
384
|
+
readonly window: {
|
|
385
|
+
readonly kind: 'number';
|
|
386
|
+
readonly integer: true;
|
|
387
|
+
readonly min: 1;
|
|
388
|
+
readonly labelId: 'widgetLabelWindow';
|
|
389
|
+
readonly helpId: 'widgetHintWindow';
|
|
390
|
+
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.';
|
|
391
|
+
};
|
|
392
|
+
}>;
|
|
393
|
+
export declare const signalBarsWidget: import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
394
|
+
readonly title: {
|
|
395
|
+
readonly kind: 'string';
|
|
396
|
+
readonly labelId: 'widgetLabelTitle';
|
|
397
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
398
|
+
};
|
|
399
|
+
readonly measurement: {
|
|
400
|
+
readonly kind: 'string';
|
|
401
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
402
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
403
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
404
|
+
};
|
|
405
|
+
readonly unit: {
|
|
406
|
+
readonly kind: 'string';
|
|
407
|
+
readonly labelId: 'widgetLabelUnit';
|
|
408
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
409
|
+
};
|
|
410
|
+
readonly precision: {
|
|
411
|
+
readonly kind: 'number';
|
|
412
|
+
readonly integer: true;
|
|
413
|
+
readonly min: 0;
|
|
414
|
+
readonly max: 100;
|
|
415
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
416
|
+
readonly helpId: 'widgetHintPrecision';
|
|
417
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
418
|
+
};
|
|
419
|
+
readonly thresholds: {
|
|
420
|
+
readonly kind: 'list';
|
|
421
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
422
|
+
readonly item: {
|
|
423
|
+
readonly value: {
|
|
424
|
+
readonly kind: 'number';
|
|
425
|
+
readonly required: true;
|
|
426
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
427
|
+
readonly doc: 'The value at which this band starts.';
|
|
428
|
+
};
|
|
429
|
+
readonly level: {
|
|
430
|
+
readonly kind: 'enum';
|
|
431
|
+
readonly required: true;
|
|
432
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
433
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
434
|
+
readonly valueLabelIds: {
|
|
435
|
+
readonly normal: 'widgetSeverityNormal';
|
|
436
|
+
readonly warning: 'widgetSeverityWarning';
|
|
437
|
+
readonly minor: 'widgetSeverityMinor';
|
|
438
|
+
readonly major: 'widgetSeverityMajor';
|
|
439
|
+
readonly critical: 'widgetSeverityCritical';
|
|
440
|
+
};
|
|
441
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
442
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
443
|
+
};
|
|
444
|
+
readonly label: {
|
|
445
|
+
readonly kind: 'string';
|
|
446
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
447
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
448
|
+
};
|
|
449
|
+
};
|
|
450
|
+
readonly maxItems: 8;
|
|
451
|
+
readonly required: true;
|
|
452
|
+
readonly helpId: "widgetHintSignalThresholds";
|
|
453
|
+
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.";
|
|
454
|
+
};
|
|
455
|
+
readonly staleAfterSeconds: {
|
|
456
|
+
readonly kind: 'number';
|
|
457
|
+
readonly integer: true;
|
|
458
|
+
readonly min: 1;
|
|
459
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
460
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
461
|
+
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.';
|
|
462
|
+
};
|
|
463
|
+
readonly window: {
|
|
464
|
+
readonly kind: 'number';
|
|
465
|
+
readonly integer: true;
|
|
466
|
+
readonly min: 1;
|
|
467
|
+
readonly labelId: 'widgetLabelWindow';
|
|
468
|
+
readonly helpId: 'widgetHintWindow';
|
|
469
|
+
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.';
|
|
470
|
+
};
|
|
471
|
+
}>;
|
|
472
|
+
export declare const compassWidget: import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
473
|
+
readonly title: {
|
|
474
|
+
readonly kind: 'string';
|
|
475
|
+
readonly labelId: 'widgetLabelTitle';
|
|
476
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
477
|
+
};
|
|
478
|
+
readonly measurement: {
|
|
479
|
+
readonly kind: 'string';
|
|
480
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
481
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
482
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
483
|
+
};
|
|
484
|
+
readonly precision: {
|
|
485
|
+
readonly kind: 'number';
|
|
486
|
+
readonly integer: true;
|
|
487
|
+
readonly min: 0;
|
|
488
|
+
readonly max: 100;
|
|
489
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
490
|
+
readonly helpId: 'widgetHintPrecision';
|
|
491
|
+
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.";
|
|
492
|
+
};
|
|
493
|
+
readonly thresholds: {
|
|
494
|
+
readonly kind: 'list';
|
|
495
|
+
readonly maxItems: 12;
|
|
496
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
497
|
+
readonly helpId: 'widgetHintThresholds';
|
|
498
|
+
readonly item: {
|
|
499
|
+
readonly value: {
|
|
500
|
+
readonly kind: 'number';
|
|
501
|
+
readonly required: true;
|
|
502
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
503
|
+
readonly doc: 'The value at which this band starts.';
|
|
504
|
+
};
|
|
505
|
+
readonly level: {
|
|
506
|
+
readonly kind: 'enum';
|
|
507
|
+
readonly required: true;
|
|
508
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
509
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
510
|
+
readonly valueLabelIds: {
|
|
511
|
+
readonly normal: 'widgetSeverityNormal';
|
|
512
|
+
readonly warning: 'widgetSeverityWarning';
|
|
513
|
+
readonly minor: 'widgetSeverityMinor';
|
|
514
|
+
readonly major: 'widgetSeverityMajor';
|
|
515
|
+
readonly critical: 'widgetSeverityCritical';
|
|
516
|
+
};
|
|
517
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
518
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
519
|
+
};
|
|
520
|
+
readonly label: {
|
|
521
|
+
readonly kind: 'string';
|
|
522
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
523
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
524
|
+
};
|
|
525
|
+
};
|
|
526
|
+
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.";
|
|
527
|
+
};
|
|
528
|
+
readonly staleAfterSeconds: {
|
|
529
|
+
readonly kind: 'number';
|
|
530
|
+
readonly integer: true;
|
|
531
|
+
readonly min: 1;
|
|
532
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
533
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
534
|
+
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.';
|
|
535
|
+
};
|
|
536
|
+
readonly window: {
|
|
537
|
+
readonly kind: 'number';
|
|
538
|
+
readonly integer: true;
|
|
539
|
+
readonly min: 1;
|
|
540
|
+
readonly labelId: 'widgetLabelWindow';
|
|
541
|
+
readonly helpId: 'widgetHintWindow';
|
|
542
|
+
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.';
|
|
543
|
+
};
|
|
544
|
+
}>;
|
|
545
|
+
export declare const progressRingWidget: import("@devicechain/widget-sdk").WidgetDefinition<"measurement", {
|
|
546
|
+
readonly title: {
|
|
547
|
+
readonly kind: 'string';
|
|
548
|
+
readonly labelId: 'widgetLabelTitle';
|
|
549
|
+
readonly doc: 'Heading shown in the widget frame. Defaults to the displayed measurement name.';
|
|
550
|
+
};
|
|
551
|
+
readonly measurement: {
|
|
552
|
+
readonly kind: 'string';
|
|
553
|
+
readonly labelId: 'widgetLabelMeasurement';
|
|
554
|
+
readonly helpId: 'widgetHintMeasurement';
|
|
555
|
+
readonly doc: 'Which measurement to display. Defaults to the first the datasource selects.';
|
|
556
|
+
};
|
|
557
|
+
readonly min: {
|
|
558
|
+
readonly kind: 'number';
|
|
559
|
+
readonly required: true;
|
|
560
|
+
readonly labelId: 'widgetLabelMin';
|
|
561
|
+
readonly helpId: 'widgetHintScaleMin';
|
|
562
|
+
readonly doc: 'Value at the empty end of the scale. Required: the widget does not guess a range.';
|
|
563
|
+
};
|
|
564
|
+
readonly max: {
|
|
565
|
+
readonly kind: 'number';
|
|
566
|
+
readonly required: true;
|
|
567
|
+
readonly labelId: 'widgetLabelMax';
|
|
568
|
+
readonly helpId: 'widgetHintScaleMax';
|
|
569
|
+
readonly doc: 'Value at the full end of the scale. Required, and above min.';
|
|
570
|
+
};
|
|
571
|
+
readonly readout: {
|
|
572
|
+
readonly kind: "enum";
|
|
573
|
+
readonly values: readonly ["percent", "value"];
|
|
574
|
+
readonly labelId: "widgetLabelReadout";
|
|
575
|
+
readonly valueLabelIds: {
|
|
576
|
+
readonly percent: "widgetReadoutPercent";
|
|
577
|
+
readonly value: "widgetReadoutValue";
|
|
578
|
+
};
|
|
579
|
+
readonly placeholderId: "widgetPlaceholderDefault";
|
|
580
|
+
readonly doc: "What the middle of the ring shows: the percent of the scale (default) or the value with its unit.";
|
|
581
|
+
};
|
|
582
|
+
readonly unit: {
|
|
583
|
+
readonly kind: 'string';
|
|
584
|
+
readonly labelId: 'widgetLabelUnit';
|
|
585
|
+
readonly doc: 'Unit suffix shown beside the value.';
|
|
586
|
+
};
|
|
587
|
+
readonly precision: {
|
|
588
|
+
readonly kind: 'number';
|
|
589
|
+
readonly integer: true;
|
|
590
|
+
readonly min: 0;
|
|
591
|
+
readonly max: 100;
|
|
592
|
+
readonly labelId: 'widgetLabelPrecision';
|
|
593
|
+
readonly helpId: 'widgetHintPrecision';
|
|
594
|
+
readonly doc: 'Decimal places to round displayed values to. Unset rounds to at most 3 decimals (4 significant digits under 1).';
|
|
595
|
+
};
|
|
596
|
+
readonly thresholds: {
|
|
597
|
+
readonly kind: 'list';
|
|
598
|
+
readonly maxItems: 12;
|
|
599
|
+
readonly labelId: 'widgetLabelThresholds';
|
|
600
|
+
readonly helpId: 'widgetHintThresholds';
|
|
601
|
+
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.';
|
|
602
|
+
readonly item: {
|
|
603
|
+
readonly value: {
|
|
604
|
+
readonly kind: 'number';
|
|
605
|
+
readonly required: true;
|
|
606
|
+
readonly labelId: 'widgetLabelThresholdValue';
|
|
607
|
+
readonly doc: 'The value at which this band starts.';
|
|
608
|
+
};
|
|
609
|
+
readonly level: {
|
|
610
|
+
readonly kind: 'enum';
|
|
611
|
+
readonly required: true;
|
|
612
|
+
readonly values: readonly ["normal", "warning", "minor", "major", "critical"];
|
|
613
|
+
readonly labelId: 'widgetLabelThresholdLevel';
|
|
614
|
+
readonly valueLabelIds: {
|
|
615
|
+
readonly normal: 'widgetSeverityNormal';
|
|
616
|
+
readonly warning: 'widgetSeverityWarning';
|
|
617
|
+
readonly minor: 'widgetSeverityMinor';
|
|
618
|
+
readonly major: 'widgetSeverityMajor';
|
|
619
|
+
readonly critical: 'widgetSeverityCritical';
|
|
620
|
+
};
|
|
621
|
+
readonly placeholderId: 'widgetPlaceholderThresholdLevel';
|
|
622
|
+
readonly doc: 'The severity of this band. The theme decides the colour; normal has none.';
|
|
623
|
+
};
|
|
624
|
+
readonly label: {
|
|
625
|
+
readonly kind: 'string';
|
|
626
|
+
readonly labelId: 'widgetLabelThresholdLabel';
|
|
627
|
+
readonly doc: 'Text shown on the chart line for this threshold. Defaults to its value.';
|
|
628
|
+
};
|
|
629
|
+
};
|
|
630
|
+
};
|
|
631
|
+
readonly staleAfterSeconds: {
|
|
632
|
+
readonly kind: 'number';
|
|
633
|
+
readonly integer: true;
|
|
634
|
+
readonly min: 1;
|
|
635
|
+
readonly labelId: 'widgetLabelStaleAfter';
|
|
636
|
+
readonly helpId: 'widgetHintStaleAfter';
|
|
637
|
+
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.';
|
|
638
|
+
};
|
|
639
|
+
readonly window: {
|
|
640
|
+
readonly kind: 'number';
|
|
641
|
+
readonly integer: true;
|
|
642
|
+
readonly min: 1;
|
|
643
|
+
readonly labelId: 'widgetLabelWindow';
|
|
644
|
+
readonly helpId: 'widgetHintWindow';
|
|
645
|
+
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.';
|
|
646
|
+
};
|
|
647
|
+
}>;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export { Battery } from './battery';
|
|
2
|
+
export { Compass } from './compass';
|
|
3
|
+
export { LevelGauge } from './level-gauge';
|
|
4
|
+
export { LinearGauge } from './linear-gauge';
|
|
5
|
+
export { ProgressRing } from './progress-ring';
|
|
6
|
+
export { SignalBars } from './signal-bars';
|
|
7
|
+
export { StatusLight } from './status-light';
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
|
|
1
|
+
import { type AlarmLevel } from '@devicechain/widget-sdk';
|
|
2
|
+
export declare function severityColor(colors: Readonly<Record<AlarmLevel, string>>, severity: string): string;
|
|
2
3
|
export declare function severityRank(severity: string): number;
|
|
3
4
|
export declare function severityLabel(severity: string): string;
|
|
4
5
|
export declare function highestSeverity(severities: string[]): string | undefined;
|