@nebula.js/sn-gauge 0.8.5 → 0.8.7

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.
@@ -3,7 +3,7 @@
3
3
  "info": {
4
4
  "name": "@nebula.js/sn-gauge:properties",
5
5
  "description": "Gauge generic object definition",
6
- "version": "0.8.5",
6
+ "version": "0.8.7",
7
7
  "license": "MIT",
8
8
  "stability": "stable",
9
9
  "x-qlik-visibility": "public"
@@ -17,10 +17,67 @@
17
17
  ],
18
18
  "kind": "object",
19
19
  "entries": {
20
+ "autoOrientation": {
21
+ "description": "Auto orientation, only applicable to bar gauge.\nIf true, the orientation of the bar gauge is adaptive to the aspect ratio of the chart.",
22
+ "defaultValue": true,
23
+ "type": "boolean"
24
+ },
25
+ "color": {
26
+ "description": "Color settings.",
27
+ "entries": {
28
+ "useBaseColors": {
29
+ "description": "If should use colors encoded in master items",
30
+ "defaultValue": "measure",
31
+ "kind": "union",
32
+ "items": [
33
+ {
34
+ "kind": "literal",
35
+ "value": "'measure'"
36
+ },
37
+ {
38
+ "kind": "literal",
39
+ "value": "'off'"
40
+ }
41
+ ]
42
+ }
43
+ },
44
+ "kind": "object"
45
+ },
46
+ "components": {
47
+ "description": "Styling of chart components.",
48
+ "kind": "array",
49
+ "items": {
50
+ "type": "#/definitions/Component"
51
+ }
52
+ },
20
53
  "footnote": {
21
54
  "description": "Footnote of the visualization.",
55
+ "optional": true,
22
56
  "defaultValue": "",
23
- "type": "string"
57
+ "kind": "union",
58
+ "items": [
59
+ {
60
+ "type": "string"
61
+ },
62
+ {
63
+ "type": "#/definitions/StringExpression"
64
+ }
65
+ ]
66
+ },
67
+ "gaugetype": {
68
+ "description": "Gauge type",
69
+ "defaultValue": "radial",
70
+ "kind": "union",
71
+ "items": [
72
+ {
73
+ "kind": "literal",
74
+ "value": "'radial'"
75
+ },
76
+ {
77
+ "kind": "literal",
78
+ "value": "'bar'"
79
+ }
80
+ ]
24
81
  },
25
82
  "measureAxis": {
26
83
  "description": "Measure axis configuration.",
@@ -28,18 +85,76 @@
28
85
  "max": {
29
86
  "description": "Maximum value for the measure axis.",
30
87
  "defaultValue": 100,
31
- "type": "number"
88
+ "kind": "union",
89
+ "items": [
90
+ {
91
+ "type": "number"
92
+ },
93
+ {
94
+ "type": "#/definitions/ValueExpression"
95
+ }
96
+ ]
32
97
  },
33
98
  "min": {
34
99
  "description": "Minimum value for the measure axis.",
35
100
  "defaultValue": 0,
36
- "type": "number"
101
+ "kind": "union",
102
+ "items": [
103
+ {
104
+ "type": "number"
105
+ },
106
+ {
107
+ "type": "#/definitions/ValueExpression"
108
+ }
109
+ ]
110
+ },
111
+ "show": {
112
+ "description": "Labels and title",
113
+ "defaultValue": "all",
114
+ "kind": "union",
115
+ "items": [
116
+ {
117
+ "kind": "literal",
118
+ "value": "'all'"
119
+ },
120
+ {
121
+ "kind": "literal",
122
+ "value": "'labels'"
123
+ },
124
+ {
125
+ "kind": "literal",
126
+ "value": "'title'"
127
+ },
128
+ {
129
+ "kind": "literal",
130
+ "value": "'none'"
131
+ }
132
+ ]
133
+ },
134
+ "spacing": {
135
+ "description": "Axis scale",
136
+ "defaultValue": 1,
137
+ "kind": "union",
138
+ "items": [
139
+ {
140
+ "kind": "literal",
141
+ "value": 1
142
+ },
143
+ {
144
+ "kind": "literal",
145
+ "value": 0.5
146
+ },
147
+ {
148
+ "kind": "literal",
149
+ "value": 2
150
+ }
151
+ ]
37
152
  }
38
153
  },
39
154
  "kind": "object"
40
155
  },
41
156
  "orientation": {
42
- "description": "Orientation of the gauge.",
157
+ "description": "Orientation of the bar gauge. Only applicable when autoOrientation is false.",
43
158
  "defaultValue": "horizontal",
44
159
  "kind": "union",
45
160
  "items": [
@@ -53,6 +168,10 @@
53
168
  }
54
169
  ]
55
170
  },
