@openremote/or-attribute-barchart 1.11.0-snapshot.20251031091914 → 1.11.0-snapshot.20251031164933
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.
|
@@ -0,0 +1,913 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": "1.0.0",
|
|
3
|
+
"readme": "",
|
|
4
|
+
"modules": [
|
|
5
|
+
{
|
|
6
|
+
"kind": "javascript-module",
|
|
7
|
+
"path": "src/index.ts",
|
|
8
|
+
"declarations": [
|
|
9
|
+
{
|
|
10
|
+
"kind": "class",
|
|
11
|
+
"description": "",
|
|
12
|
+
"name": "OrAttributeBarChart",
|
|
13
|
+
"members": [
|
|
14
|
+
{
|
|
15
|
+
"kind": "field",
|
|
16
|
+
"name": "DEFAULT_COLORS",
|
|
17
|
+
"type": {
|
|
18
|
+
"text": "array"
|
|
19
|
+
},
|
|
20
|
+
"privacy": "public",
|
|
21
|
+
"static": true,
|
|
22
|
+
"readonly": true,
|
|
23
|
+
"default": "[\"#3869B1\", \"#DA7E30\", \"#3F9852\", \"#CC2428\", \"#6B4C9A\", \"#922427\", \"#958C3D\", \"#535055\"]"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"kind": "field",
|
|
27
|
+
"name": "assets",
|
|
28
|
+
"type": {
|
|
29
|
+
"text": "Asset[]"
|
|
30
|
+
},
|
|
31
|
+
"privacy": "public",
|
|
32
|
+
"default": "[]",
|
|
33
|
+
"description": "Asset data to display in the bar chart. This array needs to be populated.\nUsed for the chart legend, information about units, and retrieval of data points.",
|
|
34
|
+
"attribute": "assets"
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"kind": "field",
|
|
38
|
+
"name": "assetAttributes",
|
|
39
|
+
"type": {
|
|
40
|
+
"text": "[number, Attribute<any>][]"
|
|
41
|
+
},
|
|
42
|
+
"privacy": "public",
|
|
43
|
+
"default": "[]",
|
|
44
|
+
"description": "List of attributes to display in the bar chart. This array needs to be populated.\nUsed for the chart legend, and the retrieval of data points.\nFormatted as a JSON array of;\n\n```[<index of assets>, Attribute]```",
|
|
45
|
+
"attribute": "assetAttributes"
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"kind": "field",
|
|
49
|
+
"name": "realm",
|
|
50
|
+
"type": {
|
|
51
|
+
"text": "string | undefined"
|
|
52
|
+
},
|
|
53
|
+
"privacy": "public",
|
|
54
|
+
"description": "Realm name to associate all the chart data with.",
|
|
55
|
+
"attribute": "realm"
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"kind": "field",
|
|
59
|
+
"name": "attributeColors",
|
|
60
|
+
"type": {
|
|
61
|
+
"text": "[AttributeRef, string][]"
|
|
62
|
+
},
|
|
63
|
+
"privacy": "public",
|
|
64
|
+
"readonly": true,
|
|
65
|
+
"default": "[]",
|
|
66
|
+
"description": "The list of HEX colors representing the line color for each AttributeRef.\nActs as an override, and will fall back to the colors attribute if not specified.\nThe AttributeRef object with Asset ID and Attribute name need to be present in the Chart to work.\nThe HEX color should be put in without '#' prefix. For example, you'd use '4d9d2a' instead of '#4d9d2a'.",
|
|
67
|
+
"attribute": "attributeColors"
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"kind": "field",
|
|
71
|
+
"name": "attributeConfig",
|
|
72
|
+
"type": {
|
|
73
|
+
"text": "BarChartAttributeConfig | undefined"
|
|
74
|
+
},
|
|
75
|
+
"privacy": "public",
|
|
76
|
+
"readonly": true,
|
|
77
|
+
"description": "The attribute configuration object with, for example, a list of right-axis attributes.\nSee BarChartAttributeConfig for full documentation on the options.",
|
|
78
|
+
"attribute": "attributeConfig"
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"kind": "field",
|
|
82
|
+
"name": "colors",
|
|
83
|
+
"type": {
|
|
84
|
+
"text": "string[]"
|
|
85
|
+
},
|
|
86
|
+
"privacy": "public",
|
|
87
|
+
"readonly": true,
|
|
88
|
+
"description": "List of colors to display attributes values with inside the bar chart.\nThe array corresponds with assetAttributes, so the 1st color will be used for the 1st attribute.",
|
|
89
|
+
"attribute": "colors"
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"kind": "field",
|
|
93
|
+
"name": "datapointQuery",
|
|
94
|
+
"type": {
|
|
95
|
+
"text": "AssetDatapointQueryUnion"
|
|
96
|
+
},
|
|
97
|
+
"privacy": "public",
|
|
98
|
+
"readonly": true,
|
|
99
|
+
"description": "The query object to request attribute data / data points with.\nNormally, it's of type AssetDatapointIntervalQuery, including a start- and end time.",
|
|
100
|
+
"attribute": "datapointQuery"
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
"kind": "field",
|
|
104
|
+
"name": "timeframe",
|
|
105
|
+
"type": {
|
|
106
|
+
"text": "[Date, Date] | undefined"
|
|
107
|
+
},
|
|
108
|
+
"privacy": "public",
|
|
109
|
+
"description": "Selected timeframe using a [start date, end date] array format.",
|
|
110
|
+
"attribute": "timeframe"
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
"kind": "field",
|
|
114
|
+
"name": "chartOptions",
|
|
115
|
+
"type": {
|
|
116
|
+
"text": "ECChartOption | undefined"
|
|
117
|
+
},
|
|
118
|
+
"privacy": "public",
|
|
119
|
+
"description": "Custom ECharts options object to configure the chart appearance.\nSee their documentation for more info: https://echarts.apache.org/en/option.html",
|
|
120
|
+
"attribute": "chartOptions"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"kind": "field",
|
|
124
|
+
"name": "showLegend",
|
|
125
|
+
"type": {
|
|
126
|
+
"text": "boolean"
|
|
127
|
+
},
|
|
128
|
+
"privacy": "public",
|
|
129
|
+
"default": "false",
|
|
130
|
+
"description": "Shows a right-side legend with the list of visible attributes.",
|
|
131
|
+
"attribute": "showLegend"
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"kind": "field",
|
|
135
|
+
"name": "denseLegend",
|
|
136
|
+
"type": {
|
|
137
|
+
"text": "boolean"
|
|
138
|
+
},
|
|
139
|
+
"privacy": "public",
|
|
140
|
+
"default": "false",
|
|
141
|
+
"description": "Shows the right-side legend (toggled with showLegend) in a compact / dense format.",
|
|
142
|
+
"attribute": "denseLegend"
|
|
143
|
+
},
|
|
144
|
+
{
|
|
145
|
+
"kind": "field",
|
|
146
|
+
"name": "stacked",
|
|
147
|
+
"type": {
|
|
148
|
+
"text": "boolean"
|
|
149
|
+
},
|
|
150
|
+
"privacy": "public",
|
|
151
|
+
"default": "false",
|
|
152
|
+
"description": "Displays the bar chart in a vertically \"stacked\" configuration.\nIt will display a cumulative effect of all data series on top of each other.",
|
|
153
|
+
"attribute": "stacked"
|
|
154
|
+
},
|
|
155
|
+
{
|
|
156
|
+
"kind": "field",
|
|
157
|
+
"name": "timestampControls",
|
|
158
|
+
"type": {
|
|
159
|
+
"text": "boolean"
|
|
160
|
+
},
|
|
161
|
+
"privacy": "public",
|
|
162
|
+
"default": "true",
|
|
163
|
+
"description": "Enables time control for the user, allowing them to customize the timeframe shown.\nLeaving this disabled/unset will show them in a \"read-only\" state.",
|
|
164
|
+
"attribute": "timestampControls"
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
"kind": "field",
|
|
168
|
+
"name": "decimals",
|
|
169
|
+
"type": {
|
|
170
|
+
"text": "number"
|
|
171
|
+
},
|
|
172
|
+
"privacy": "public",
|
|
173
|
+
"default": "2",
|
|
174
|
+
"description": "Number of decimals to display for attributes.",
|
|
175
|
+
"attribute": "decimals"
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
"kind": "field",
|
|
179
|
+
"name": "timePrefixOptions",
|
|
180
|
+
"type": {
|
|
181
|
+
"text": "string[]"
|
|
182
|
+
},
|
|
183
|
+
"privacy": "public",
|
|
184
|
+
"description": "A JSON array list of strings that represent the prefix options in the UI, such as \"current\" or \"last\".\nIn combination with timeWindowOptions, it provides a timeframe like \"current 1 hour\" to display data of.",
|
|
185
|
+
"attribute": "timePrefixOptions"
|
|
186
|
+
},
|
|
187
|
+
{
|
|
188
|
+
"kind": "field",
|
|
189
|
+
"name": "timePrefixKey",
|
|
190
|
+
"type": {
|
|
191
|
+
"text": "string | undefined"
|
|
192
|
+
},
|
|
193
|
+
"privacy": "public",
|
|
194
|
+
"description": "The selected option from timePrefixOptions, such as \"current\" or \"last\".\nIn combination with timeWindowOptions, it provides a timeframe like \"current 1 hour\" to display data of.",
|
|
195
|
+
"attribute": "timePrefixKey"
|
|
196
|
+
},
|
|
197
|
+
{
|
|
198
|
+
"kind": "field",
|
|
199
|
+
"name": "timeWindowOptions",
|
|
200
|
+
"type": {
|
|
201
|
+
"text": "Map<string, [moment.unitOfTime.DurationConstructor, number]>"
|
|
202
|
+
},
|
|
203
|
+
"privacy": "public",
|
|
204
|
+
"description": "A JSON object containing a list of time window options, like \"1 day\", \"6 hours\" or \"52 weeks\".\nIn combination with timePrefixOptions, it provides a timeframe like \"last 6 hours\" to display data of.\nThe input should contain a JavaScript Map, containing the following:\n- A string with a unique key like \"6hours\",\n- A combination of any moment.unitOfTime.DurationConstructor and number, like [\"hours\", 6]\n\nExample input: `{\"6hours\": [\"hours\", 6], \"4weeks\": [\"weeks\", 4]}`",
|
|
205
|
+
"attribute": "timeWindowOptions"
|
|
206
|
+
},
|
|
207
|
+
{
|
|
208
|
+
"kind": "field",
|
|
209
|
+
"name": "timeWindowKey",
|
|
210
|
+
"type": {
|
|
211
|
+
"text": "string | undefined"
|
|
212
|
+
},
|
|
213
|
+
"privacy": "public",
|
|
214
|
+
"description": "The key value of the selected option from timeWindowOptions, such as \"1day\", \"6hours\" or \"52weeks\".\nIn combination with timePrefixOptions, it provides a timeframe like \"last 6 hours\" to display data of.",
|
|
215
|
+
"attribute": "timeWindowKey"
|
|
216
|
+
},
|
|
217
|
+
{
|
|
218
|
+
"kind": "field",
|
|
219
|
+
"name": "intervalOptions",
|
|
220
|
+
"type": {
|
|
221
|
+
"text": "Map<BarChartInterval, IntervalConfig>"
|
|
222
|
+
},
|
|
223
|
+
"privacy": "public",
|
|
224
|
+
"description": "A JSON object containing a list of interval options, like \"30minutes\", \"hour\" or \"day\".\nIt determines the interval to display data in sections. For example, split the data every 5 minutes of the past hour.\nIn combination with the active formula in datapointQuery, such as AVG and MIN/MAX, it will show a '5 minute' average of the past hour.\nThe input should contain a JavaScript Map, containing the following:\n- A BarChartInterval string with a unique key like \"hour\" or \"day\",\n- A IntervalConfig object with details on the interval, such as the display name and the unit of time.\n\nExample input:\n```\n{\"30minutes\": {\n displayName: \"30Minutes\", // translated automatically\n steps: 30,\n orFormat: \"minute\",\n momentFormat: \"minutes\", // using moment.js format\n millis: 1800000\n}}\n```",
|
|
225
|
+
"attribute": "intervalOptions"
|
|
226
|
+
},
|
|
227
|
+
{
|
|
228
|
+
"kind": "field",
|
|
229
|
+
"name": "interval",
|
|
230
|
+
"type": {
|
|
231
|
+
"text": "BarChartInterval | undefined"
|
|
232
|
+
},
|
|
233
|
+
"privacy": "public",
|
|
234
|
+
"description": "The key value of the selected option from intervalOptions, such as \"30minute\", \"hour\" or \"week\".\nIn combination with the active formula in datapointQuery, such as AVG and MIN/MAX, it will show a '5 minute' average of the past hour.",
|
|
235
|
+
"attribute": "interval"
|
|
236
|
+
},
|
|
237
|
+
{
|
|
238
|
+
"kind": "field",
|
|
239
|
+
"name": "_isCustomWindow",
|
|
240
|
+
"type": {
|
|
241
|
+
"text": "boolean"
|
|
242
|
+
},
|
|
243
|
+
"privacy": "protected",
|
|
244
|
+
"default": "false",
|
|
245
|
+
"description": "Whether a custom timeframe has been configured by the user or not.\nIf it's a default value provided by us, it will be `false`.\nIf a user customized the timeframe, it will be `true`."
|
|
246
|
+
},
|
|
247
|
+
{
|
|
248
|
+
"kind": "field",
|
|
249
|
+
"name": "_loading",
|
|
250
|
+
"type": {
|
|
251
|
+
"text": "boolean"
|
|
252
|
+
},
|
|
253
|
+
"privacy": "protected",
|
|
254
|
+
"default": "false",
|
|
255
|
+
"description": "Loading state when fetching data from a remote source.\nShow a \"loading indicator\" in the UI when set to `true`."
|
|
256
|
+
},
|
|
257
|
+
{
|
|
258
|
+
"kind": "field",
|
|
259
|
+
"name": "_data",
|
|
260
|
+
"type": {
|
|
261
|
+
"text": "BarChartData[] | undefined"
|
|
262
|
+
},
|
|
263
|
+
"privacy": "protected",
|
|
264
|
+
"description": "Cached array of BarChartData objects to display in the chart.\nIt contains custom data, but data from the ECharts library as well (see BarSeriesOption for details)"
|
|
265
|
+
},
|
|
266
|
+
{
|
|
267
|
+
"kind": "field",
|
|
268
|
+
"name": "_chartElem",
|
|
269
|
+
"type": {
|
|
270
|
+
"text": "HTMLDivElement"
|
|
271
|
+
},
|
|
272
|
+
"privacy": "protected"
|
|
273
|
+
},
|
|
274
|
+
{
|
|
275
|
+
"kind": "field",
|
|
276
|
+
"name": "_chart",
|
|
277
|
+
"type": {
|
|
278
|
+
"text": "echarts.ECharts | undefined"
|
|
279
|
+
},
|
|
280
|
+
"privacy": "protected"
|
|
281
|
+
},
|
|
282
|
+
{
|
|
283
|
+
"kind": "field",
|
|
284
|
+
"name": "_style",
|
|
285
|
+
"type": {
|
|
286
|
+
"text": "CSSStyleDeclaration"
|
|
287
|
+
},
|
|
288
|
+
"privacy": "protected"
|
|
289
|
+
},
|
|
290
|
+
{
|
|
291
|
+
"kind": "field",
|
|
292
|
+
"name": "_startOfPeriod",
|
|
293
|
+
"type": {
|
|
294
|
+
"text": "number | undefined"
|
|
295
|
+
},
|
|
296
|
+
"privacy": "protected"
|
|
297
|
+
},
|
|
298
|
+
{
|
|
299
|
+
"kind": "field",
|
|
300
|
+
"name": "_endOfPeriod",
|
|
301
|
+
"type": {
|
|
302
|
+
"text": "number | undefined"
|
|
303
|
+
},
|
|
304
|
+
"privacy": "protected"
|
|
305
|
+
},
|
|
306
|
+
{
|
|
307
|
+
"kind": "field",
|
|
308
|
+
"name": "_latestError",
|
|
309
|
+
"type": {
|
|
310
|
+
"text": "string | undefined"
|
|
311
|
+
},
|
|
312
|
+
"privacy": "protected"
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
"kind": "field",
|
|
316
|
+
"name": "_dataAbortController",
|
|
317
|
+
"type": {
|
|
318
|
+
"text": "AbortController | undefined"
|
|
319
|
+
},
|
|
320
|
+
"privacy": "protected"
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
"kind": "field",
|
|
324
|
+
"name": "_containerResizeObserver",
|
|
325
|
+
"type": {
|
|
326
|
+
"text": "ResizeObserver | undefined"
|
|
327
|
+
},
|
|
328
|
+
"privacy": "protected"
|
|
329
|
+
},
|
|
330
|
+
{
|
|
331
|
+
"kind": "field",
|
|
332
|
+
"name": "_intervalConfig",
|
|
333
|
+
"type": {
|
|
334
|
+
"text": "IntervalConfig | undefined"
|
|
335
|
+
},
|
|
336
|
+
"privacy": "protected"
|
|
337
|
+
},
|
|
338
|
+
{
|
|
339
|
+
"kind": "method",
|
|
340
|
+
"name": "_getTimeControlsTemplate",
|
|
341
|
+
"privacy": "protected",
|
|
342
|
+
"return": {
|
|
343
|
+
"type": {
|
|
344
|
+
"text": "TemplateResult"
|
|
345
|
+
}
|
|
346
|
+
},
|
|
347
|
+
"parameters": [
|
|
348
|
+
{
|
|
349
|
+
"name": "disabled",
|
|
350
|
+
"default": "true"
|
|
351
|
+
}
|
|
352
|
+
]
|
|
353
|
+
},
|
|
354
|
+
{
|
|
355
|
+
"kind": "method",
|
|
356
|
+
"name": "_getTimeframeStatusTemplate",
|
|
357
|
+
"privacy": "protected",
|
|
358
|
+
"return": {
|
|
359
|
+
"type": {
|
|
360
|
+
"text": "TemplateResult"
|
|
361
|
+
}
|
|
362
|
+
},
|
|
363
|
+
"parameters": [
|
|
364
|
+
{
|
|
365
|
+
"name": "timeframe",
|
|
366
|
+
"default": "this.timeframe"
|
|
367
|
+
}
|
|
368
|
+
]
|
|
369
|
+
},
|
|
370
|
+
{
|
|
371
|
+
"kind": "method",
|
|
372
|
+
"name": "_getLegendTemplate",
|
|
373
|
+
"privacy": "protected",
|
|
374
|
+
"return": {
|
|
375
|
+
"type": {
|
|
376
|
+
"text": "TemplateResult"
|
|
377
|
+
}
|
|
378
|
+
}
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"kind": "method",
|
|
382
|
+
"name": "_openTimeDialog",
|
|
383
|
+
"privacy": "protected",
|
|
384
|
+
"parameters": [
|
|
385
|
+
{
|
|
386
|
+
"name": "startTimestamp",
|
|
387
|
+
"optional": true,
|
|
388
|
+
"type": {
|
|
389
|
+
"text": "number"
|
|
390
|
+
}
|
|
391
|
+
},
|
|
392
|
+
{
|
|
393
|
+
"name": "endTimestamp",
|
|
394
|
+
"optional": true,
|
|
395
|
+
"type": {
|
|
396
|
+
"text": "number"
|
|
397
|
+
}
|
|
398
|
+
}
|
|
399
|
+
]
|
|
400
|
+
},
|
|
401
|
+
{
|
|
402
|
+
"kind": "method",
|
|
403
|
+
"name": "_removeDatasetHighlights",
|
|
404
|
+
"privacy": "protected",
|
|
405
|
+
"parameters": [
|
|
406
|
+
{
|
|
407
|
+
"name": "chart",
|
|
408
|
+
"default": "this._chart"
|
|
409
|
+
}
|
|
410
|
+
],
|
|
411
|
+
"description": "Removes all active Chart bars color highlights, by reducing/increasing opacity."
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
"kind": "method",
|
|
415
|
+
"name": "_addDatasetHighlight",
|
|
416
|
+
"privacy": "protected",
|
|
417
|
+
"parameters": [
|
|
418
|
+
{
|
|
419
|
+
"name": "attrRef",
|
|
420
|
+
"type": {
|
|
421
|
+
"text": "AttributeRef"
|
|
422
|
+
},
|
|
423
|
+
"description": "Asset ID and attribute name to be highlighted"
|
|
424
|
+
},
|
|
425
|
+
{
|
|
426
|
+
"name": "chart",
|
|
427
|
+
"default": "this._chart",
|
|
428
|
+
"description": "ECharts instance to add the highlight to."
|
|
429
|
+
}
|
|
430
|
+
],
|
|
431
|
+
"description": "Adds a Chart bar color highlight, by reducing/increasing opacity.\nSo the given bar (represented by assetId and attrName will be emphasized, while others are less visible."
|
|
432
|
+
},
|
|
433
|
+
{
|
|
434
|
+
"kind": "method",
|
|
435
|
+
"name": "_applyChartResponsiveness",
|
|
436
|
+
"privacy": "protected",
|
|
437
|
+
"return": {
|
|
438
|
+
"type": {
|
|
439
|
+
"text": "void"
|
|
440
|
+
}
|
|
441
|
+
}
|
|
442
|
+
},
|
|
443
|
+
{
|
|
444
|
+
"kind": "method",
|
|
445
|
+
"name": "_cleanup",
|
|
446
|
+
"privacy": "protected"
|
|
447
|
+
},
|
|
448
|
+
{
|
|
449
|
+
"kind": "method",
|
|
450
|
+
"name": "_getTimeSelectionDates",
|
|
451
|
+
"privacy": "protected",
|
|
452
|
+
"return": {
|
|
453
|
+
"type": {
|
|
454
|
+
"text": "[Date, Date]"
|
|
455
|
+
}
|
|
456
|
+
},
|
|
457
|
+
"parameters": [
|
|
458
|
+
{
|
|
459
|
+
"name": "timePrefixSelected",
|
|
460
|
+
"type": {
|
|
461
|
+
"text": "string"
|
|
462
|
+
}
|
|
463
|
+
},
|
|
464
|
+
{
|
|
465
|
+
"name": "timeWindowSelected",
|
|
466
|
+
"type": {
|
|
467
|
+
"text": "string"
|
|
468
|
+
}
|
|
469
|
+
}
|
|
470
|
+
]
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
"kind": "method",
|
|
474
|
+
"name": "_shiftTimeframe",
|
|
475
|
+
"privacy": "protected",
|
|
476
|
+
"parameters": [
|
|
477
|
+
{
|
|
478
|
+
"name": "currentStart",
|
|
479
|
+
"type": {
|
|
480
|
+
"text": "Date"
|
|
481
|
+
}
|
|
482
|
+
},
|
|
483
|
+
{
|
|
484
|
+
"name": "currentEnd",
|
|
485
|
+
"type": {
|
|
486
|
+
"text": "Date"
|
|
487
|
+
}
|
|
488
|
+
},
|
|
489
|
+
{
|
|
490
|
+
"name": "timeWindowSelected",
|
|
491
|
+
"type": {
|
|
492
|
+
"text": "string"
|
|
493
|
+
}
|
|
494
|
+
},
|
|
495
|
+
{
|
|
496
|
+
"name": "direction",
|
|
497
|
+
"type": {
|
|
498
|
+
"text": "string"
|
|
499
|
+
}
|
|
500
|
+
}
|
|
501
|
+
]
|
|
502
|
+
},
|
|
503
|
+
{
|
|
504
|
+
"kind": "method",
|
|
505
|
+
"name": "_getInterval",
|
|
506
|
+
"privacy": "protected",
|
|
507
|
+
"return": {
|
|
508
|
+
"type": {
|
|
509
|
+
"text": "IntervalConfig"
|
|
510
|
+
}
|
|
511
|
+
},
|
|
512
|
+
"parameters": [
|
|
513
|
+
{
|
|
514
|
+
"name": "start",
|
|
515
|
+
"type": {
|
|
516
|
+
"text": "number"
|
|
517
|
+
}
|
|
518
|
+
},
|
|
519
|
+
{
|
|
520
|
+
"name": "end",
|
|
521
|
+
"type": {
|
|
522
|
+
"text": "number"
|
|
523
|
+
}
|
|
524
|
+
},
|
|
525
|
+
{
|
|
526
|
+
"name": "selectedInterval",
|
|
527
|
+
"type": {
|
|
528
|
+
"text": "BarChartInterval"
|
|
529
|
+
}
|
|
530
|
+
},
|
|
531
|
+
{
|
|
532
|
+
"name": "exact",
|
|
533
|
+
"default": "false"
|
|
534
|
+
}
|
|
535
|
+
]
|
|
536
|
+
},
|
|
537
|
+
{
|
|
538
|
+
"kind": "method",
|
|
539
|
+
"name": "_loadData",
|
|
540
|
+
"privacy": "protected"
|
|
541
|
+
},
|
|
542
|
+
{
|
|
543
|
+
"kind": "method",
|
|
544
|
+
"name": "_loadAttributeData",
|
|
545
|
+
"privacy": "protected",
|
|
546
|
+
"return": {
|
|
547
|
+
"type": {
|
|
548
|
+
"text": "Promise<BarChartData>"
|
|
549
|
+
}
|
|
550
|
+
},
|
|
551
|
+
"parameters": [
|
|
552
|
+
{
|
|
553
|
+
"name": "asset",
|
|
554
|
+
"type": {
|
|
555
|
+
"text": "Asset"
|
|
556
|
+
}
|
|
557
|
+
},
|
|
558
|
+
{
|
|
559
|
+
"name": "attribute",
|
|
560
|
+
"type": {
|
|
561
|
+
"text": "Attribute<any>"
|
|
562
|
+
}
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
"name": "color",
|
|
566
|
+
"type": {
|
|
567
|
+
"text": "string"
|
|
568
|
+
}
|
|
569
|
+
},
|
|
570
|
+
{
|
|
571
|
+
"name": "from",
|
|
572
|
+
"type": {
|
|
573
|
+
"text": "number"
|
|
574
|
+
}
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
"name": "to",
|
|
578
|
+
"type": {
|
|
579
|
+
"text": "number"
|
|
580
|
+
}
|
|
581
|
+
},
|
|
582
|
+
{
|
|
583
|
+
"name": "formula",
|
|
584
|
+
"type": {
|
|
585
|
+
"text": "AssetDatapointIntervalQueryFormula"
|
|
586
|
+
}
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
"name": "faint",
|
|
590
|
+
"default": "false"
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
"name": "label",
|
|
594
|
+
"optional": true,
|
|
595
|
+
"type": {
|
|
596
|
+
"text": "string"
|
|
597
|
+
}
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
"name": "options",
|
|
601
|
+
"optional": true,
|
|
602
|
+
"type": {
|
|
603
|
+
"text": "any"
|
|
604
|
+
}
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
"name": "_unit",
|
|
608
|
+
"optional": true,
|
|
609
|
+
"type": {
|
|
610
|
+
"text": "any"
|
|
611
|
+
}
|
|
612
|
+
}
|
|
613
|
+
]
|
|
614
|
+
},
|
|
615
|
+
{
|
|
616
|
+
"kind": "method",
|
|
617
|
+
"name": "_updateChartData",
|
|
618
|
+
"privacy": "protected"
|
|
619
|
+
},
|
|
620
|
+
{
|
|
621
|
+
"kind": "method",
|
|
622
|
+
"name": "_toggleChartEventListeners",
|
|
623
|
+
"privacy": "protected",
|
|
624
|
+
"parameters": [
|
|
625
|
+
{
|
|
626
|
+
"name": "connect",
|
|
627
|
+
"type": {
|
|
628
|
+
"text": "boolean"
|
|
629
|
+
}
|
|
630
|
+
}
|
|
631
|
+
]
|
|
632
|
+
},
|
|
633
|
+
{
|
|
634
|
+
"kind": "method",
|
|
635
|
+
"name": "_getDefaultChartOptions",
|
|
636
|
+
"privacy": "protected",
|
|
637
|
+
"return": {
|
|
638
|
+
"type": {
|
|
639
|
+
"text": "ECChartOption"
|
|
640
|
+
}
|
|
641
|
+
}
|
|
642
|
+
},
|
|
643
|
+
{
|
|
644
|
+
"kind": "method",
|
|
645
|
+
"name": "_getDefaultDatasetOptions",
|
|
646
|
+
"privacy": "protected",
|
|
647
|
+
"return": {
|
|
648
|
+
"type": {
|
|
649
|
+
"text": "BarChartData"
|
|
650
|
+
}
|
|
651
|
+
},
|
|
652
|
+
"parameters": [
|
|
653
|
+
{
|
|
654
|
+
"name": "name",
|
|
655
|
+
"type": {
|
|
656
|
+
"text": "string"
|
|
657
|
+
}
|
|
658
|
+
},
|
|
659
|
+
{
|
|
660
|
+
"name": "formula",
|
|
661
|
+
"type": {
|
|
662
|
+
"text": "string"
|
|
663
|
+
}
|
|
664
|
+
},
|
|
665
|
+
{
|
|
666
|
+
"name": "color",
|
|
667
|
+
"type": {
|
|
668
|
+
"text": "string"
|
|
669
|
+
}
|
|
670
|
+
},
|
|
671
|
+
{
|
|
672
|
+
"name": "faint",
|
|
673
|
+
"default": "false"
|
|
674
|
+
}
|
|
675
|
+
]
|
|
676
|
+
},
|
|
677
|
+
{
|
|
678
|
+
"kind": "method",
|
|
679
|
+
"name": "getDefaultTimePrefixOptions",
|
|
680
|
+
"privacy": "public",
|
|
681
|
+
"static": true,
|
|
682
|
+
"return": {
|
|
683
|
+
"type": {
|
|
684
|
+
"text": "string[]"
|
|
685
|
+
}
|
|
686
|
+
}
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
"kind": "method",
|
|
690
|
+
"name": "getDefaultTimeWindowOptions",
|
|
691
|
+
"privacy": "public",
|
|
692
|
+
"static": true,
|
|
693
|
+
"return": {
|
|
694
|
+
"type": {
|
|
695
|
+
"text": "Map<string, [moment.unitOfTime.DurationConstructor, number]>"
|
|
696
|
+
}
|
|
697
|
+
}
|
|
698
|
+
},
|
|
699
|
+
{
|
|
700
|
+
"kind": "method",
|
|
701
|
+
"name": "getDefaultIntervalOptions",
|
|
702
|
+
"privacy": "public",
|
|
703
|
+
"static": true,
|
|
704
|
+
"return": {
|
|
705
|
+
"type": {
|
|
706
|
+
"text": "Map<BarChartInterval, IntervalConfig>"
|
|
707
|
+
}
|
|
708
|
+
}
|
|
709
|
+
}
|
|
710
|
+
],
|
|
711
|
+
"attributes": [
|
|
712
|
+
{
|
|
713
|
+
"name": "assets",
|
|
714
|
+
"type": {
|
|
715
|
+
"text": "Asset[]"
|
|
716
|
+
},
|
|
717
|
+
"default": "[]",
|
|
718
|
+
"description": "Asset data to display in the bar chart. This array needs to be populated.\nUsed for the chart legend, information about units, and retrieval of data points.",
|
|
719
|
+
"fieldName": "assets"
|
|
720
|
+
},
|
|
721
|
+
{
|
|
722
|
+
"name": "assetAttributes",
|
|
723
|
+
"type": {
|
|
724
|
+
"text": "[number, Attribute<any>][]"
|
|
725
|
+
},
|
|
726
|
+
"default": "[]",
|
|
727
|
+
"description": "List of attributes to display in the bar chart. This array needs to be populated.\nUsed for the chart legend, and the retrieval of data points.\nFormatted as a JSON array of;\n\n```[<index of assets>, Attribute]```",
|
|
728
|
+
"fieldName": "assetAttributes"
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
"name": "realm",
|
|
732
|
+
"type": {
|
|
733
|
+
"text": "string | undefined"
|
|
734
|
+
},
|
|
735
|
+
"description": "Realm name to associate all the chart data with.",
|
|
736
|
+
"fieldName": "realm"
|
|
737
|
+
},
|
|
738
|
+
{
|
|
739
|
+
"name": "attributeColors",
|
|
740
|
+
"type": {
|
|
741
|
+
"text": "[AttributeRef, string][]"
|
|
742
|
+
},
|
|
743
|
+
"readonly": true,
|
|
744
|
+
"default": "[]",
|
|
745
|
+
"description": "The list of HEX colors representing the line color for each AttributeRef.\nActs as an override, and will fall back to the colors attribute if not specified.\nThe AttributeRef object with Asset ID and Attribute name need to be present in the Chart to work.\nThe HEX color should be put in without '#' prefix. For example, you'd use '4d9d2a' instead of '#4d9d2a'.",
|
|
746
|
+
"fieldName": "attributeColors"
|
|
747
|
+
},
|
|
748
|
+
{
|
|
749
|
+
"name": "attributeConfig",
|
|
750
|
+
"type": {
|
|
751
|
+
"text": "BarChartAttributeConfig | undefined"
|
|
752
|
+
},
|
|
753
|
+
"readonly": true,
|
|
754
|
+
"description": "The attribute configuration object with, for example, a list of right-axis attributes.\nSee BarChartAttributeConfig for full documentation on the options.",
|
|
755
|
+
"fieldName": "attributeConfig"
|
|
756
|
+
},
|
|
757
|
+
{
|
|
758
|
+
"name": "colors",
|
|
759
|
+
"type": {
|
|
760
|
+
"text": "string[]"
|
|
761
|
+
},
|
|
762
|
+
"readonly": true,
|
|
763
|
+
"description": "List of colors to display attributes values with inside the bar chart.\nThe array corresponds with assetAttributes, so the 1st color will be used for the 1st attribute.",
|
|
764
|
+
"fieldName": "colors"
|
|
765
|
+
},
|
|
766
|
+
{
|
|
767
|
+
"name": "datapointQuery",
|
|
768
|
+
"type": {
|
|
769
|
+
"text": "AssetDatapointQueryUnion"
|
|
770
|
+
},
|
|
771
|
+
"readonly": true,
|
|
772
|
+
"description": "The query object to request attribute data / data points with.\nNormally, it's of type AssetDatapointIntervalQuery, including a start- and end time.",
|
|
773
|
+
"fieldName": "datapointQuery"
|
|
774
|
+
},
|
|
775
|
+
{
|
|
776
|
+
"name": "timeframe",
|
|
777
|
+
"type": {
|
|
778
|
+
"text": "[Date, Date] | undefined"
|
|
779
|
+
},
|
|
780
|
+
"description": "Selected timeframe using a [start date, end date] array format.",
|
|
781
|
+
"fieldName": "timeframe"
|
|
782
|
+
},
|
|
783
|
+
{
|
|
784
|
+
"name": "chartOptions",
|
|
785
|
+
"type": {
|
|
786
|
+
"text": "ECChartOption | undefined"
|
|
787
|
+
},
|
|
788
|
+
"description": "Custom ECharts options object to configure the chart appearance.\nSee their documentation for more info: https://echarts.apache.org/en/option.html",
|
|
789
|
+
"fieldName": "chartOptions"
|
|
790
|
+
},
|
|
791
|
+
{
|
|
792
|
+
"name": "showLegend",
|
|
793
|
+
"type": {
|
|
794
|
+
"text": "boolean"
|
|
795
|
+
},
|
|
796
|
+
"default": "false",
|
|
797
|
+
"description": "Shows a right-side legend with the list of visible attributes.",
|
|
798
|
+
"fieldName": "showLegend"
|
|
799
|
+
},
|
|
800
|
+
{
|
|
801
|
+
"name": "denseLegend",
|
|
802
|
+
"type": {
|
|
803
|
+
"text": "boolean"
|
|
804
|
+
},
|
|
805
|
+
"default": "false",
|
|
806
|
+
"description": "Shows the right-side legend (toggled with showLegend) in a compact / dense format.",
|
|
807
|
+
"fieldName": "denseLegend"
|
|
808
|
+
},
|
|
809
|
+
{
|
|
810
|
+
"name": "stacked",
|
|
811
|
+
"type": {
|
|
812
|
+
"text": "boolean"
|
|
813
|
+
},
|
|
814
|
+
"default": "false",
|
|
815
|
+
"description": "Displays the bar chart in a vertically \"stacked\" configuration.\nIt will display a cumulative effect of all data series on top of each other.",
|
|
816
|
+
"fieldName": "stacked"
|
|
817
|
+
},
|
|
818
|
+
{
|
|
819
|
+
"name": "timestampControls",
|
|
820
|
+
"type": {
|
|
821
|
+
"text": "boolean"
|
|
822
|
+
},
|
|
823
|
+
"default": "true",
|
|
824
|
+
"description": "Enables time control for the user, allowing them to customize the timeframe shown.\nLeaving this disabled/unset will show them in a \"read-only\" state.",
|
|
825
|
+
"fieldName": "timestampControls"
|
|
826
|
+
},
|
|
827
|
+
{
|
|
828
|
+
"name": "decimals",
|
|
829
|
+
"type": {
|
|
830
|
+
"text": "number"
|
|
831
|
+
},
|
|
832
|
+
"default": "2",
|
|
833
|
+
"description": "Number of decimals to display for attributes.",
|
|
834
|
+
"fieldName": "decimals"
|
|
835
|
+
},
|
|
836
|
+
{
|
|
837
|
+
"name": "timePrefixOptions",
|
|
838
|
+
"type": {
|
|
839
|
+
"text": "string[]"
|
|
840
|
+
},
|
|
841
|
+
"description": "A JSON array list of strings that represent the prefix options in the UI, such as \"current\" or \"last\".\nIn combination with timeWindowOptions, it provides a timeframe like \"current 1 hour\" to display data of.",
|
|
842
|
+
"fieldName": "timePrefixOptions"
|
|
843
|
+
},
|
|
844
|
+
{
|
|
845
|
+
"name": "timePrefixKey",
|
|
846
|
+
"type": {
|
|
847
|
+
"text": "string | undefined"
|
|
848
|
+
},
|
|
849
|
+
"description": "The selected option from timePrefixOptions, such as \"current\" or \"last\".\nIn combination with timeWindowOptions, it provides a timeframe like \"current 1 hour\" to display data of.",
|
|
850
|
+
"fieldName": "timePrefixKey"
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
"name": "timeWindowOptions",
|
|
854
|
+
"type": {
|
|
855
|
+
"text": "Map<string, [moment.unitOfTime.DurationConstructor, number]>"
|
|
856
|
+
},
|
|
857
|
+
"description": "A JSON object containing a list of time window options, like \"1 day\", \"6 hours\" or \"52 weeks\".\nIn combination with timePrefixOptions, it provides a timeframe like \"last 6 hours\" to display data of.\nThe input should contain a JavaScript Map, containing the following:\n- A string with a unique key like \"6hours\",\n- A combination of any moment.unitOfTime.DurationConstructor and number, like [\"hours\", 6]\n\nExample input: `{\"6hours\": [\"hours\", 6], \"4weeks\": [\"weeks\", 4]}`",
|
|
858
|
+
"fieldName": "timeWindowOptions"
|
|
859
|
+
},
|
|
860
|
+
{
|
|
861
|
+
"name": "timeWindowKey",
|
|
862
|
+
"type": {
|
|
863
|
+
"text": "string | undefined"
|
|
864
|
+
},
|
|
865
|
+
"description": "The key value of the selected option from timeWindowOptions, such as \"1day\", \"6hours\" or \"52weeks\".\nIn combination with timePrefixOptions, it provides a timeframe like \"last 6 hours\" to display data of.",
|
|
866
|
+
"fieldName": "timeWindowKey"
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
"name": "intervalOptions",
|
|
870
|
+
"type": {
|
|
871
|
+
"text": "Map<BarChartInterval, IntervalConfig>"
|
|
872
|
+
},
|
|
873
|
+
"description": "A JSON object containing a list of interval options, like \"30minutes\", \"hour\" or \"day\".\nIt determines the interval to display data in sections. For example, split the data every 5 minutes of the past hour.\nIn combination with the active formula in datapointQuery, such as AVG and MIN/MAX, it will show a '5 minute' average of the past hour.\nThe input should contain a JavaScript Map, containing the following:\n- A BarChartInterval string with a unique key like \"hour\" or \"day\",\n- A IntervalConfig object with details on the interval, such as the display name and the unit of time.\n\nExample input:\n```\n{\"30minutes\": {\n displayName: \"30Minutes\", // translated automatically\n steps: 30,\n orFormat: \"minute\",\n momentFormat: \"minutes\", // using moment.js format\n millis: 1800000\n}}\n```",
|
|
874
|
+
"fieldName": "intervalOptions"
|
|
875
|
+
},
|
|
876
|
+
{
|
|
877
|
+
"name": "interval",
|
|
878
|
+
"type": {
|
|
879
|
+
"text": "BarChartInterval | undefined"
|
|
880
|
+
},
|
|
881
|
+
"description": "The key value of the selected option from intervalOptions, such as \"30minute\", \"hour\" or \"week\".\nIn combination with the active formula in datapointQuery, such as AVG and MIN/MAX, it will show a '5 minute' average of the past hour.",
|
|
882
|
+
"fieldName": "interval"
|
|
883
|
+
}
|
|
884
|
+
],
|
|
885
|
+
"superclass": {
|
|
886
|
+
"name": "LitElement",
|
|
887
|
+
"package": "lit"
|
|
888
|
+
},
|
|
889
|
+
"tagName": "or-attribute-barchart",
|
|
890
|
+
"customElement": true
|
|
891
|
+
}
|
|
892
|
+
],
|
|
893
|
+
"exports": [
|
|
894
|
+
{
|
|
895
|
+
"kind": "js",
|
|
896
|
+
"name": "OrAttributeBarChart",
|
|
897
|
+
"declaration": {
|
|
898
|
+
"name": "OrAttributeBarChart",
|
|
899
|
+
"module": "src/index.ts"
|
|
900
|
+
}
|
|
901
|
+
},
|
|
902
|
+
{
|
|
903
|
+
"kind": "custom-element-definition",
|
|
904
|
+
"name": "or-attribute-barchart",
|
|
905
|
+
"declaration": {
|
|
906
|
+
"name": "OrAttributeBarChart",
|
|
907
|
+
"module": "src/index.ts"
|
|
908
|
+
}
|
|
909
|
+
}
|
|
910
|
+
]
|
|
911
|
+
}
|
|
912
|
+
]
|
|
913
|
+
}
|