@luzmo/dashboard-contents-types 1.0.0 → 1.0.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.
Files changed (73) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +154 -0
  3. package/assets/json-schemas/area-chart-options.schema.json.d.ts +75 -157
  4. package/assets/json-schemas/area-chart-slots.schema.json.d.ts +13 -13
  5. package/assets/json-schemas/bar-chart-options.schema.json.d.ts +74 -5
  6. package/assets/json-schemas/bar-chart-slots.schema.json.d.ts +13 -13
  7. package/assets/json-schemas/box-plot-options.schema.json.d.ts +74 -5
  8. package/assets/json-schemas/box-plot-slots.schema.json.d.ts +13 -13
  9. package/assets/json-schemas/bubble-chart-options.schema.json.d.ts +74 -5
  10. package/assets/json-schemas/bubble-chart-slots.schema.json.d.ts +13 -13
  11. package/assets/json-schemas/bullet-chart-options.schema.json.d.ts +74 -5
  12. package/assets/json-schemas/bullet-chart-slots.schema.json.d.ts +13 -13
  13. package/assets/json-schemas/choropleth-map-options.schema.json.d.ts +74 -5
  14. package/assets/json-schemas/choropleth-map-slots.schema.json.d.ts +13 -40
  15. package/assets/json-schemas/circular-gauge-options.schema.json.d.ts +74 -5
  16. package/assets/json-schemas/circular-gauge-slots.schema.json.d.ts +13 -13
  17. package/assets/json-schemas/column-chart-options.schema.json.d.ts +74 -5
  18. package/assets/json-schemas/column-chart-slots.schema.json.d.ts +13 -13
  19. package/assets/json-schemas/combination-chart-options.schema.json.d.ts +74 -5
  20. package/assets/json-schemas/combination-chart-slots.schema.json.d.ts +13 -13
  21. package/assets/json-schemas/date-filter-options.schema.json.d.ts +74 -5
  22. package/assets/json-schemas/date-filter-slots.schema.json.d.ts +4 -4
  23. package/assets/json-schemas/donut-chart-options.schema.json.d.ts +74 -5
  24. package/assets/json-schemas/donut-chart-slots.schema.json.d.ts +13 -13
  25. package/assets/json-schemas/dropdown-filter-options.schema.json.d.ts +74 -5
  26. package/assets/json-schemas/dropdown-filter-slots.schema.json.d.ts +13 -13
  27. package/assets/json-schemas/evolution-number-options.schema.json.d.ts +74 -5
  28. package/assets/json-schemas/evolution-number-slots.schema.json.d.ts +13 -13
  29. package/assets/json-schemas/funnel-chart-options.schema.json.d.ts +74 -5
  30. package/assets/json-schemas/funnel-chart-slots.schema.json.d.ts +13 -13
  31. package/assets/json-schemas/image-options.schema.json.d.ts +69 -0
  32. package/assets/json-schemas/line-chart-options.schema.json.d.ts +74 -5
  33. package/assets/json-schemas/line-chart-slots.schema.json.d.ts +13 -13
  34. package/assets/json-schemas/options.schema.json.d.ts +3 -0
  35. package/assets/json-schemas/pivot-table-options.schema.json.d.ts +74 -5
  36. package/assets/json-schemas/pivot-table-slots.schema.json.d.ts +13 -13
  37. package/assets/json-schemas/regular-table-options.schema.json.d.ts +74 -5
  38. package/assets/json-schemas/regular-table-slots.schema.json.d.ts +13 -13
  39. package/assets/json-schemas/sankey-diagram-options.schema.json.d.ts +74 -5
  40. package/assets/json-schemas/sankey-diagram-slots.schema.json.d.ts +13 -13
  41. package/assets/json-schemas/scatter-plot-options.schema.json.d.ts +74 -5
  42. package/assets/json-schemas/scatter-plot-slots.schema.json.d.ts +13 -13
  43. package/assets/json-schemas/slicer-filter-options.schema.json.d.ts +74 -5
  44. package/assets/json-schemas/slicer-filter-slots.schema.json.d.ts +13 -13
  45. package/assets/json-schemas/slider-filter-options.schema.json.d.ts +74 -5
  46. package/assets/json-schemas/slider-filter-slots.schema.json.d.ts +9 -9
  47. package/assets/json-schemas/slots.schema.json.d.ts +3 -0
  48. package/assets/json-schemas/text-options.schema.json.d.ts +69 -0
  49. package/index.js +220 -142
  50. package/index.mjs +2194 -701
  51. package/json-schemas.d.ts +1334 -123
  52. package/json-schemas.d.ts.map +1 -1
  53. package/package.json +1 -1
  54. package/src/lib/area-chart/area-chart-options.d.ts +7 -4
  55. package/src/lib/area-chart/area-chart-options.d.ts.map +1 -1
  56. package/src/lib/date-filter/date-filter-options.d.ts +1 -2
  57. package/src/lib/date-filter/date-filter-options.d.ts.map +1 -1
  58. package/src/lib/dropdown-filter/dropdown-filter-options.d.ts +1 -2
  59. package/src/lib/dropdown-filter/dropdown-filter-options.d.ts.map +1 -1
  60. package/src/lib/shared/index.d.ts +1 -0
  61. package/src/lib/shared/index.d.ts.map +1 -1
  62. package/src/lib/shared/object-view-options.d.ts +2 -1
  63. package/src/lib/shared/object-view-options.d.ts.map +1 -1
  64. package/src/lib/shared/slots.d.ts +7 -6
  65. package/src/lib/shared/slots.d.ts.map +1 -1
  66. package/src/lib/shared/viz-item.d.ts +60 -0
  67. package/src/lib/shared/viz-item.d.ts.map +1 -0
  68. package/src/lib/slicer-filter/slicer-filter-options.d.ts +1 -1
  69. package/src/lib/slicer-filter/slicer-filter-options.d.ts.map +1 -1
  70. package/src/lib/slider-filter/slider-filter-options.d.ts +1 -1
  71. package/src/lib/slider-filter/slider-filter-options.d.ts.map +1 -1
  72. package/src/options.d.ts +1 -1
  73. package/src/options.d.ts.map +1 -1
