@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/image-options.schema.json.d.ts CHANGED
@@ -84,6 +84,67 @@ declare const _default: {
84
84
  },
85
85
  "type": "object"
86
86
  },
87
+ "loader": {
88
+ "description": "The loader configuration",
89
+ "properties": {
90
+ "background": {
91
+ "default": "#f9f9f9",
92
+ "description": "Background color of the chart loader element",
93
+ "type": "string"
94
+ },
95
+ "fontColor": {
96
+ "default": "#5a5a5a",
97
+ "description": "Font color of the text of the chart loaders",
98
+ "type": "string"
99
+ },
100
+ "locale": {
101
+ "default": "en",
102
+ "description": "Locale to be used if \"msg\" is set",
103
+ "examples": [
104
+ "en",
105
+ "fr"
106
+ ],
107
+ "type": "string"
108
+ },
109
+ "mode": {
110
+ "default": "light",
111
+ "description": "Light or dark loader",
112
+ "type": "string"
113
+ },
114
+ "msg": {
115
+ "description": "Loading message",
116
+ "examples": [
117
+ "Loading dashboard..."
118
+ ],
119
+ "type": "string"
120
+ },
121
+ "showBranded": {
122
+ "default": false,
123
+ "description": "Shows the branded \"powered by\" information",
124
+ "type": "boolean"
125
+ },
126
+ "spinnerBackground": {
127
+ "default": "rgba(169, 169, 169, 0.14)",
128
+ "description": "Background color of the spinner",
129
+ "type": "string"
130
+ },
131
+ "spinnerColor": {
132
+ "default": "rgba(255, 165, 0, 0.7)",
133
+ "description": "Spinner color of the loader",
134
+ "type": "string"
135
+ }
136
+ },
137
+ "type": "object"
138
+ },
139
+ "locale": {
140
+ "default": "en",
141
+ "description": "Locale to be used",
142
+ "examples": [
143
+ "en",
144
+ "fr"
145
+ ],
146
+ "type": "string"
147
+ },
87
148
  "mode": {
88
149
  "default": "fill",
89
150
  "description": "Image mode: noResize, fit, fitHorizontal, fitVertical, fill, stretch",
@@ -560,6 +621,14 @@ declare const _default: {
560
621
  },
561
622
  "type": "object"
562
623
  },
