@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/bar-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/box-plot-options.schema.json.d.ts CHANGED
@@ -926,7 +926,7 @@ declare const _default: {
926
926
  "type": "string"
927
927
  },
928
928
  "formula": {
929
- "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.",
929
+ "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",
930
930
  "type": "string"
931
931
  },
932
932
  "grandTotals": {
@@ -973,18 +973,18 @@ declare const _default: {
973
973
  "type": "string"
974
974
  },
975
975
  "periodOverPeriod": {
976
- "description": "Settings to configure period over period comparison",
976
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
977
977
  "properties": {
978
978
  "level": {
979
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
979
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
980
980
  "type": "number"
981
981
  },
982
982
  "periodToDate": {
983
- "description": "period to date comparison",
983
+ "description": "Turn ON/OFF period to date comparison",
984
984
  "type": "boolean"
985
985
  },
986
986
  "quantity": {
987
- "description": "number of periods",
987
+ "description": "Number of periods",
988
988
  "type": "number"
989
989
  },
990
990
  "type": {
@@ -1099,6 +1099,67 @@ declare const _default: {
1099
1099
  },
1100
1100
  "type": "object"
1101
1101
  },
1102
+ "loader": {
1103
+ "description": "The loader configuration",
1104
+ "properties": {
1105
+ "background": {
1106
+ "default": "#f9f9f9",
1107
+ "description": "Background color of the chart loader element",
1108
+ "type": "string"
1109
+ },
1110
+ "fontColor": {
1111
+ "default": "#5a5a5a",
1112
+ "description": "Font color of the text of the chart loaders",
1113
+ "type": "string"
1114
+ },
1115
+ "locale": {
1116
+ "default": "en",
1117
+ "description": "Locale to be used if \"msg\" is set",
1118
+ "examples": [
1119
+ "en",
1120
+ "fr"
1121
+ ],
1122
+ "type": "string"
1123
+ },
1124
+ "mode": {
1125
+ "default": "light",
1126
+ "description": "Light or dark loader",
1127
+ "type": "string"
1128
+ },
1129
+ "msg": {
1130
+ "description": "Loading message",
1131
+ "examples": [
1132
+ "Loading dashboard..."
1133
+ ],
1134
+ "type": "string"
1135
+ },
1136
+ "showBranded": {
1137
+ "default": false,
1138
+ "description": "Shows the branded \"powered by\" information",
1139
+ "type": "boolean"
1140
+ },
1141
+ "spinnerBackground": {
1142
+ "default": "rgba(169, 169, 169, 0.14)",
1143
+ "description": "Background color of the spinner",
1144
+ "type": "string"
1145
+ },
1146
+ "spinnerColor": {
1147
+ "default": "rgba(255, 165, 0, 0.7)",
1148
+ "description": "Spinner color of the loader",
1149
+ "type": "string"
1150
+ }
1151
+ },
1152
+ "type": "object"
1153
+ },
1154
+ "locale": {
1155
+ "default": "en",
1156
+ "description": "Locale to be used",
1157
+ "examples": [
1158
+ "en",
1159
+ "fr"
1160
+ ],
1161
+ "type": "string"
1162
+ },
1102
1163
  "manualAxisRange": {
1103
1164
  "description": "Manual axis range options. Minimum and maximum value of the axis range.",
1104
1165
  "items": [
@@ -1701,6 +1762,14 @@ declare const _default: {
1701
1762
  },
1702
1763
  "type": "object"
1703
1764
  },
1765
+ "timezoneId": {
1766
+ "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",
1767
+ "examples": [
1768
+ "Europe/Brussels",
1769
+ "America/New_York"
1770
+ ],
1771
+ "type": "string"
1772
+ },
1704
1773
  "title": {
1705
1774
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
1706
1775
  "examples": [
package/assets/json-schemas/box-plot-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": {
@@ -419,7 +419,7 @@ declare const _default: {
419
419
  "type": "string"
420
420
  },
421
421
  "formula": {
422
- "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.",
422
+ "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",
423
423
  "type": "string"
424
424
  },
425
425
  "grandTotals": {
@@ -436,18 +436,18 @@ declare const _default: {
436
436
  "type": "object"
437
437
  },
438
438
  "periodOverPeriod": {
439
- "description": "Settings to configure period over period comparison",
439
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
440
440
  "properties": {
441
441
  "level": {
442
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
442
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
443
443
  "type": "number"
444
444
  },
445
445
  "periodToDate": {
446
- "description": "period to date comparison",
446
+ "description": "Turn ON/OFF period to date comparison",
447
447
  "type": "boolean"
448
448
  },
449
449
  "quantity": {
450
- "description": "number of periods",
450
+ "description": "Number of periods",
451
451
  "type": "number"
452
452
  },
453
453
  "type": {
package/assets/json-schemas/bubble-chart-options.schema.json.d.ts CHANGED
@@ -2769,7 +2769,7 @@ declare const _default: {
2769
2769
  "type": "string"
2770
2770
  },
2771
2771
  "formula": {
2772
- "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.",
2772
+ "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",
2773
2773
  "type": "string"
2774
2774
  },
2775
2775
  "grandTotals": {
@@ -2816,18 +2816,18 @@ declare const _default: {
2816
2816
  "type": "string"
2817
2817
  },
2818
2818
  "periodOverPeriod": {
2819
- "description": "Settings to configure period over period comparison",
2819
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
2820
2820
  "properties": {
2821
2821
  "level": {
2822
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
2822
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
2823
2823
  "type": "number"
2824
2824
  },
2825
2825
  "periodToDate": {
2826
- "description": "period to date comparison",
2826
+ "description": "Turn ON/OFF period to date comparison",
2827
2827
  "type": "boolean"
2828
2828
  },
2829
2829
  "quantity": {
2830
- "description": "number of periods",
2830
+ "description": "Number of periods",
2831
2831
  "type": "number"
2832
2832
  },
2833
2833
  "type": {
@@ -2985,6 +2985,67 @@ declare const _default: {
2985
2985
  },
2986
2986
  "type": "object"
2987
2987
  },
2988
+ "loader": {
2989
+ "description": "The loader configuration",
2990
+ "properties": {
2991
+ "background": {
2992
+ "default": "#f9f9f9",
2993
+ "description": "Background color of the chart loader element",
2994
+ "type": "string"
2995
+ },
2996
+ "fontColor": {
2997
+ "default": "#5a5a5a",
2998
+ "description": "Font color of the text of the chart loaders",
2999
+ "type": "string"
3000
+ },
3001
+ "locale": {
3002
+ "default": "en",
3003
+ "description": "Locale to be used if \"msg\" is set",
3004
+ "examples": [
3005
+ "en",
3006
+ "fr"
3007
+ ],
3008
+ "type": "string"
3009
+ },
3010
+ "mode": {
3011
+ "default": "light",
3012
+ "description": "Light or dark loader",
3013
+ "type": "string"
3014
+ },
3015
+ "msg": {
3016
+ "description": "Loading message",
3017
+ "examples": [
3018
+ "Loading dashboard..."
3019
+ ],
3020
+ "type": "string"
3021
+ },
3022
+ "showBranded": {
3023
+ "default": false,
3024
+ "description": "Shows the branded \"powered by\" information",
3025
+ "type": "boolean"
3026
+ },
3027
+ "spinnerBackground": {
3028
+ "default": "rgba(169, 169, 169, 0.14)",
3029
+ "description": "Background color of the spinner",
3030
+ "type": "string"
3031
+ },
3032
+ "spinnerColor": {
3033
+ "default": "rgba(255, 165, 0, 0.7)",
3034
+ "description": "Spinner color of the loader",
3035
+ "type": "string"
3036
+ }
3037
+ },
3038
+ "type": "object"
3039
+ },
3040
+ "locale": {
3041
+ "default": "en",
3042
+ "description": "Locale to be used",
3043
+ "examples": [
3044
+ "en",
3045
+ "fr"
3046
+ ],
3047
+ "type": "string"
3048
+ },
2988
3049
  "theme": {
2989
3050
  "description": "Theme configuration",
2990
3051
  "properties": {
@@ -3448,6 +3509,14 @@ declare const _default: {
3448
3509
  },
3449
3510
  "type": "object"
3450
3511
  },
3512
+ "timezoneId": {
3513
+ "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",
3514
+ "examples": [
3515
+ "Europe/Brussels",
3516
+ "America/New_York"
3517
+ ],
3518
+ "type": "string"
3519
+ },
3451
3520
  "title": {
3452
3521
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
3453
3522
  "examples": [
package/assets/json-schemas/bubble-chart-slots.schema.json.d.ts CHANGED
@@ -156,18 +156,18 @@ declare const _default: {
156
156
  "type": "string"
157
157
  },
158
158
  "periodOverPeriod": {
159
- "description": "Settings to configure period over period comparison",
159
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
160
160
  "properties": {
161
161
  "level": {
162
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
162
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
163
163
  "type": "number"
164
164
  },
165
165
  "periodToDate": {
166
- "description": "period to date comparison",
166
+ "description": "Turn ON/OFF period to date comparison",
167
167
  "type": "boolean"
168
168
  },
169
169
  "quantity": {
170
- "description": "number of periods",
170
+ "description": "Number of periods",
171
171
  "type": "number"
172
172
  },
173
173
  "type": {
@@ -270,18 +270,18 @@ declare const _default: {
270
270
  ]
271
271
  },
272
272
  "periodOverPeriod": {
273
- "description": "Settings to configure period over period comparison",
273
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
274
274
  "properties": {
275
275
  "level": {
276
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
276
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
277
277
  "type": "number"
278
278
  },
279
279
  "periodToDate": {
280
- "description": "period to date comparison",
280
+ "description": "Turn ON/OFF period to date comparison",
281
281
  "type": "boolean"
282
282
  },
283
283
  "quantity": {
284
- "description": "number of periods",
284
+ "description": "Number of periods",
285
285
  "type": "number"
286
286
  },
287
287
  "type": {
@@ -458,7 +458,7 @@ declare const _default: {
458
458
  "type": "string"
459
459
  },
460
460
  "formula": {
461
- "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.",
461
+ "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",
462
462
  "type": "string"
463
463
  },
464
464
  "grandTotals": {
@@ -475,18 +475,18 @@ declare const _default: {
475
475
  "type": "object"
476
476
  },
477
477
  "periodOverPeriod": {
478
- "description": "Settings to configure period over period comparison",
478
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
479
479
  "properties": {
480
480
  "level": {
481
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
481
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
482
482
  "type": "number"
483
483
  },
484
484
  "periodToDate": {
485
- "description": "period to date comparison",
485
+ "description": "Turn ON/OFF period to date comparison",
486
486
  "type": "boolean"
487
487
  },
488
488
  "quantity": {
489
- "description": "number of periods",
489
+ "description": "Number of periods",
490
490
  "type": "number"
491
491
  },
492
492
  "type": {
package/assets/json-schemas/bullet-chart-options.schema.json.d.ts CHANGED
@@ -683,7 +683,7 @@ declare const _default: {
683
683
  "type": "string"
684
684
  },
685
685
  "formula": {
686
- "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.",
686
+ "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",
687
687
  "type": "string"
688
688
  },
689
689
  "grandTotals": {
@@ -730,18 +730,18 @@ declare const _default: {
730
730
  "type": "string"
731
731
  },
732
732
  "periodOverPeriod": {
733
- "description": "Settings to configure period over period comparison",
733
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
734
734
  "properties": {
735
735
  "level": {
736
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
736
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
737
737
  "type": "number"
738
738
  },
739
739
  "periodToDate": {
740
- "description": "period to date comparison",
740
+ "description": "Turn ON/OFF period to date comparison",
741
741
  "type": "boolean"
742
742
  },
743
743
  "quantity": {
744
- "description": "number of periods",
744
+ "description": "Number of periods",
745
745
  "type": "number"
746
746
  },
747
747
  "type": {
@@ -856,6 +856,67 @@ declare const _default: {
856
856
  },
857
857
  "type": "object"
858
858
  },
859
+ "loader": {
860
+ "description": "The loader configuration",
861
+ "properties": {
862
+ "background": {
863
+ "default": "#f9f9f9",
864
+ "description": "Background color of the chart loader element",
865
+ "type": "string"
866
+ },
867
+ "fontColor": {
868
+ "default": "#5a5a5a",
869
+ "description": "Font color of the text of the chart loaders",
870
+ "type": "string"
871
+ },
872
+ "locale": {
873
+ "default": "en",
874
+ "description": "Locale to be used if \"msg\" is set",
875
+ "examples": [
876
+ "en",
877
+ "fr"
878
+ ],
879
+ "type": "string"
880
+ },
881
+ "mode": {
882
+ "default": "light",
883
+ "description": "Light or dark loader",
884
+ "type": "string"
885
+ },
886
+ "msg": {
887
+ "description": "Loading message",
888
+ "examples": [
889
+ "Loading dashboard..."
890
+ ],
891
+ "type": "string"
892
+ },
893
+ "showBranded": {
894
+ "default": false,
895
+ "description": "Shows the branded \"powered by\" information",
896
+ "type": "boolean"
897
+ },
898
+ "spinnerBackground": {
899
+ "default": "rgba(169, 169, 169, 0.14)",
900
+ "description": "Background color of the spinner",
901
+ "type": "string"
902
+ },
903
+ "spinnerColor": {
904
+ "default": "rgba(255, 165, 0, 0.7)",
905
+ "description": "Spinner color of the loader",
906
+ "type": "string"
907
+ }
908
+ },
909
+ "type": "object"
910
+ },
911
+ "locale": {
912
+ "default": "en",
913
+ "description": "Locale to be used",
914
+ "examples": [
915
+ "en",
916
+ "fr"
917
+ ],
918
+ "type": "string"
919
+ },
859
920
  "manualValues": {
860
921
  "default": [
861
922
  []
@@ -1456,6 +1517,14 @@ declare const _default: {
1456
1517
  },
1457
1518
  "type": "object"
1458
1519
  },
1520
+ "timezoneId": {
1521
+ "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",
1522
+ "examples": [
1523
+ "Europe/Brussels",
1524
+ "America/New_York"
1525
+ ],
1526
+ "type": "string"
1527
+ },
1459
1528
  "title": {
1460
1529
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
1461
1530
  "examples": [