171
+ "paletteProgressColor": {
172
+ "description": "Define the progress color.\nApplicable when useSegment is 'off' and useBaseColors is also 'off'",
173
+ "type": "#/definitions/PaletteColor"
174
+ },
56
175
  "qHyperCubeDef": {
57
176
  "description": "Hypercube definition for the visualization.",
58
177
  "entries": {
@@ -88,6 +207,19 @@
88
207
  },
89
208
  "kind": "object"
90
209
  },
210
+ "refLine": {
211
+ "description": "Reference lines settings",
212
+ "entries": {
213
+ "refLines": {
214
+ "description": "Array of measure based reference line definitions",
215
+ "kind": "array",
216
+ "items": {
217
+ "type": "#/definitions/RefLine"
218
+ }
219
+ }
220
+ },
221
+ "kind": "object"
222
+ },
91
223
  "segmentInfo": {
92
224
  "description": "Segment information for the gauge.",
93
225
  "entries": {
@@ -95,32 +227,24 @@
95
227
  "description": "Array of segment limits.",
96
228
  "kind": "array",
97
229
  "items": {
98
- "kind": "object",
99
- "entries": {
100
- "value": {
101
- "type": "number"
102
- },
103
- "gradient": {
104
- "type": "boolean"
105
- }
106
- }
230
+ "type": "#/definitions/Limits"
107
231
  }
108
232
  },
109
233
  "paletteColors": {
110
234
  "description": "Array of segment colors.",
111
235
  "kind": "array",
112
236
  "items": {
113
- "kind": "object",
114
- "entries": {
115
- "index": {
116
- "type": "number"
117
- }
118
- }
237
+ "type": "#/definitions/PaletteColor"
119
238
  }
120
239
  }
121
240
  },
122
241
  "kind": "object"
123
242
  },
243
+ "showDetails": {
244
+ "description": "Show visualization details toggle",
245
+ "defaultValue": true,
246
+ "type": "boolean"
247
+ },
124
248
  "showTitles": {
125
249
  "description": "Whether to show titles for the visualization.",
126
250
  "defaultValue": true,
@@ -128,13 +252,36 @@
128
252
  },
129
253
  "subtitle": {
130
254
  "description": "Subtitle of the visualization.",
255
+ "optional": true,
131
256
  "defaultValue": "",
132
- "type": "string"
257
+ "kind": "union",
258
+ "items": [
259
+ {
260
+ "type": "string"
261
+ },
262
+ {
263
+ "type": "#/definitions/StringExpression"
264
+ }
265
+ ]
133
266
  },
134
267
  "title": {
135
268
  "description": "Title of the visualization.",
269
+ "optional": true,
136
270
  "defaultValue": "",
137
- "type": "string"
271
+ "kind": "union",
272
+ "items": [
273
+ {
274
+ "type": "string"
275
+ },
276
+ {
277
+ "type": "#/definitions/StringExpression"
278
+ }
279
+ ]
280
+ },
281
+ "useSegments": {
282
+ "description": "Decide if segments coloring or progress coloring is used.\nIf true, the segments are colored according to the segmentInfo.paletteColors.",
283
+ "defaultValue": false,
284
+ "type": "boolean"
138
285
  },
139
286
  "version": {
140
287
  "description": "Current version of this generic object definition",
@@ -143,5 +290,244 @@
143
290
  }
144
291
  }
145
292
  },