package/assets/json-schemas/slicer-filter-slots.schema.json.d.ts CHANGED
@@ -98,18 +98,18 @@ declare const _default: {
98
98
  "type": "string"
99
99
  },
100
100
  "periodOverPeriod": {
101
- "description": "Settings to configure period over period comparison",
101
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
102
102
  "properties": {
103
103
  "level": {
104
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
104
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
105
105
  "type": "number"
106
106
  },
107
107
  "periodToDate": {
108
- "description": "period to date comparison",
108
+ "description": "Turn ON/OFF period to date comparison",
109
109
  "type": "boolean"
110
110
  },
111
111
  "quantity": {
112
- "description": "number of periods",
112
+ "description": "Number of periods",
113
113
  "type": "number"
114
114
  },
115
115
  "type": {
@@ -240,18 +240,18 @@ declare const _default: {
240
240
  ]
241
241
  },
242
242
  "periodOverPeriod": {
243
- "description": "Settings to configure period over period comparison",
243
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
244
244
  "properties": {
245
245
  "level": {
246
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
246
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
247
247
  "type": "number"
248
248
  },
249
249
  "periodToDate": {
250
- "description": "period to date comparison",
250
+ "description": "Turn ON/OFF period to date comparison",
251
251
  "type": "boolean"
252
252
  },
253
253
  "quantity": {
254
- "description": "number of periods",
254
+ "description": "Number of periods",
255
255
  "type": "number"
256
256
  },
257
257
  "type": {
@@ -428,7 +428,7 @@ declare const _default: {
428
428
  "type": "string"
429
429
  },
430
430
  "formula": {
431
- "description": "A dataset formula id or an ad-hoc formula. A formula is an entity similar to a column. You can add formulas on the dataset details page or use ad-hoc formulas.",
431
+ "description": "A dataset formula id or an ad-hoc formula. A formula is an entity similar to a column. You can add formulas on the dataset details page or use ad-hoc formulas. You can find more information about formulas in the article https://academy.luzmo.com/article/52tm82oo",
432
432
  "type": "string"
433
433
  },
434
434
  "grandTotals": {
@@ -445,18 +445,18 @@ declare const _default: {
445
445
  "type": "object"
446
446
  },
447
447
  "periodOverPeriod": {
448
- "description": "Settings to configure period over period comparison",
448
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
449
449
  "properties": {
450
450
  "level": {
451
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
451
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
452
452
  "type": "number"
453
453
  },
454
454
  "periodToDate": {
455
- "description": "period to date comparison",
455
+ "description": "Turn ON/OFF period to date comparison",
456
456
  "type": "boolean"
457
457
  },
458
458
  "quantity": {
459
- "description": "number of periods",
459
+ "description": "Number of periods",
460
460
  "type": "number"
461
461
  },
462
462
  "type": {
package/assets/json-schemas/slider-filter-options.schema.json.d.ts CHANGED
@@ -545,7 +545,7 @@ declare const _default: {
545
545
  "type": "string"
546
546
  },
547
547
  "formula": {
548
- "description": "A dataset formula id or an ad-hoc formula. A formula is an entity similar to a column. You can add formulas on the dataset details page or use ad-hoc formulas.",
548
+ "description": "A dataset formula id or an ad-hoc formula. A formula is an entity similar to a column. You can add formulas on the dataset details page or use ad-hoc formulas. You can find more information about formulas in the article https://academy.luzmo.com/article/52tm82oo",
549
549
  "type": "string"
550
550
  },
551
551
  "grandTotals": {
@@ -592,18 +592,18 @@ declare const _default: {
592
592
  "type": "string"
593
593
  },
594
594
  "periodOverPeriod": {
595
- "description": "Settings to configure period over period comparison",
595
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
596
596
  "properties": {
597
597
  "level": {
598
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
598
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
599
599
  "type": "number"
600
600
  },
601
601
  "periodToDate": {
602
- "description": "period to date comparison",
602
+ "description": "Turn ON/OFF period to date comparison",
603
603
  "type": "boolean"
604
604
  },
605
605
  "quantity": {
606
- "description": "number of periods",
606
+ "description": "Number of periods",
607
607
  "type": "number"
608
608
  },
609
609
  "type": {
@@ -695,6 +695,67 @@ declare const _default: {
695
695
  },
696
696
  "type": "object"
697
697
  },
698
+ "loader": {
699
+ "description": "The loader configuration",
700
+ "properties": {
701
+ "background": {
702
+ "default": "#f9f9f9",
703
+ "description": "Background color of the chart loader element",
704
+ "type": "string"
705
+ },
706
+ "fontColor": {
707
+ "default": "#5a5a5a",
708
+ "description": "Font color of the text of the chart loaders",
709
+ "type": "string"
710
+ },
711
+ "locale": {
712
+ "default": "en",
713
+ "description": "Locale to be used if \"msg\" is set",
714
+ "examples": [
715
+ "en",
716
+ "fr"
717
+ ],
718
+ "type": "string"
719
+ },
720
+ "mode": {
721
+ "default": "light",
722
+ "description": "Light or dark loader",
723
+ "type": "string"
724
+ },
725
+ "msg": {
726
+ "description": "Loading message",
727
+ "examples": [
728
+ "Loading dashboard..."
729
+ ],
730
+ "type": "string"
731
+ },
732
+ "showBranded": {
733
+ "default": false,
734
+ "description": "Shows the branded \"powered by\" information",
735
+ "type": "boolean"
736
+ },
737
+ "spinnerBackground": {
738
+ "default": "rgba(169, 169, 169, 0.14)",
739
+ "description": "Background color of the spinner",
740
+ "type": "string"
741
+ },
742
+ "spinnerColor": {
743
+ "default": "rgba(255, 165, 0, 0.7)",
744
+ "description": "Spinner color of the loader",
745
+ "type": "string"
746
+ }
747
+ },
748
+ "type": "object"
749
+ },
750
+ "locale": {
751
+ "default": "en",
752
+ "description": "Locale to be used",
753
+ "examples": [
754
+ "en",
755
+ "fr"
756
+ ],
757
+ "type": "string"
758
+ },
698
759
  "padding": {
699
760
  "description": "Padding of the slider filter",
700
761
  "properties": {
@@ -1174,6 +1235,14 @@ declare const _default: {
1174
1235
  },
1175
1236
  "type": "object"
1176
1237
  },
1238
+ "timezoneId": {
1239
+ "description": "The timezone that will be used in the dashboard. This timezone id needs to be a valid id that is available in the IANA timezone database",
1240
+ "examples": [
1241
+ "Europe/Brussels",
1242
+ "America/New_York"
1243
+ ],
1244
+ "type": "string"
1245
+ },
1177
1246
  "title": {
1178
1247
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
1179
1248
  "examples": [
package/assets/json-schemas/slider-filter-slots.schema.json.d.ts CHANGED
@@ -98,18 +98,18 @@ declare const _default: {
98
98
  "type": "string"
99
99
  },
100
100
  "periodOverPeriod": {
101
- "description": "Settings to configure period over period comparison",
101
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
102
102
  "properties": {
103
103
  "level": {
104
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
104
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
105
105
  "type": "number"
106
106
  },
107
107
  "periodToDate": {
108
- "description": "period to date comparison",
108
+ "description": "Turn ON/OFF period to date comparison",
109
109
  "type": "boolean"
110
110
  },
111
111
  "quantity": {
112
- "description": "number of periods",
112
+ "description": "Number of periods",
113
113
  "type": "number"
114
114
  },
115
115
  "type": {
@@ -258,7 +258,7 @@ declare const _default: {
258
258
  "type": "string"
259
259
  },
260
260
  "formula": {
261
- "description": "A dataset formula id or an ad-hoc formula. A formula is an entity similar to a column. You can add formulas on the dataset details page or use ad-hoc formulas.",
261
+ "description": "A dataset formula id or an ad-hoc formula. A formula is an entity similar to a column. You can add formulas on the dataset details page or use ad-hoc formulas. You can find more information about formulas in the article https://academy.luzmo.com/article/52tm82oo",
262
262
  "type": "string"
263
263
  },
264
264
  "grandTotals": {
@@ -275,18 +275,18 @@ declare const _default: {
275
275
  "type": "object"
276
276
  },
277
277
  "periodOverPeriod": {
278
- "description": "Settings to configure period over period comparison",
278
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
279
279
  "properties": {
280
280
  "level": {
281
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
281
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
282
282
  "type": "number"
283
283
  },
284
284
  "periodToDate": {
285
- "description": "period to date comparison",
285
+ "description": "Turn ON/OFF period to date comparison",
286
286
  "type": "boolean"
287
287
  },
288
288
  "quantity": {
289
- "description": "number of periods",
289
+ "description": "Number of periods",
290
290
  "type": "number"
291
291
  },
292
292
  "type": {
package/assets/json-schemas/slots.schema.json.d.ts CHANGED
@@ -64,6 +64,9 @@ declare const _default: {
64
64
  },
65
65
  {
66
66
  "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/slider-filter-slots.schema.json"
67
+ },
68
+ {
69
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/search-filter-slots.schema.json"
67
70
  }
68
71
  ]
69
72
  };
package/assets/json-schemas/text-options.schema.json.d.ts CHANGED
@@ -28,6 +28,67 @@ declare const _default: {
28
28
  ],
29
29
  "type": "object"
30
30
  },
31
+ "loader": {
32
+ "description": "The loader configuration",
33
+ "properties": {
34
+ "background": {
35
+ "default": "#f9f9f9",
36
+ "description": "Background color of the chart loader element",
37
+ "type": "string"
38
+ },
39
+ "fontColor": {
40
+ "default": "#5a5a5a",
41
+ "description": "Font color of the text of the chart loaders",
42
+ "type": "string"
43
+ },
44
+ "locale": {
45
+ "default": "en",
46
+ "description": "Locale to be used if \"msg\" is set",
47
+ "examples": [
48
+ "en",
49
+ "fr"
50
+ ],
51
+ "type": "string"
52
+ },
53
+ "mode": {
54
+ "default": "light",
55
+ "description": "Light or dark loader",
56
+ "type": "string"
57
+ },
58
+ "msg": {
59
+ "description": "Loading message",
60
+ "examples": [
61
+ "Loading dashboard..."
62
+ ],
63
+ "type": "string"
64
+ },
65
+ "showBranded": {
66
+ "default": false,
67
+ "description": "Shows the branded \"powered by\" information",
68
+ "type": "boolean"
69
+ },
70
+ "spinnerBackground": {
71
+ "default": "rgba(169, 169, 169, 0.14)",
72
+ "description": "Background color of the spinner",
73
+ "type": "string"
74
+ },
75
+ "spinnerColor": {
76
+ "default": "rgba(255, 165, 0, 0.7)",
77
+ "description": "Spinner color of the loader",
78
+ "type": "string"
79
+ }
80
+ },
81
+ "type": "object"
82
+ },
83
+ "locale": {
84
+ "default": "en",
85
+ "description": "Locale to be used",
86
+ "examples": [
87
+ "en",
88
+ "fr"
89
+ ],
90
+ "type": "string"
91
+ },
31
92
  "padding": {
32
93
  "description": "Padding of the text item",
33
94
  "properties": {
@@ -517,6 +578,14 @@ declare const _default: {
517
578
  },
518
579
  "type": "object"
519
580
  },
581
+ "timezoneId": {
582
+ "description": "The timezone that will be used in the dashboard. This timezone id needs to be a valid id that is available in the IANA timezone database",
583
+ "examples": [
584
+ "Europe/Brussels",
585
+ "America/New_York"
586
+ ],
587
+ "type": "string"
588
+ },
520
589
  "title": {
521
590
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
522
591
  "examples": [