624
+ "timezoneId": {
625
+ "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",
626
+ "examples": [
627
+ "Europe/Brussels",
628
+ "America/New_York"
629
+ ],
630
+ "type": "string"
631
+ },
563
632
  "title": {
564
633
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
565
634
  "examples": [
package/assets/json-schemas/line-chart-options.schema.json.d.ts CHANGED
@@ -1122,7 +1122,7 @@ declare const _default: {
1122
1122
  "type": "string"
1123
1123
  },
1124
1124
  "formula": {
1125
- "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.",
1125
+ "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",
1126
1126
  "type": "string"
1127
1127
  },
1128
1128
  "grandTotals": {
@@ -1169,18 +1169,18 @@ declare const _default: {
1169
1169
  "type": "string"
1170
1170
  },
1171
1171
  "periodOverPeriod": {
1172
- "description": "Settings to configure period over period comparison",
1172
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
1173
1173
  "properties": {
1174
1174
  "level": {
1175
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
1175
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
1176
1176
  "type": "number"
1177
1177
  },
1178
1178
  "periodToDate": {
1179
- "description": "period to date comparison",
1179
+ "description": "Turn ON/OFF period to date comparison",
1180
1180
  "type": "boolean"
1181
1181
  },
1182
1182
  "quantity": {
1183
- "description": "number of periods",
1183
+ "description": "Number of periods",
1184
1184
  "type": "number"
1185
1185
  },
1186
1186
  "type": {
@@ -1364,6 +1364,67 @@ declare const _default: {
1364
1364
  },
1365
1365
  "type": "object"
1366
1366
  },
1367
+ "loader": {
1368
+ "description": "The loader configuration",
1369
+ "properties": {
1370
+ "background": {
1371
+ "default": "#f9f9f9",
1372
+ "description": "Background color of the chart loader element",
1373
+ "type": "string"
1374
+ },
1375
+ "fontColor": {
1376
+ "default": "#5a5a5a",
1377
+ "description": "Font color of the text of the chart loaders",
1378
+ "type": "string"
1379
+ },
1380
+ "locale": {
1381
+ "default": "en",
1382
+ "description": "Locale to be used if \"msg\" is set",
1383
+ "examples": [
1384
+ "en",
1385
+ "fr"
1386
+ ],
1387
+ "type": "string"
1388
+ },
1389
+ "mode": {
1390
+ "default": "light",
1391
+ "description": "Light or dark loader",
1392
+ "type": "string"
1393
+ },
1394
+ "msg": {
1395
+ "description": "Loading message",
1396
+ "examples": [
1397
+ "Loading dashboard..."
1398
+ ],
1399
+ "type": "string"
1400
+ },
1401
+ "showBranded": {
1402
+ "default": false,
1403
+ "description": "Shows the branded \"powered by\" information",
1404
+ "type": "boolean"
1405
+ },
1406
+ "spinnerBackground": {
1407
+ "default": "rgba(169, 169, 169, 0.14)",
1408
+ "description": "Background color of the spinner",
1409
+ "type": "string"
1410
+ },
1411
+ "spinnerColor": {
1412
+ "default": "rgba(255, 165, 0, 0.7)",
1413
+ "description": "Spinner color of the loader",
1414
+ "type": "string"
1415
+ }
1416
+ },
1417
+ "type": "object"
1418
+ },
1419
+ "locale": {
1420
+ "default": "en",
1421
+ "description": "Locale to be used",
1422
+ "examples": [
1423
+ "en",
1424
+ "fr"
1425
+ ],
1426
+ "type": "string"
1427
+ },
1367
1428
  "markers": {
1368
1429
  "description": "Markers options",
1369
1430
  "properties": {
@@ -1868,6 +1929,14 @@ declare const _default: {
1868
1929
  },
1869
1930
  "type": "object"
1870
1931
  },
1932
+ "timezoneId": {
1933
+ "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",
1934
+ "examples": [
1935
+ "Europe/Brussels",
1936
+ "America/New_York"
1937
+ ],
1938
+ "type": "string"
1939
+ },
1871
1940
  "title": {
1872
1941
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
1873
1942
  "examples": [
package/assets/json-schemas/line-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/options.schema.json.d.ts CHANGED
@@ -70,6 +70,9 @@ declare const _default: {
70
70
  },
71
71
  {
72
72
  "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/text-options.schema.json"
73
+ },
74
+ {
75
+ "$ref": "https://developer.luzmo.com/assets/json-schemas/0.1.89/search-filter-options.schema.json"
73
76
  }
74
77
  ]
75
78
  };
package/assets/json-schemas/pivot-table-options.schema.json.d.ts CHANGED
@@ -736,7 +736,7 @@ declare const _default: {
736
736
  "type": "string"
737
737
  },
738
738
  "formula": {
739
- "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.",
739
+ "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",
740
740
  "type": "string"
741
741
  },
742
742
  "grandTotals": {
@@ -783,18 +783,18 @@ declare const _default: {
783
783
  "type": "string"
784
784
  },
785
785
  "periodOverPeriod": {
786
- "description": "Settings to configure period over period comparison",
786
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
787
787
  "properties": {
788
788
  "level": {
789
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
789
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
790
790
  "type": "number"
791
791
  },
792
792
  "periodToDate": {
793
- "description": "period to date comparison",
793
+ "description": "Turn ON/OFF period to date comparison",
794
794
  "type": "boolean"
795
795
  },
796
796
  "quantity": {
797
- "description": "number of periods",
797
+ "description": "Number of periods",
798
798
  "type": "number"
799
799
  },
800
800
  "type": {
@@ -933,6 +933,67 @@ declare const _default: {
933
933
  ],
934
934
  "description": "Show number of observations"
935
935
  },
936
+ "loader": {
937
+ "description": "The loader configuration",
938
+ "properties": {
939
+ "background": {
940
+ "default": "#f9f9f9",
941
+ "description": "Background color of the chart loader element",
942
+ "type": "string"
943
+ },
944
+ "fontColor": {
945
+ "default": "#5a5a5a",
946
+ "description": "Font color of the text of the chart loaders",
947
+ "type": "string"
948
+ },
949
+ "locale": {
950
+ "default": "en",
951
+ "description": "Locale to be used if \"msg\" is set",
952
+ "examples": [
953
+ "en",
954
+ "fr"
955
+ ],
956
+ "type": "string"
957
+ },
958
+ "mode": {
959
+ "default": "light",
960
+ "description": "Light or dark loader",
961
+ "type": "string"
962
+ },
963
+ "msg": {
964
+ "description": "Loading message",
965
+ "examples": [
966
+ "Loading dashboard..."
967
+ ],
968
+ "type": "string"
969
+ },
970
+ "showBranded": {
971
+ "default": false,
972
+ "description": "Shows the branded \"powered by\" information",
973
+ "type": "boolean"
974
+ },
975
+ "spinnerBackground": {
976
+ "default": "rgba(169, 169, 169, 0.14)",
977
+ "description": "Background color of the spinner",
978
+ "type": "string"
979
+ },
980
+ "spinnerColor": {
981
+ "default": "rgba(255, 165, 0, 0.7)",
982
+ "description": "Spinner color of the loader",
983
+ "type": "string"
984
+ }
985
+ },
986
+ "type": "object"
987
+ },
988
+ "locale": {
989
+ "default": "en",
990
+ "description": "Locale to be used",
991
+ "examples": [
992
+ "en",
993
+ "fr"
994
+ ],
995
+ "type": "string"
996
+ },
936
997
  "measureLabelsAxis": {
937
998
  "default": "columns",
938
999
  "description": "Measure axis labels",
@@ -1514,6 +1575,14 @@ declare const _default: {
1514
1575
  },
1515
1576
  "type": "object"
1516
1577
  },
1578
+ "timezoneId": {
1579
+ "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",
1580
+ "examples": [
1581
+ "Europe/Brussels",
1582
+ "America/New_York"
1583
+ ],
1584
+ "type": "string"
1585
+ },
1517
1586
  "title": {
1518
1587
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
1519
1588
  "examples": [
package/assets/json-schemas/pivot-table-slots.schema.json.d.ts CHANGED
@@ -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": {
@@ -427,7 +427,7 @@ declare const _default: {
427
427
  "type": "string"
428
428
  },
429
429
  "formula": {
430
- "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.",
430
+ "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",
431
431
  "type": "string"
432
432
  },
433
433
  "grandTotals": {
@@ -444,18 +444,18 @@ declare const _default: {
444
444
  "type": "object"
445
445
  },
446
446
  "periodOverPeriod": {
447
- "description": "Settings to configure period over period comparison",
447
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
448
448
  "properties": {
449
449
  "level": {
450
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
450
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
451
451
  "type": "number"
452
452
  },
453
453
  "periodToDate": {
454
- "description": "period to date comparison",
454
+ "description": "Turn ON/OFF period to date comparison",
455
455
  "type": "boolean"
456
456
  },
457
457
  "quantity": {
458
- "description": "number of periods",
458
+ "description": "Number of periods",
459
459
  "type": "number"
460
460
  },
461
461
  "type": {
package/assets/json-schemas/regular-table-options.schema.json.d.ts CHANGED
@@ -803,7 +803,7 @@ declare const _default: {
803
803
  "type": "string"
804
804
  },
805
805
  "formula": {
806
- "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.",
806
+ "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",
807
807
  "type": "string"
808
808
  },
809
809
  "grandTotals": {
@@ -850,18 +850,18 @@ declare const _default: {
850
850
  "type": "string"
851
851
  },
852
852
  "periodOverPeriod": {
853
- "description": "Settings to configure period over period comparison",
853
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
854
854
  "properties": {
855
855
  "level": {
856
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
856
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
857
857
  "type": "number"
858
858
  },
859
859
  "periodToDate": {
860
- "description": "period to date comparison",
860
+ "description": "Turn ON/OFF period to date comparison",
861
861
  "type": "boolean"
862
862
  },
863
863
  "quantity": {
864
- "description": "number of periods",
864
+ "description": "Number of periods",
865
865
  "type": "number"
866
866
  },
867
867
  "type": {
@@ -976,6 +976,67 @@ declare const _default: {
976
976
  },
977
977
  "type": "object"
978
978
  },
979
+ "loader": {
980
+ "description": "The loader configuration",
981
+ "properties": {
982
+ "background": {
983
+ "default": "#f9f9f9",
984
+ "description": "Background color of the chart loader element",
985
+ "type": "string"
986
+ },
987
+ "fontColor": {
988
+ "default": "#5a5a5a",
989
+ "description": "Font color of the text of the chart loaders",
990
+ "type": "string"
991
+ },
992
+ "locale": {
993
+ "default": "en",
994
+ "description": "Locale to be used if \"msg\" is set",
995
+ "examples": [
996
+ "en",
997
+ "fr"
998
+ ],
999
+ "type": "string"
1000
+ },
1001
+ "mode": {
1002
+ "default": "light",
1003
+ "description": "Light or dark loader",
1004
+ "type": "string"
1005
+ },
1006
+ "msg": {
1007
+ "description": "Loading message",
1008
+ "examples": [
1009
+ "Loading dashboard..."
1010
+ ],
1011
+ "type": "string"
1012
+ },
1013
+ "showBranded": {
1014
+ "default": false,
1015
+ "description": "Shows the branded \"powered by\" information",
1016
+ "type": "boolean"
1017
+ },
1018
+ "spinnerBackground": {
1019
+ "default": "rgba(169, 169, 169, 0.14)",
1020
+ "description": "Background color of the spinner",
1021
+ "type": "string"
1022
+ },
1023
+ "spinnerColor": {
1024
+ "default": "rgba(255, 165, 0, 0.7)",
1025
+ "description": "Spinner color of the loader",
1026
+ "type": "string"
1027
+ }
1028
+ },
1029
+ "type": "object"
1030
+ },
1031
+ "locale": {
1032
+ "default": "en",
1033
+ "description": "Locale to be used",
1034
+ "examples": [
1035
+ "en",
1036
+ "fr"
1037
+ ],
1038
+ "type": "string"
1039
+ },
979
1040
  "rowHeight": {
980
1041
  "default": 28,
981
1042
  "description": "Row height",
@@ -1574,6 +1635,14 @@ declare const _default: {
1574
1635
  },
1575
1636
  "type": "object"
1576
1637
  },
1638
+ "timezoneId": {
1639
+ "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",
1640
+ "examples": [
1641
+ "Europe/Brussels",
1642
+ "America/New_York"
1643
+ ],
1644
+ "type": "string"
1645
+ },
1577
1646
  "title": {
1578
1647
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
1579
1648
  "examples": [