@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/bullet-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": {
@@ -429,7 +429,7 @@ declare const _default: {
429
429
  "type": "string"
430
430
  },
431
431
  "formula": {
432
- "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.",
432
+ "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",
433
433
  "type": "string"
434
434
  },
435
435
  "grandTotals": {
@@ -446,18 +446,18 @@ declare const _default: {
446
446
  "type": "object"
447
447
  },
448
448
  "periodOverPeriod": {
449
- "description": "Settings to configure period over period comparison",
449
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
450
450
  "properties": {
451
451
  "level": {
452
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
452
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
453
453
  "type": "number"
454
454
  },
455
455
  "periodToDate": {
456
- "description": "period to date comparison",
456
+ "description": "Turn ON/OFF period to date comparison",
457
457
  "type": "boolean"
458
458
  },
459
459
  "quantity": {
460
- "description": "number of periods",
460
+ "description": "Number of periods",
461
461
  "type": "number"
462
462
  },
463
463
  "type": {
package/assets/json-schemas/choropleth-map-options.schema.json.d.ts CHANGED
@@ -733,7 +733,7 @@ declare const _default: {
733
733
  "type": "string"
734
734
  },
735
735
  "formula": {
736
- "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.",
736
+ "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",
737
737
  "type": "string"
738
738
  },
739
739
  "grandTotals": {
@@ -780,18 +780,18 @@ declare const _default: {
780
780
  "type": "string"
781
781
  },
782
782
  "periodOverPeriod": {
783
- "description": "Settings to configure period over period comparison",
783
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
784
784
  "properties": {
785
785
  "level": {
786
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
786
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
787
787
  "type": "number"
788
788
  },
789
789
  "periodToDate": {
790
- "description": "period to date comparison",
790
+ "description": "Turn ON/OFF period to date comparison",
791
791
  "type": "boolean"
792
792
  },
793
793
  "quantity": {
794
- "description": "number of periods",
794
+ "description": "Number of periods",
795
795
  "type": "number"
796
796
  },
797
797
  "type": {
@@ -949,6 +949,67 @@ declare const _default: {
949
949
  },
950
950
  "type": "object"
951
951
  },
952
+ "loader": {
953
+ "description": "The loader configuration",
954
+ "properties": {
955
+ "background": {
956
+ "default": "#f9f9f9",
957
+ "description": "Background color of the chart loader element",
958
+ "type": "string"
959
+ },
960
+ "fontColor": {
961
+ "default": "#5a5a5a",
962
+ "description": "Font color of the text of the chart loaders",
963
+ "type": "string"
964
+ },
965
+ "locale": {
966
+ "default": "en",
967
+ "description": "Locale to be used if \"msg\" is set",
968
+ "examples": [
969
+ "en",
970
+ "fr"
971
+ ],
972
+ "type": "string"
973
+ },
974
+ "mode": {
975
+ "default": "light",
976
+ "description": "Light or dark loader",
977
+ "type": "string"
978
+ },
979
+ "msg": {
980
+ "description": "Loading message",
981
+ "examples": [
982
+ "Loading dashboard..."
983
+ ],
984
+ "type": "string"
985
+ },
986
+ "showBranded": {
987
+ "default": false,
988
+ "description": "Shows the branded \"powered by\" information",
989
+ "type": "boolean"
990
+ },
991
+ "spinnerBackground": {
992
+ "default": "rgba(169, 169, 169, 0.14)",
993
+ "description": "Background color of the spinner",
994
+ "type": "string"
995
+ },
996
+ "spinnerColor": {
997
+ "default": "rgba(255, 165, 0, 0.7)",
998
+ "description": "Spinner color of the loader",
999
+ "type": "string"
1000
+ }
1001
+ },
1002
+ "type": "object"
1003
+ },
1004
+ "locale": {
1005
+ "default": "en",
1006
+ "description": "Locale to be used",
1007
+ "examples": [
1008
+ "en",
1009
+ "fr"
1010
+ ],
1011
+ "type": "string"
1012
+ },
952
1013
  "manualValues": {
953
1014
  "default": [
954
1015
  []
@@ -1537,6 +1598,14 @@ declare const _default: {
1537
1598
  },
1538
1599
  "type": "object"
1539
1600
  },
1601
+ "timezoneId": {
1602
+ "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",
1603
+ "examples": [
1604
+ "Europe/Brussels",
1605
+ "America/New_York"
1606
+ ],
1607
+ "type": "string"
1608
+ },
1540
1609
  "title": {
1541
1610
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
1542
1611
  "examples": [
package/assets/json-schemas/choropleth-map-slots.schema.json.d.ts CHANGED
@@ -124,18 +124,18 @@ declare const _default: {
124
124
  "type": "string"
125
125
  },
126
126
  "periodOverPeriod": {
127
- "description": "Settings to configure period over period comparison",
127
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
128
128
  "properties": {
129
129
  "level": {
130
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
130
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
131
131
  "type": "number"
132
132
  },
133
133
  "periodToDate": {
134
- "description": "period to date comparison",
134
+ "description": "Turn ON/OFF period to date comparison",
135
135
  "type": "boolean"
136
136
  },
137
137
  "quantity": {
138
- "description": "number of periods",
138
+ "description": "Number of periods",
139
139
  "type": "number"
140
140
  },
141
141
  "type": {
@@ -257,18 +257,18 @@ declare const _default: {
257
257
  ]
258
258
  },
259
259
  "periodOverPeriod": {
260
- "description": "Settings to configure period over period comparison",
260
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
261
261
  "properties": {
262
262
  "level": {
263
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
263
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
264
264
  "type": "number"
265
265
  },
266
266
  "periodToDate": {
267
- "description": "period to date comparison",
267
+ "description": "Turn ON/OFF period to date comparison",
268
268
  "type": "boolean"
269
269
  },
270
270
  "quantity": {
271
- "description": "number of periods",
271
+ "description": "Number of periods",
272
272
  "type": "number"
273
273
  },
274
274
  "type": {
@@ -445,7 +445,7 @@ declare const _default: {
445
445
  "type": "string"
446
446
  },
447
447
  "formula": {
448
- "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.",
448
+ "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",
449
449
  "type": "string"
450
450
  },
451
451
  "grandTotals": {
@@ -462,18 +462,18 @@ declare const _default: {
462
462
  "type": "object"
463
463
  },
464
464
  "periodOverPeriod": {
465
- "description": "Settings to configure period over period comparison",
465
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
466
466
  "properties": {
467
467
  "level": {
468
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
468
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
469
469
  "type": "number"
470
470
  },
471
471
  "periodToDate": {
472
- "description": "period to date comparison",
472
+ "description": "Turn ON/OFF period to date comparison",
473
473
  "type": "boolean"
474
474
  },
475
475
  "quantity": {
476
- "description": "number of periods",
476
+ "description": "Number of periods",
477
477
  "type": "number"
478
478
  },
479
479
  "type": {
@@ -543,33 +543,6 @@ declare const _default: {
543
543
  "description": "Label in format {locale: \"label\"}, for example, {en: \"Total Revenue\"}",
544
544
  "type": "object"
545
545
  },
546
- "periodOverPeriod": {
547
- "description": "Settings to configure period over period comparison",
548
- "properties": {
549
- "level": {
550
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
551
- "type": "number"
552
- },
553
- "periodToDate": {
554
- "description": "period to date comparison",
555
- "type": "boolean"
556
- },
557
- "quantity": {
558
- "description": "number of periods",
559
- "type": "number"
560
- },
561
- "type": {
562
- "description": "Period over period comparison type:\n'none' - turned off,\n'past' - absolute value comparison to the past,\n'change' - percentage change comparison to the past",
563
- "enum": [
564
- "change",
565
- "none",
566
- "past"
567
- ],
568
- "type": "string"
569
- }
570
- },
571
- "type": "object"
572
- },
573
546
  "subtype": {
574
547
  "anyOf": [
575
548
  {
package/assets/json-schemas/circular-gauge-options.schema.json.d.ts CHANGED
@@ -730,7 +730,7 @@ declare const _default: {
730
730
  "type": "string"
731
731
  },
732
732
  "formula": {
733
- "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.",
733
+ "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",
734
734
  "type": "string"
735
735
  },
736
736
  "grandTotals": {
@@ -777,18 +777,18 @@ declare const _default: {
777
777
  "type": "string"
778
778
  },
779
779
  "periodOverPeriod": {
780
- "description": "Settings to configure period over period comparison",
780
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
781
781
  "properties": {
782
782
  "level": {
783
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
783
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
784
784
  "type": "number"
785
785
  },
786
786
  "periodToDate": {
787
- "description": "period to date comparison",
787
+ "description": "Turn ON/OFF period to date comparison",
788
788
  "type": "boolean"
789
789
  },
790
790
  "quantity": {
791
- "description": "number of periods",
791
+ "description": "Number of periods",
792
792
  "type": "number"
793
793
  },
794
794
  "type": {
@@ -892,6 +892,67 @@ declare const _default: {
892
892
  },
893
893
  "type": "object"
894
894
  },
895
+ "loader": {
896
+ "description": "The loader configuration",
897
+ "properties": {
898
+ "background": {
899
+ "default": "#f9f9f9",
900
+ "description": "Background color of the chart loader element",
901
+ "type": "string"
902
+ },
903
+ "fontColor": {
904
+ "default": "#5a5a5a",
905
+ "description": "Font color of the text of the chart loaders",
906
+ "type": "string"
907
+ },
908
+ "locale": {
909
+ "default": "en",
910
+ "description": "Locale to be used if \"msg\" is set",
911
+ "examples": [
912
+ "en",
913
+ "fr"
914
+ ],
915
+ "type": "string"
916
+ },
917
+ "mode": {
918
+ "default": "light",
919
+ "description": "Light or dark loader",
920
+ "type": "string"
921
+ },
922
+ "msg": {
923
+ "description": "Loading message",
924
+ "examples": [
925
+ "Loading dashboard..."
926
+ ],
927
+ "type": "string"
928
+ },
929
+ "showBranded": {
930
+ "default": false,
931
+ "description": "Shows the branded \"powered by\" information",
932
+ "type": "boolean"
933
+ },
934
+ "spinnerBackground": {
935
+ "default": "rgba(169, 169, 169, 0.14)",
936
+ "description": "Background color of the spinner",
937
+ "type": "string"
938
+ },
939
+ "spinnerColor": {
940
+ "default": "rgba(255, 165, 0, 0.7)",
941
+ "description": "Spinner color of the loader",
942
+ "type": "string"
943
+ }
944
+ },
945
+ "type": "object"
946
+ },
947
+ "locale": {
948
+ "default": "en",
949
+ "description": "Locale to be used",
950
+ "examples": [
951
+ "en",
952
+ "fr"
953
+ ],
954
+ "type": "string"
955
+ },
895
956
  "manualValues": {
896
957
  "default": {},
897
958
  "description": "Manual values configuration of the Circular Gauge",
@@ -1396,6 +1457,14 @@ declare const _default: {
1396
1457
  },
1397
1458
  "type": "object"
1398
1459
  },
1460
+ "timezoneId": {
1461
+ "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",
1462
+ "examples": [
1463
+ "Europe/Brussels",
1464
+ "America/New_York"
1465
+ ],
1466
+ "type": "string"
1467
+ },
1399
1468
  "title": {
1400
1469
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
1401
1470
  "examples": [
package/assets/json-schemas/circular-gauge-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": {
@@ -400,7 +400,7 @@ declare const _default: {
400
400
  "type": "string"
401
401
  },
402
402
  "formula": {
403
- "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.",
403
+ "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",
404
404
  "type": "string"
405
405
  },
406
406
  "grandTotals": {
@@ -417,18 +417,18 @@ declare const _default: {
417
417
  "type": "object"
418
418
  },
419
419
  "periodOverPeriod": {
420
- "description": "Settings to configure period over period comparison",
420
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
421
421
  "properties": {
422
422
  "level": {
423
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
423
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
424
424
  "type": "number"
425
425
  },
426
426
  "periodToDate": {
427
- "description": "period to date comparison",
427
+ "description": "Turn ON/OFF period to date comparison",
428
428
  "type": "boolean"
429
429
  },
430
430
  "quantity": {
431
- "description": "number of periods",
431
+ "description": "Number of periods",
432
432
  "type": "number"
433
433
  },
434
434
  "type": {
package/assets/json-schemas/column-chart-options.schema.json.d.ts CHANGED
@@ -3050,7 +3050,7 @@ declare const _default: {
3050
3050
  "type": "string"
3051
3051
  },
3052
3052
  "formula": {
3053
- "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.",
3053
+ "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",
3054
3054
  "type": "string"
3055
3055
  },
3056
3056
  "grandTotals": {
@@ -3097,18 +3097,18 @@ declare const _default: {
3097
3097
  "type": "string"
3098
3098
  },
3099
3099
  "periodOverPeriod": {
3100
- "description": "Settings to configure period over period comparison",
3100
+ "description": "Settings to configure period over period comparison. It can be used only in a measure slot.",
3101
3101
  "properties": {
3102
3102
  "level": {
3103
- "description": "0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
3103
+ "description": "Period of time level\n0 - period, 1 - year, 2 - quarter, 3 - month, 4 - week, 5 - day... 9 - millisecond",
3104
3104
  "type": "number"
3105
3105
  },
3106
3106
  "periodToDate": {
3107
- "description": "period to date comparison",
3107
+ "description": "Turn ON/OFF period to date comparison",
3108
3108
  "type": "boolean"
3109
3109
  },
3110
3110
  "quantity": {
3111
- "description": "number of periods",
3111
+ "description": "Number of periods",
3112
3112
  "type": "number"
3113
3113
  },
3114
3114
  "type": {
@@ -3266,6 +3266,67 @@ declare const _default: {
3266
3266
  },
3267
3267
  "type": "object"
3268
3268
  },
3269
+ "loader": {
3270
+ "description": "The loader configuration",
3271
+ "properties": {
3272
+ "background": {
3273
+ "default": "#f9f9f9",
3274
+ "description": "Background color of the chart loader element",
3275
+ "type": "string"
3276
+ },
3277
+ "fontColor": {
3278
+ "default": "#5a5a5a",
3279
+ "description": "Font color of the text of the chart loaders",
3280
+ "type": "string"
3281
+ },
3282
+ "locale": {
3283
+ "default": "en",
3284
+ "description": "Locale to be used if \"msg\" is set",
3285
+ "examples": [
3286
+ "en",
3287
+ "fr"
3288
+ ],
3289
+ "type": "string"
3290
+ },
3291
+ "mode": {
3292
+ "default": "light",
3293
+ "description": "Light or dark loader",
3294
+ "type": "string"
3295
+ },
3296
+ "msg": {
3297
+ "description": "Loading message",
3298
+ "examples": [
3299
+ "Loading dashboard..."
3300
+ ],
3301
+ "type": "string"
3302
+ },
3303
+ "showBranded": {
3304
+ "default": false,
3305
+ "description": "Shows the branded \"powered by\" information",
3306
+ "type": "boolean"
3307
+ },
3308
+ "spinnerBackground": {
3309
+ "default": "rgba(169, 169, 169, 0.14)",
3310
+ "description": "Background color of the spinner",
3311
+ "type": "string"
3312
+ },
3313
+ "spinnerColor": {
3314
+ "default": "rgba(255, 165, 0, 0.7)",
3315
+ "description": "Spinner color of the loader",
3316
+ "type": "string"
3317
+ }
3318
+ },
3319
+ "type": "object"
3320
+ },
3321
+ "locale": {
3322
+ "default": "en",
3323
+ "description": "Locale to be used",
3324
+ "examples": [
3325
+ "en",
3326
+ "fr"
3327
+ ],
3328
+ "type": "string"
3329
+ },
3269
3330
  "manualAxesRange": {
3270
3331
  "description": "Manual axis range options. Minimum and maximum value of the axis range.",
3271
3332
  "items": [
@@ -3855,6 +3916,14 @@ declare const _default: {
3855
3916
  },
3856
3917
  "type": "object"
3857
3918
  },
3919
+ "timezoneId": {
3920
+ "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",
3921
+ "examples": [
3922
+ "Europe/Brussels",
3923
+ "America/New_York"
3924
+ ],
3925
+ "type": "string"
3926
+ },
3858
3927
  "title": {
3859
3928
  "description": "Title in format {locale: \"title\"}, for example, {en: \"Title\"}",
3860
3929
  "examples": [