@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
@@ -126,18 +126,18 @@ declare const _default: {
126
126
  "type": "string"
127
127
  },
128
128
  "periodOverPeriod": {
129
- "description": "Settings to configure period over period comparison",
129
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
130
130
  "properties": {
131
131
  "level": {
132
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
132
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
133
133
  "type": "number"
134
134
  },
135
135
  "periodToDate": {
136
- "description": "period to date comparison",
136
+ "description": "Turn ON/OFF period to date comparison",
137
137
  "type": "boolean"
138
138
  },
139
139
  "quantity": {
140
- "description": "number of periods",
140
+ "description": "Number of periods",
141
141
  "type": "number"
142
142
  },
143
143
  "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": {
@@ -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": {
@@ -706,7 +706,7 @@ declare const _default: {
706
706
  "type": "string"
707
707
  },
708
708
  "formula": {
709
- "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.",
709
+ "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",
710
710
  "type": "string"
711
711
  },
712
712
  "grandTotals": {
@@ -753,18 +753,18 @@ declare const _default: {
753
753
  "type": "string"
754
754
  },
755
755
  "periodOverPeriod": {
756
- "description": "Settings to configure period over period comparison",
756
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
757
757
  "properties": {
758
758
  "level": {
759
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
759
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
760
760
  "type": "number"
761
761
  },
762
762
  "periodToDate": {
763
- "description": "period to date comparison",
763
+ "description": "Turn ON/OFF period to date comparison",
764
764
  "type": "boolean"
765
765
  },
766
766
  "quantity": {
767
- "description": "number of periods",
767
+ "description": "Number of periods",
768
768
  "type": "number"
769
769
  },
770
770
  "type": {
@@ -911,6 +911,67 @@ declare const _default: {
911
911
  },
912
912
  "type": "object"
913
913
  },
914
+ "loader": {
915
+ "description": "The loader configuration",
916
+ "properties": {
917
+ "background": {
918
+ "default": "#f9f9f9",
919
+ "description": "Background color of the chart loader element",
920
+ "type": "string"
921
+ },
922
+ "fontColor": {
923
+ "default": "#5a5a5a",
924
+ "description": "Font color of the text of the chart loaders",
925
+ "type": "string"
926
+ },
927
+ "locale": {
928
+ "default": "en",
929
+ "description": "Locale to be used if \"msg\" is set",
930
+ "examples": [
931
+ "en",
932
+ "fr"
933
+ ],
934
+ "type": "string"
935
+ },
936
+ "mode": {
937
+ "default": "light",
938
+ "description": "Light or dark loader",
939
+ "type": "string"
940
+ },
941
+ "msg": {
942
+ "description": "Loading message",
943
+ "examples": [
944
+ "Loading dashboard..."
945
+ ],
946
+ "type": "string"
947
+ },
948
+ "showBranded": {
949
+ "default": false,
950
+ "description": "Shows the branded \"powered by\" information",
951
+ "type": "boolean"
952
+ },
953
+ "spinnerBackground": {
954
+ "default": "rgba(169, 169, 169, 0.14)",
955
+ "description": "Background color of the spinner",
956
+ "type": "string"
957
+ },
958
+ "spinnerColor": {
959
+ "default": "rgba(255, 165, 0, 0.7)",
960
+ "description": "Spinner color of the loader",
961
+ "type": "string"
962
+ }
963
+ },
964
+ "type": "object"
965
+ },
966
+ "locale": {
967
+ "default": "en",
968
+ "description": "Locale to be used",
969
+ "examples": [
970
+ "en",
971
+ "fr"
972
+ ],
973
+ "type": "string"
974
+ },
914
975
  "nodeSorting": {
915
976
  "description": "Set node sorting, ascending or descending (asc, dsc)",
916
977
  "enum": [
@@ -1393,6 +1454,14 @@ declare const _default: {
1393
1454
  },
1394
1455
  "type": "object"
1395
1456
  },
1457
+ "timezoneId": {
1458
+ "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",
1459
+ "examples": [
1460
+ "Europe/Brussels",
1461
+ "America/New_York"
1462
+ ],
1463
+ "type": "string"
1464
+ },
1396
1465
  "title": {
1397
1466
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
1398
1467
  "examples": [
@@ -126,18 +126,18 @@ declare const _default: {
126
126
  "type": "string"
127
127
  },
128
128
  "periodOverPeriod": {
129
- "description": "Settings to configure period over period comparison",
129
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
130
130
  "properties": {
131
131
  "level": {
132
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
132
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
133
133
  "type": "number"
134
134
  },
135
135
  "periodToDate": {
136
- "description": "period to date comparison",
136
+ "description": "Turn ON/OFF period to date comparison",
137
137
  "type": "boolean"
138
138
  },
139
139
  "quantity": {
140
- "description": "number of periods",
140
+ "description": "Number of periods",
141
141
  "type": "number"
142
142
  },
143
143
  "type": {
@@ -269,18 +269,18 @@ declare const _default: {
269
269
  ]
270
270
  },
271
271
  "periodOverPeriod": {
272
- "description": "Settings to configure period over period comparison",
272
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
273
273
  "properties": {
274
274
  "level": {
275
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
275
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
276
276
  "type": "number"
277
277
  },
278
278
  "periodToDate": {
279
- "description": "period to date comparison",
279
+ "description": "Turn ON/OFF period to date comparison",
280
280
  "type": "boolean"
281
281
  },
282
282
  "quantity": {
283
- "description": "number of periods",
283
+ "description": "Number of periods",
284
284
  "type": "number"
285
285
  },
286
286
  "type": {
@@ -457,7 +457,7 @@ declare const _default: {
457
457
  "type": "string"
458
458
  },
459
459
  "formula": {
460
- "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.",
460
+ "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",
461
461
  "type": "string"
462
462
  },
463
463
  "grandTotals": {
@@ -474,18 +474,18 @@ declare const _default: {
474
474
  "type": "object"
475
475
  },
476
476
  "periodOverPeriod": {
477
- "description": "Settings to configure period over period comparison",
477
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
478
478
  "properties": {
479
479
  "level": {
480
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
480
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
481
481
  "type": "number"
482
482
  },
483
483
  "periodToDate": {
484
- "description": "period to date comparison",
484
+ "description": "Turn ON/OFF period to date comparison",
485
485
  "type": "boolean"
486
486
  },
487
487
  "quantity": {
488
- "description": "number of periods",
488
+ "description": "Number of periods",
489
489
  "type": "number"
490
490
  },
491
491
  "type": {
@@ -992,7 +992,7 @@ declare const _default: {
992
992
  "type": "string"
993
993
  },
994
994
  "formula": {
995
- "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.",
995
+ "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",
996
996
  "type": "string"
997
997
  },
998
998
  "grandTotals": {
@@ -1039,18 +1039,18 @@ declare const _default: {
1039
1039
  "type": "string"
1040
1040
  },
1041
1041
  "periodOverPeriod": {
1042
- "description": "Settings to configure period over period comparison",
1042
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
1043
1043
  "properties": {
1044
1044
  "level": {
1045
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
1045
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
1046
1046
  "type": "number"
1047
1047
  },
1048
1048
  "periodToDate": {
1049
- "description": "period to date comparison",
1049
+ "description": "Turn ON/OFF period to date comparison",
1050
1050
  "type": "boolean"
1051
1051
  },
1052
1052
  "quantity": {
1053
- "description": "number of periods",
1053
+ "description": "Number of periods",
1054
1054
  "type": "number"
1055
1055
  },
1056
1056
  "type": {
@@ -1203,6 +1203,67 @@ declare const _default: {
1203
1203
  },
1204
1204
  "type": "object"
1205
1205
  },
1206
+ "loader": {
1207
+ "description": "The loader configuration",
1208
+ "properties": {
1209
+ "background": {
1210
+ "default": "#f9f9f9",
1211
+ "description": "Background color of the chart loader element",
1212
+ "type": "string"
1213
+ },
1214
+ "fontColor": {
1215
+ "default": "#5a5a5a",
1216
+ "description": "Font color of the text of the chart loaders",
1217
+ "type": "string"
1218
+ },
1219
+ "locale": {
1220
+ "default": "en",
1221
+ "description": "Locale to be used if \"msg\" is set",
1222
+ "examples": [
1223
+ "en",
1224
+ "fr"
1225
+ ],
1226
+ "type": "string"
1227
+ },
1228
+ "mode": {
1229
+ "default": "light",
1230
+ "description": "Light or dark loader",
1231
+ "type": "string"
1232
+ },
1233
+ "msg": {
1234
+ "description": "Loading message",
1235
+ "examples": [
1236
+ "Loading dashboard..."
1237
+ ],
1238
+ "type": "string"
1239
+ },
1240
+ "showBranded": {
1241
+ "default": false,
1242
+ "description": "Shows the branded \"powered by\" information",
1243
+ "type": "boolean"
1244
+ },
1245
+ "spinnerBackground": {
1246
+ "default": "rgba(169, 169, 169, 0.14)",
1247
+ "description": "Background color of the spinner",
1248
+ "type": "string"
1249
+ },
1250
+ "spinnerColor": {
1251
+ "default": "rgba(255, 165, 0, 0.7)",
1252
+ "description": "Spinner color of the loader",
1253
+ "type": "string"
1254
+ }
1255
+ },
1256
+ "type": "object"
1257
+ },
1258
+ "locale": {
1259
+ "default": "en",
1260
+ "description": "Locale to be used",
1261
+ "examples": [
1262
+ "en",
1263
+ "fr"
1264
+ ],
1265
+ "type": "string"
1266
+ },
1206
1267
  "manualAxesRange": {
1207
1268
  "description": "Set manual axes range",
1208
1269
  "properties": {
@@ -1712,6 +1773,14 @@ declare const _default: {
1712
1773
  },
1713
1774
  "type": "object"
1714
1775
  },
1776
+ "timezoneId": {
1777
+ "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",
1778
+ "examples": [
1779
+ "Europe/Brussels",
1780
+ "America/New_York"
1781
+ ],
1782
+ "type": "string"
1783
+ },
1715
1784
  "title": {
1716
1785
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
1717
1786
  "examples": [
@@ -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": {
@@ -582,7 +582,7 @@ declare const _default: {
582
582
  "type": "string"
583
583
  },
584
584
  "formula": {
585
- "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.",
585
+ "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",
586
586
  "type": "string"
587
587
  },
588
588
  "grandTotals": {
@@ -629,18 +629,18 @@ declare const _default: {
629
629
  "type": "string"
630
630
  },
631
631
  "periodOverPeriod": {
632
- "description": "Settings to configure period over period comparison",
632
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
633
633
  "properties": {
634
634
  "level": {
635
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
635
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
636
636
  "type": "number"
637
637
  },
638
638
  "periodToDate": {
639
- "description": "period to date comparison",
639
+ "description": "Turn ON/OFF period to date comparison",
640
640
  "type": "boolean"
641
641
  },
642
642
  "quantity": {
643
- "description": "number of periods",
643
+ "description": "Number of periods",
644
644
  "type": "number"
645
645
  },
646
646
  "type": {
@@ -749,6 +749,67 @@ declare const _default: {
749
749
  },
750
750
  "type": "object"
751
751
  },
752
+ "loader": {
753
+ "description": "The loader configuration",
754
+ "properties": {
755
+ "background": {
756
+ "default": "#f9f9f9",
757
+ "description": "Background color of the chart loader element",
758
+ "type": "string"
759
+ },
760
+ "fontColor": {
761
+ "default": "#5a5a5a",
762
+ "description": "Font color of the text of the chart loaders",
763
+ "type": "string"
764
+ },
765
+ "locale": {
766
+ "default": "en",
767
+ "description": "Locale to be used if \"msg\" is set",
768
+ "examples": [
769
+ "en",
770
+ "fr"
771
+ ],
772
+ "type": "string"
773
+ },
774
+ "mode": {
775
+ "default": "light",
776
+ "description": "Light or dark loader",
777
+ "type": "string"
778
+ },
779
+ "msg": {
780
+ "description": "Loading message",
781
+ "examples": [
782
+ "Loading dashboard..."
783
+ ],
784
+ "type": "string"
785
+ },
786
+ "showBranded": {
787
+ "default": false,
788
+ "description": "Shows the branded \"powered by\" information",
789
+ "type": "boolean"
790
+ },
791
+ "spinnerBackground": {
792
+ "default": "rgba(169, 169, 169, 0.14)",
793
+ "description": "Background color of the spinner",
794
+ "type": "string"
795
+ },
796
+ "spinnerColor": {
797
+ "default": "rgba(255, 165, 0, 0.7)",
798
+ "description": "Spinner color of the loader",
799
+ "type": "string"
800
+ }
801
+ },
802
+ "type": "object"
803
+ },
804
+ "locale": {
805
+ "default": "en",
806
+ "description": "Locale to be used",
807
+ "examples": [
808
+ "en",
809
+ "fr"
810
+ ],
811
+ "type": "string"
812
+ },
752
813
  "manualMeasureRange": {
753
814
  "default": [
754
815
  []
@@ -1462,6 +1523,14 @@ declare const _default: {
1462
1523
  },
1463
1524
  "type": "object"
1464
1525
  },
1526
+ "timezoneId": {
1527
+ "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",
1528
+ "examples": [
1529
+ "Europe/Brussels",
1530
+ "America/New_York"
1531
+ ],
1532
+ "type": "string"
1533
+ },
1465
1534
  "title": {
1466
1535
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
1467
1536
  "examples": [