146
- "definitions": {}
293
+ "definitions": {
294
+ "Axis": {
295
+ "kind": "object",
296
+ "entries": {
297
+ "axis": {
298
+ "type": "#/definitions/AxisStyling"
299
+ },
300
+ "key": {
301
+ "description": "This should be set to `\"axis\"`",
302
+ "type": "string"
303
+ }
304
+ }
305
+ },
306
+ "AxisStyling": {
307
+ "kind": "object",
308
+ "entries": {
309
+ "label": {
310
+ "type": "#/definitions/LabelNameStyling"
311
+ },
312
+ "title": {
313
+ "type": "#/definitions/FontStyling"
314
+ }
315
+ }
316
+ },
317
+ "Component": {
318
+ "kind": "alias",
319
+ "items": {
320
+ "kind": "union",
321
+ "items": [
322
+ {
323
+ "type": "#/definitions/Label"
324
+ },
325
+ {
326
+ "type": "#/definitions/Axis"
327
+ }
328
+ ]
329
+ }
330
+ },
331
+ "Expr": {
332
+ "description": "Expression",
333
+ "kind": "object",
334
+ "entries": {
335
+ "qExpr": {
336
+ "description": "expression as a string, e.g. '=Sum([Actual Amount])', note that the equal sign is optional",
337
+ "type": "string"
338
+ }
339
+ }
340
+ },
341
+ "FontStyling": {
342
+ "kind": "object",
343
+ "entries": {
344
+ "color": {
345
+ "type": "#/definitions/PaletteColor"
346
+ },
347
+ "fontFamily": {
348
+ "type": "string"
349
+ }
350
+ }
351
+ },
352
+ "Label": {
353
+ "kind": "object",
354
+ "entries": {
355
+ "key": {
356
+ "description": "This should be set to `\"value\"`",
357
+ "type": "string"
358
+ },
359
+ "label": {
360
+ "type": "#/definitions/LabelValueStyling"
361
+ }
362
+ }
363
+ },
364
+ "LabelNameStyling": {
365
+ "kind": "object",
366
+ "entries": {
367
+ "name": {
368
+ "type": "#/definitions/FontStyling"
369
+ }
370
+ }
371
+ },
372
+ "LabelValueStyling": {
373
+ "kind": "object",
374
+ "entries": {
375
+ "value": {
376
+ "description": "Gauge value label",
377
+ "type": "#/definitions/FontStyling"
378
+ }
379
+ }
380
+ },
381
+ "Limits": {
382
+ "description": "The limits between segments colors.",
383
+ "kind": "object",
384
+ "entries": {
385
+ "gradient": {
386
+ "description": "Gradient color (i.e. gradually changing color) or solid color",
387
+ "type": "boolean"
388
+ },
389
+ "value": {
390
+ "description": "Value of the limit",
391
+ "kind": "union",
392
+ "items": [
393
+ {
394
+ "type": "number"
395
+ },
396
+ {
397
+ "type": "#/definitions/ValueExpression"
398
+ }
399
+ ]
400
+ }
401
+ }
402
+ },
403
+ "PaletteColor": {
404
+ "description": "Color information structure. Holds the actual color and index in palette.",
405
+ "kind": "object",
406
+ "entries": {
407
+ "color": {
408
+ "description": "Color as hex string (mandatory if index: -1)",
409
+ "type": "string"
410
+ },
411
+ "index": {
412
+ "description": "Index in palette",
413
+ "type": "number"
414
+ }
415
+ }
416
+ },
417
+ "RefLine": {
418
+ "kind": "object",
419
+ "entries": {
420
+ "label": {
421
+ "description": "Reference line label.",
422
+ "kind": "union",
423
+ "items": [
424
+ {
425
+ "type": "string"
426
+ },
427
+ {
428
+ "type": "#/definitions/StringExpression"
429
+ }
430
+ ]
431
+ },
432
+ "paletteColor": {
433
+ "description": "Color of the reference line and label.",
434
+ "type": "#/definitions/PaletteColor"
435
+ },
436
+ "refLineExpr": {
437
+ "kind": "object",
438
+ "entries": {
439
+ "value": {
440
+ "kind": "union",
441
+ "items": [
442
+ {
443
+ "type": "number"
444
+ },
445
+ {
446
+ "type": "#/definitions/ValueExpression"
447
+ }
448
+ ]
449
+ },
450
+ "label": {
451
+ "optional": true,
452
+ "kind": "union",
453
+ "items": [
454
+ {
455
+ "type": "string"
456
+ },
457
+ {
458
+ "type": "#/definitions/StringExpression"
459
+ }
460
+ ]
461
+ }
462
+ }
463
+ },
464
+ "show": {
465
+ "description": "Set to true to display this reference line.",
466
+ "defaultValue": true,
467
+ "kind": "union",
468
+ "items": [
469
+ {
470
+ "type": "boolean"
471
+ },
472
+ {
473
+ "type": "#/definitions/ValueExpression"
474
+ }
475
+ ]
476
+ },
477
+ "showLabel": {
478
+ "description": "Set to true to show the label of this reference line.",
479
+ "optional": true,
480
+ "defaultValue": true,
481
+ "type": "boolean"
482
+ },
483
+ "showValue": {
484
+ "description": "Set to true to show the value of this reference line.",
485
+ "optional": true,
486
+ "defaultValue": true,
487
+ "type": "boolean"
488
+ },
489
+ "style": {
490
+ "description": "Styling settings for reference line",
491
+ "optional": true,
492
+ "type": "#/definitions/RefLineStyle"
493
+ }
494
+ }
495
+ },
496
+ "RefLineStyle": {
497
+ "description": "Styling settings for reference line",
498
+ "kind": "object",
499
+ "entries": {
500
+ "lineThickness": {
501
+ "description": "Set the thickness for this reference line.",
502
+ "optional": true,
503
+ "defaultValue": 2,
504
+ "type": "number"
505
+ },
506
+ "lineType": {
507
+ "description": "Set the dash type for this reference line.",
508
+ "optional": true,
509
+ "defaultValue": "''",
510
+ "type": "string"
511
+ }
512
+ }
513
+ },
514
+ "StringExpression": {
515
+ "description": "String expression",
516
+ "kind": "object",
517
+ "entries": {
518
+ "qStringExpression": {
519
+ "type": "#/definitions/Expr"
520
+ }
521
+ }
522
+ },
523
+ "ValueExpression": {
524
+ "description": "Value expression",
525
+ "kind": "object",
526
+ "entries": {
527
+ "qValueExpression": {
528
+ "type": "#/definitions/Expr"
529
+ }
530
+ }
531
+ }
532
+ }
147
533
  }