@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/column-chart-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": {
@@ -212,18 +212,18 @@ declare const _default: {
212
212
  ]
213
213
  },
214
214
  "periodOverPeriod": {
215
- "description": "Settings to configure period over period comparison",
215
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
216
216
  "properties": {
217
217
  "level": {
218
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
218
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
219
219
  "type": "number"
220
220
  },
221
221
  "periodToDate": {
222
- "description": "period to date comparison",
222
+ "description": "Turn ON/OFF period to date comparison",
223
223
  "type": "boolean"
224
224
  },
225
225
  "quantity": {
226
- "description": "number of periods",
226
+ "description": "Number of periods",
227
227
  "type": "number"
228
228
  },
229
229
  "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/combination-chart-options.schema.json.d.ts CHANGED
@@ -1125,7 +1125,7 @@ declare const _default: {
1125
1125
  "type": "string"
1126
1126
  },
1127
1127
  "formula": {
1128
- "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.",
1128
+ "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",
1129
1129
  "type": "string"
1130
1130
  },
1131
1131
  "grandTotals": {
@@ -1172,18 +1172,18 @@ declare const _default: {
1172
1172
  "type": "string"
1173
1173
  },
1174
1174
  "periodOverPeriod": {
1175
- "description": "Settings to configure period over period comparison",
1175
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
1176
1176
  "properties": {
1177
1177
  "level": {
1178
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
1178
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
1179
1179
  "type": "number"
1180
1180
  },
1181
1181
  "periodToDate": {
1182
- "description": "period to date comparison",
1182
+ "description": "Turn ON/OFF period to date comparison",
1183
1183
  "type": "boolean"
1184
1184
  },
1185
1185
  "quantity": {
1186
- "description": "number of periods",
1186
+ "description": "Number of periods",
1187
1187
  "type": "number"
1188
1188
  },
1189
1189
  "type": {
@@ -1336,6 +1336,67 @@ declare const _default: {
1336
1336
  },
1337
1337
  "type": "object"
1338
1338
  },
1339
+ "loader": {
1340
+ "description": "The loader configuration",
1341
+ "properties": {
1342
+ "background": {
1343
+ "default": "#f9f9f9",
1344
+ "description": "Background color of the chart loader element",
1345
+ "type": "string"
1346
+ },
1347
+ "fontColor": {
1348
+ "default": "#5a5a5a",
1349
+ "description": "Font color of the text of the chart loaders",
1350
+ "type": "string"
1351
+ },
1352
+ "locale": {
1353
+ "default": "en",
1354
+ "description": "Locale to be used if \"msg\" is set",
1355
+ "examples": [
1356
+ "en",
1357
+ "fr"
1358
+ ],
1359
+ "type": "string"
1360
+ },
1361
+ "mode": {
1362
+ "default": "light",
1363
+ "description": "Light or dark loader",
1364
+ "type": "string"
1365
+ },
1366
+ "msg": {
1367
+ "description": "Loading message",
1368
+ "examples": [
1369
+ "Loading dashboard..."
1370
+ ],
1371
+ "type": "string"
1372
+ },
1373
+ "showBranded": {
1374
+ "default": false,
1375
+ "description": "Shows the branded \"powered by\" information",
1376
+ "type": "boolean"
1377
+ },
1378
+ "spinnerBackground": {
1379
+ "default": "rgba(169, 169, 169, 0.14)",
1380
+ "description": "Background color of the spinner",
1381
+ "type": "string"
1382
+ },
1383
+ "spinnerColor": {
1384
+ "default": "rgba(255, 165, 0, 0.7)",
1385
+ "description": "Spinner color of the loader",
1386
+ "type": "string"
1387
+ }
1388
+ },
1389
+ "type": "object"
1390
+ },
1391
+ "locale": {
1392
+ "default": "en",
1393
+ "description": "Locale to be used",
1394
+ "examples": [
1395
+ "en",
1396
+ "fr"
1397
+ ],
1398
+ "type": "string"
1399
+ },
1339
1400
  "measures": {
1340
1401
  "default": [
1341
1402
  []
@@ -1947,6 +2008,14 @@ declare const _default: {
1947
2008
  },
1948
2009
  "type": "object"
1949
2010
  },
2011
+ "timezoneId": {
2012
+ "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",
2013
+ "examples": [
2014
+ "Europe/Brussels",
2015
+ "America/New_York"
2016
+ ],
2017
+ "type": "string"
2018
+ },
1950
2019
  "title": {
1951
2020
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
1952
2021
  "examples": [
package/assets/json-schemas/combination-chart-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": {
@@ -212,18 +212,18 @@ declare const _default: {
212
212
  ]
213
213
  },
214
214
  "periodOverPeriod": {
215
- "description": "Settings to configure period over period comparison",
215
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
216
216
  "properties": {
217
217
  "level": {
218
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
218
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
219
219
  "type": "number"
220
220
  },
221
221
  "periodToDate": {
222
- "description": "period to date comparison",
222
+ "description": "Turn ON/OFF period to date comparison",
223
223
  "type": "boolean"
224
224
  },
225
225
  "quantity": {
226
- "description": "number of periods",
226
+ "description": "Number of periods",
227
227
  "type": "number"
228
228
  },
229
229
  "type": {
@@ -399,7 +399,7 @@ declare const _default: {
399
399
  "type": "string"
400
400
  },
401
401
  "formula": {
402
- "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.",
402
+ "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",
403
403
  "type": "string"
404
404
  },
405
405
  "grandTotals": {
@@ -416,18 +416,18 @@ declare const _default: {
416
416
  "type": "object"
417
417
  },
418
418
  "periodOverPeriod": {
419
- "description": "Settings to configure period over period comparison",
419
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
420
420
  "properties": {
421
421
  "level": {
422
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
422
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
423
423
  "type": "number"
424
424
  },
425
425
  "periodToDate": {
426
- "description": "period to date comparison",
426
+ "description": "Turn ON/OFF period to date comparison",
427
427
  "type": "boolean"
428
428
  },
429
429
  "quantity": {
430
- "description": "number of periods",
430
+ "description": "Number of periods",
431
431
  "type": "number"
432
432
  },
433
433
  "type": {
package/assets/json-schemas/date-filter-options.schema.json.d.ts CHANGED
@@ -657,7 +657,7 @@ declare const _default: {
657
657
  "type": "string"
658
658
  },
659
659
  "formula": {
660
- "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.",
660
+ "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",
661
661
  "type": "string"
662
662
  },
663
663
  "grandTotals": {
@@ -704,18 +704,18 @@ declare const _default: {
704
704
  "type": "string"
705
705
  },
706
706
  "periodOverPeriod": {
707
- "description": "Settings to configure period over period comparison",
707
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
708
708
  "properties": {
709
709
  "level": {
710
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
710
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
711
711
  "type": "number"
712
712
  },
713
713
  "periodToDate": {
714
- "description": "period to date comparison",
714
+ "description": "Turn ON/OFF period to date comparison",
715
715
  "type": "boolean"
716
716
  },
717
717
  "quantity": {
718
- "description": "number of periods",
718
+ "description": "Number of periods",
719
719
  "type": "number"
720
720
  },
721
721
  "type": {
@@ -796,6 +796,67 @@ declare const _default: {
796
796
  },
797
797
  "type": "object"
798
798
  },
799
+ "loader": {
800
+ "description": "The loader configuration",
801
+ "properties": {
802
+ "background": {
803
+ "default": "#f9f9f9",
804
+ "description": "Background color of the chart loader element",
805
+ "type": "string"
806
+ },
807
+ "fontColor": {
808
+ "default": "#5a5a5a",
809
+ "description": "Font color of the text of the chart loaders",
810
+ "type": "string"
811
+ },
812
+ "locale": {
813
+ "default": "en",
814
+ "description": "Locale to be used if \"msg\" is set",
815
+ "examples": [
816
+ "en",
817
+ "fr"
818
+ ],
819
+ "type": "string"
820
+ },
821
+ "mode": {
822
+ "default": "light",
823
+ "description": "Light or dark loader",
824
+ "type": "string"
825
+ },
826
+ "msg": {
827
+ "description": "Loading message",
828
+ "examples": [
829
+ "Loading dashboard..."
830
+ ],
831
+ "type": "string"
832
+ },
833
+ "showBranded": {
834
+ "default": false,
835
+ "description": "Shows the branded \"powered by\" information",
836
+ "type": "boolean"
837
+ },
838
+ "spinnerBackground": {
839
+ "default": "rgba(169, 169, 169, 0.14)",
840
+ "description": "Background color of the spinner",
841
+ "type": "string"
842
+ },
843
+ "spinnerColor": {
844
+ "default": "rgba(255, 165, 0, 0.7)",
845
+ "description": "Spinner color of the loader",
846
+ "type": "string"
847
+ }
848
+ },
849
+ "type": "object"
850
+ },
851
+ "locale": {
852
+ "default": "en",
853
+ "description": "Locale to be used",
854
+ "examples": [
855
+ "en",
856
+ "fr"
857
+ ],
858
+ "type": "string"
859
+ },
799
860
  "padding": {
800
861
  "description": "Padding of the date filter",
801
862
  "properties": {
@@ -1275,6 +1336,14 @@ declare const _default: {
1275
1336
  },
1276
1337
  "type": "object"
1277
1338
  },
1339
+ "timezoneId": {
1340
+ "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",
1341
+ "examples": [
1342
+ "Europe/Brussels",
1343
+ "America/New_York"
1344
+ ],
1345
+ "type": "string"
1346
+ },
1278
1347
  "title": {
1279
1348
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
1280
1349
  "examples": [
package/assets/json-schemas/date-filter-slots.schema.json.d.ts CHANGED
@@ -88,18 +88,18 @@ declare const _default: {
88
88
  "type": "string"
89
89
  },
90
90
  "periodOverPeriod": {
91
- "description": "Settings to configure period over period comparison",
91
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
92
92
  "properties": {
93
93
  "level": {
94
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
94
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
95
95
  "type": "number"
96
96
  },
97
97
  "periodToDate": {
98
- "description": "period to date comparison",
98
+ "description": "Turn ON/OFF period to date comparison",
99
99
  "type": "boolean"
100
100
  },
101
101
  "quantity": {
102
- "description": "number of periods",
102
+ "description": "Number of periods",
103
103
  "type": "number"
104
104
  },
105
105
  "type": {
package/assets/json-schemas/donut-chart-options.schema.json.d.ts CHANGED
@@ -2756,7 +2756,7 @@ declare const _default: {
2756
2756
  "type": "string"
2757
2757
  },
2758
2758
  "formula": {
2759
- "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.",
2759
+ "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",
2760
2760
  "type": "string"
2761
2761
  },
2762
2762
  "grandTotals": {
@@ -2803,18 +2803,18 @@ declare const _default: {
2803
2803
  "type": "string"
2804
2804
  },
2805
2805
  "periodOverPeriod": {
2806
- "description": "Settings to configure period over period comparison",
2806
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
2807
2807
  "properties": {
2808
2808
  "level": {
2809
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
2809
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
2810
2810
  "type": "number"
2811
2811
  },
2812
2812
  "periodToDate": {
2813
- "description": "period to date comparison",
2813
+ "description": "Turn ON/OFF period to date comparison",
2814
2814
  "type": "boolean"
2815
2815
  },
2816
2816
  "quantity": {
2817
- "description": "number of periods",
2817
+ "description": "Number of periods",
2818
2818
  "type": "number"
2819
2819
  },
2820
2820
  "type": {
@@ -2972,6 +2972,67 @@ declare const _default: {
2972
2972
  },
2973
2973
  "type": "object"
2974
2974
  },
2975
+ "loader": {
2976
+ "description": "The loader configuration",
2977
+ "properties": {
2978
+ "background": {
2979
+ "default": "#f9f9f9",
2980
+ "description": "Background color of the chart loader element",
2981
+ "type": "string"
2982
+ },
2983
+ "fontColor": {
2984
+ "default": "#5a5a5a",
2985
+ "description": "Font color of the text of the chart loaders",
2986
+ "type": "string"
2987
+ },
2988
+ "locale": {
2989
+ "default": "en",
2990
+ "description": "Locale to be used if \"msg\" is set",
2991
+ "examples": [
2992
+ "en",
2993
+ "fr"
2994
+ ],
2995
+ "type": "string"
2996
+ },
2997
+ "mode": {
2998
+ "default": "light",
2999
+ "description": "Light or dark loader",
3000
+ "type": "string"
3001
+ },
3002
+ "msg": {
3003
+ "description": "Loading message",
3004
+ "examples": [
3005
+ "Loading dashboard..."
3006
+ ],
3007
+ "type": "string"
3008
+ },
3009
+ "showBranded": {
3010
+ "default": false,
3011
+ "description": "Shows the branded \"powered by\" information",
3012
+ "type": "boolean"
3013
+ },
3014
+ "spinnerBackground": {
3015
+ "default": "rgba(169, 169, 169, 0.14)",
3016
+ "description": "Background color of the spinner",
3017
+ "type": "string"
3018
+ },
3019
+ "spinnerColor": {
3020
+ "default": "rgba(255, 165, 0, 0.7)",
3021
+ "description": "Spinner color of the loader",
3022
+ "type": "string"
3023
+ }
3024
+ },
3025
+ "type": "object"
3026
+ },
3027
+ "locale": {
3028
+ "default": "en",
3029
+ "description": "Locale to be used",
3030
+ "examples": [
3031
+ "en",
3032
+ "fr"
3033
+ ],
3034
+ "type": "string"
3035
+ },
2975
3036
  "mode": {
2976
3037
  "default": "donut",
2977
3038
  "description": "Mode of the Donut chart: donut or pie",
@@ -3558,6 +3619,14 @@ declare const _default: {
3558
3619
  },
3559
3620
  "type": "object"
3560
3621
  },
3622
+ "timezoneId": {
3623
+ "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",
3624
+ "examples": [
3625
+ "Europe/Brussels",
3626
+ "America/New_York"
3627
+ ],
3628
+ "type": "string"
3629
+ },
3561
3630
  "title": {
3562
3631
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
3563
3632
  "examples": [
package/assets/json-schemas/donut-chart-slots.schema.json.d.ts CHANGED
@@ -127,18 +127,18 @@ declare const _default: {
127
127
  "type": "string"
128
128
  },
129
129
  "periodOverPeriod": {
130
- "description": "Settings to configure period over period comparison",
130
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
131
131
  "properties": {
132
132
  "level": {
133
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
133
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
134
134
  "type": "number"
135
135
  },
136
136
  "periodToDate": {
137
- "description": "period to date comparison",
137
+ "description": "Turn ON/OFF period to date comparison",
138
138
  "type": "boolean"
139
139
  },
140
140
  "quantity": {
141
- "description": "number of periods",
141
+ "description": "Number of periods",
142
142
  "type": "number"
143
143
  },
144
144
  "type": {
@@ -241,18 +241,18 @@ declare const _default: {
241
241
  ]
242
242
  },
243
243
  "periodOverPeriod": {
244
- "description": "Settings to configure period over period comparison",
244
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
245
245
  "properties": {
246
246
  "level": {
247
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
247
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
248
248
  "type": "number"
249
249
  },
250
250
  "periodToDate": {
251
- "description": "period to date comparison",
251
+ "description": "Turn ON/OFF period to date comparison",
252
252
  "type": "boolean"
253
253
  },
254
254
  "quantity": {
255
- "description": "number of periods",
255
+ "description": "Number of periods",
256
256
  "type": "number"
257
257
  },
258
258
  "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": {