@luzmo/dashboard-contents-types 1.0.1 → 1.0.3

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 (90) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/assets/json-schemas/area-chart-options.schema.json.d.ts +17 -129
  3. package/assets/json-schemas/bar-chart-options.schema.json.d.ts +17 -129
  4. package/assets/json-schemas/box-plot-options.schema.json.d.ts +16 -165
  5. package/assets/json-schemas/bubble-chart-options.schema.json.d.ts +17 -129
  6. package/assets/json-schemas/bullet-chart-options.schema.json.d.ts +12 -175
  7. package/assets/json-schemas/choropleth-map-options.schema.json.d.ts +12 -150
  8. package/assets/json-schemas/circular-gauge-options.schema.json.d.ts +15 -176
  9. package/assets/json-schemas/column-chart-options.schema.json.d.ts +17 -129
  10. package/assets/json-schemas/combination-chart-options.schema.json.d.ts +17 -129
  11. package/assets/json-schemas/date-filter-options.schema.json.d.ts +10 -228
  12. package/assets/json-schemas/donut-chart-options.schema.json.d.ts +16 -140
  13. package/assets/json-schemas/dropdown-filter-options.schema.json.d.ts +10 -228
  14. package/assets/json-schemas/evolution-number-options.schema.json.d.ts +15 -176
  15. package/assets/json-schemas/funnel-chart-options.schema.json.d.ts +16 -140
  16. package/assets/json-schemas/image-options.schema.json.d.ts +5 -339
  17. package/assets/json-schemas/line-chart-options.schema.json.d.ts +17 -129
  18. package/assets/json-schemas/pivot-table-options.schema.json.d.ts +11 -186
  19. package/assets/json-schemas/regular-table-options.schema.json.d.ts +11 -186
  20. package/assets/json-schemas/sankey-diagram-options.schema.json.d.ts +15 -176
  21. package/assets/json-schemas/scatter-plot-options.schema.json.d.ts +17 -129
  22. package/assets/json-schemas/search-filter-options.schema.json.d.ts +1051 -0
  23. package/assets/json-schemas/search-filter-slots.schema.json.d.ts +484 -0
  24. package/assets/json-schemas/search-filter.schema.json.d.ts +23 -0
  25. package/assets/json-schemas/slicer-filter-options.schema.json.d.ts +10 -228
  26. package/assets/json-schemas/slider-filter-options.schema.json.d.ts +10 -228
  27. package/assets/json-schemas/text-options.schema.json.d.ts +6 -296
  28. package/index.js +66 -45
  29. package/index.mjs +2025 -4267
  30. package/json-schemas.d.ts +1173 -1938
  31. package/json-schemas.d.ts.map +1 -1
  32. package/package.json +1 -1
  33. package/src/lib/area-chart/area-chart-options.d.ts +6 -3
  34. package/src/lib/area-chart/area-chart-options.d.ts.map +1 -1
  35. package/src/lib/bar-chart/bar-chart-options.d.ts +6 -3
  36. package/src/lib/bar-chart/bar-chart-options.d.ts.map +1 -1
  37. package/src/lib/box-plot/box-plot-options.d.ts +6 -3
  38. package/src/lib/box-plot/box-plot-options.d.ts.map +1 -1
  39. package/src/lib/bubble-chart/bubble-chart-options.d.ts +6 -3
  40. package/src/lib/bubble-chart/bubble-chart-options.d.ts.map +1 -1
  41. package/src/lib/bullet-chart/bullet-chart-options.d.ts +6 -1
  42. package/src/lib/bullet-chart/bullet-chart-options.d.ts.map +1 -1
  43. package/src/lib/choropleth-map/choropleth-map-options.d.ts +6 -2
  44. package/src/lib/choropleth-map/choropleth-map-options.d.ts.map +1 -1
  45. package/src/lib/circular-gauge/circular-gauge-options.d.ts +6 -1
  46. package/src/lib/circular-gauge/circular-gauge-options.d.ts.map +1 -1
  47. package/src/lib/column-chart/column-chart-options.d.ts +6 -3
  48. package/src/lib/column-chart/column-chart-options.d.ts.map +1 -1
  49. package/src/lib/combination-chart/combination-chart-options.d.ts +6 -3
  50. package/src/lib/combination-chart/combination-chart-options.d.ts.map +1 -1
  51. package/src/lib/conditional-number/conditional-number-options.d.ts +6 -1
  52. package/src/lib/conditional-number/conditional-number-options.d.ts.map +1 -1
  53. package/src/lib/date-filter/date-filter-options.d.ts +6 -2
  54. package/src/lib/date-filter/date-filter-options.d.ts.map +1 -1
  55. package/src/lib/donut-chart/donut-chart-options.d.ts +6 -2
  56. package/src/lib/donut-chart/donut-chart-options.d.ts.map +1 -1
  57. package/src/lib/dropdown-filter/dropdown-filter-options.d.ts +6 -1
  58. package/src/lib/dropdown-filter/dropdown-filter-options.d.ts.map +1 -1
  59. package/src/lib/evolution-number/evolution-number-options.d.ts +6 -1
  60. package/src/lib/evolution-number/evolution-number-options.d.ts.map +1 -1
  61. package/src/lib/funnel-chart/funnel-chart-options.d.ts +6 -2
  62. package/src/lib/funnel-chart/funnel-chart-options.d.ts.map +1 -1
  63. package/src/lib/image/image-options.d.ts +6 -1
  64. package/src/lib/image/image-options.d.ts.map +1 -1
  65. package/src/lib/line-chart/line-chart-options.d.ts +6 -3
  66. package/src/lib/line-chart/line-chart-options.d.ts.map +1 -1
  67. package/src/lib/pivot-table/pivot-table-options.d.ts +6 -2
  68. package/src/lib/pivot-table/pivot-table-options.d.ts.map +1 -1
  69. package/src/lib/regular-table/regular-table-options.d.ts +6 -1
  70. package/src/lib/regular-table/regular-table-options.d.ts.map +1 -1
  71. package/src/lib/sankey-diagram/sankey-diagram-options.d.ts +6 -2
  72. package/src/lib/sankey-diagram/sankey-diagram-options.d.ts.map +1 -1
  73. package/src/lib/scatter-plot/scatter-plot-options.d.ts +6 -3
  74. package/src/lib/scatter-plot/scatter-plot-options.d.ts.map +1 -1
  75. package/src/lib/search-filter/search-filter-options.d.ts +12 -2
  76. package/src/lib/search-filter/search-filter-options.d.ts.map +1 -1
  77. package/src/lib/shared/index.d.ts +1 -3
  78. package/src/lib/shared/index.d.ts.map +1 -1
  79. package/src/lib/shared/slots.d.ts +1 -0
  80. package/src/lib/shared/slots.d.ts.map +1 -1
  81. package/src/lib/shared/theme.d.ts +87 -81
  82. package/src/lib/shared/theme.d.ts.map +1 -1
  83. package/src/lib/slicer-filter/slicer-filter-options.d.ts +6 -2
  84. package/src/lib/slicer-filter/slicer-filter-options.d.ts.map +1 -1
  85. package/src/lib/slider-filter/slider-filter-options.d.ts +6 -2
  86. package/src/lib/slider-filter/slider-filter-options.d.ts.map +1 -1
  87. package/src/lib/text/text-options.d.ts +6 -1
  88. package/src/lib/text/text-options.d.ts.map +1 -1
  89. package/src/lib/shared/axis-view-options.d.ts +0 -3
  90. package/src/lib/shared/axis-view-options.d.ts.map +0 -1
package/assets/json-schemas/combination-chart-options.schema.json.d.ts CHANGED
@@ -672,6 +672,9 @@ declare const _default: {
672
672
  "currency_id": {
673
673
  "type": "string"
674
674
  },
675
+ "description": {
676
+ "type": "object"
677
+ },
675
678
  "duration_format": {
676
679
  "enum": [
677
680
  "long",
@@ -1549,7 +1552,7 @@ declare const _default: {
1549
1552
  "description": "Theme configuration",
1550
1553
  "properties": {
1551
1554
  "axis": {
1552
- "description": "Axis styling",
1555
+ "description": "Custom axis styling",
1553
1556
  "examples": [
1554
1557
  {
1555
1558
  "fontSize": 12
@@ -1560,25 +1563,8 @@ declare const _default: {
1560
1563
  ],
1561
1564
  "type": "object"
1562
1565
  },
1563
- "background": {
1564
- "description": "Background color",
1565
- "examples": [
1566
- "rgb(245, 245, 245)",
1567
- "rgb(61, 61, 61)"
1568
- ],
1569
- "type": "string"
1570
- },
1571
- "baseFontSize": {
1572
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
1573
- "examples": [
1574
- 13,
1575
- 16,
1576
- 20
1577
- ],
1578
- "type": "number"
1579
- },
1580
1566
  "borders": {
1581
- "description": "Border styling",
1567
+ "description": "Custom border styling",
1582
1568
  "properties": {
1583
1569
  "border-bottom-width": {
1584
1570
  "description": "Border bottom width",
@@ -1647,7 +1633,7 @@ declare const _default: {
1647
1633
  "type": "object"
1648
1634
  },
1649
1635
  "boxShadow": {
1650
- "description": "Shadow styling",
1636
+ "description": "Custom shadow styling",
1651
1637
  "properties": {
1652
1638
  "color": {
1653
1639
  "description": "Shadow color",
@@ -1677,29 +1663,12 @@ declare const _default: {
1677
1663
  "type": "object"
1678
1664
  },
1679
1665
  "colors": {
1680
- "description": "A list of theme colors",
1666
+ "description": "Custom color palette",
1681
1667
  "examples": [
1682
1668
  [
1683
- "rgb(122, 112, 112)",
1684
- "rgb(175, 169, 169)",
1685
- "rgb(228, 226, 226)"
1686
- ],
1687
- [
1688
- "rgb(48, 36, 179)",
1689
- "rgb(105, 93, 255)",
1690
- "rgb(199, 194, 255)",
1691
- "rgb(134, 4, 129)",
1692
- "rgb(204, 55, 198)",
1693
- "rgb(236, 180, 234)",
1694
- "rgb(220, 141, 0)",
1695
- "rgb(249, 206, 61)",
1696
- "rgb(253, 237, 182)",
1697
- "rgb(6, 142, 84)",
1698
- "rgb(58, 213, 147)",
1699
- "rgb(181, 239, 215)",
1700
- "rgb(85, 78, 78)",
1701
- "rgb(149, 141, 141)",
1702
- "rgb(215, 212, 212)"
1669
+ "rgb(68, 52, 255)",
1670
+ "rgb(68, 52, 255)",
1671
+ "rgb(218, 214, 255)"
1703
1672
  ]
1704
1673
  ],
1705
1674
  "items": {
@@ -1707,24 +1676,8 @@ declare const _default: {
1707
1676
  },
1708
1677
  "type": "array"
1709
1678
  },
1710
- "editBackground": {
1711
- "description": "Edit background",
1712
- "examples": [
1713
- "rgb(228, 228, 228)",
1714
- "rgb(245, 245, 245)",
1715
- "rgb(61, 61, 61)"
1716
- ],
1717
- "type": "string"
1718
- },
1719
- "editModeBackground": {
1720
- "description": "Edit mode background",
1721
- "examples": [
1722
- "rgb(245, 245, 245)"
1723
- ],
1724
- "type": "string"
1725
- },
1726
1679
  "font": {
1727
- "description": "Font styling",
1680
+ "description": "Custom font styling",
1728
1681
  "properties": {
1729
1682
  "font-style": {
1730
1683
  "const": "normal",
@@ -1768,40 +1721,15 @@ declare const _default: {
1768
1721
  "type": "object"
1769
1722
  },
1770
1723
  "id": {
1771
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
1724
+ "description": "Id of the theme, for example, \"seasonal\", \"urban\" or custom theme uuid. If you just pass custom theme options, it have to be skipped.",
1772
1725
  "examples": [
1773
1726
  "seasonal",
1774
1727
  "urban"
1775
1728
  ],
1776
1729
  "type": "string"
1777
1730
  },
1778
- "itemSpecific": {
1779
- "description": "Item specific styling",
1780
- "properties": {
1781
- "padding": {
1782
- "description": "Padding of the item",
1783
- "examples": [
1784
- 0,
1785
- 4,
1786
- 8,
1787
- 10
1788
- ],
1789
- "type": "number"
1790
- },
1791
- "rounding": {
1792
- "description": "Rounding of the item",
1793
- "examples": [
1794
- 0,
1795
- 8,
1796
- 12
1797
- ],
1798
- "type": "number"
1799
- }
1800
- },
1801
- "type": "object"
1802
- },
1803
1731
  "itemsBackground": {
1804
- "description": "Item background color",
1732
+ "description": "Custom item background color",
1805
1733
  "examples": [
1806
1734
  "rgb(255, 255, 255)",
1807
1735
  "rgb(71, 69, 69)",
@@ -1810,7 +1738,7 @@ declare const _default: {
1810
1738
  "type": "string"
1811
1739
  },
1812
1740
  "legend": {
1813
- "description": "Legend styling",
1741
+ "description": "Custom legend styling",
1814
1742
  "properties": {
1815
1743
  "fontSize": {
1816
1744
  "description": "Legend font size in px",
@@ -1846,48 +1774,8 @@ declare const _default: {
1846
1774
  },
1847
1775
  "type": "object"
1848
1776
  },
1849
- "mainColor": {
1850
- "description": "Theme main color",
1851
- "examples": [
1852
- "rgb(123, 144, 255)",
1853
- "rgb(255, 174, 52)",
1854
- "rgb(123, 144, 255)"
1855
- ],
1856
- "type": "string"
1857
- },
1858
- "margins": {
1859
- "description": "Dashboard vertical and horizontal margins",
1860
- "examples": [
1861
- [
1862
- 16,
1863
- 16
1864
- ],
1865
- [
1866
- 20,
1867
- 20
1868
- ]
1869
- ],
1870
- "items": [
1871
- {
1872
- "type": "number"
1873
- },
1874
- {
1875
- "type": "number"
1876
- }
1877
- ],
1878
- "maxItems": 2,
1879
- "minItems": 2,
1880
- "type": "array"
1881
- },
1882
- "name": {
1883
- "description": "Theme name",
1884
- "examples": [
1885
- "manual"
1886
- ],
1887
- "type": "string"
1888
- },
1889
1777
  "title": {
1890
- "description": "Title styling",
1778
+ "description": "Custom title styling",
1891
1779
  "properties": {
1892
1780
  "align": {
1893
1781
  "description": "Title align",
@@ -1956,7 +1844,7 @@ declare const _default: {
1956
1844
  "type": "object"
1957
1845
  },
1958
1846
  "tooltip": {
1959
- "description": "Tooltip styling",
1847
+ "description": "Custom tooltip styling",
1960
1848
  "properties": {
1961
1849
  "background": {
1962
1850
  "description": "Tooltip's background",
@@ -1999,7 +1887,7 @@ declare const _default: {
1999
1887
  "type": "object"
2000
1888
  },
2001
1889
  "type": {
2002
- "description": "Theme type",
1890
+ "description": "It should be \"custom\" if custom theme id is specified or if you specify custom theme options to set the theme. Skip it otherwise.",
2003
1891
  "examples": [
2004
1892
  "custom"
2005
1893
  ],
package/assets/json-schemas/date-filter-options.schema.json.d.ts CHANGED
@@ -204,6 +204,9 @@ declare const _default: {
204
204
  "currency_id": {
205
205
  "type": "string"
206
206
  },
207
+ "description": {
208
+ "type": "object"
209
+ },
207
210
  "duration_format": {
208
211
  "enum": [
209
212
  "long",
@@ -876,37 +879,8 @@ declare const _default: {
876
879
  "theme": {
877
880
  "description": "Theme configuration",
878
881
  "properties": {
879
- "axis": {
880
- "description": "Axis styling",
881
- "examples": [
882
- {
883
- "fontSize": 12
884
- },
885
- {
886
- "fontSize": 10
887
- }
888
- ],
889
- "type": "object"
890
- },
891
- "background": {
892
- "description": "Background color",
893
- "examples": [
894
- "rgb(245, 245, 245)",
895
- "rgb(61, 61, 61)"
896
- ],
897
- "type": "string"
898
- },
899
- "baseFontSize": {
900
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
901
- "examples": [
902
- 13,
903
- 16,
904
- 20
905
- ],
906
- "type": "number"
907
- },
908
882
  "borders": {
909
- "description": "Border styling",
883
+ "description": "Custom border styling",
910
884
  "properties": {
911
885
  "border-bottom-width": {
912
886
  "description": "Border bottom width",
@@ -975,7 +949,7 @@ declare const _default: {
975
949
  "type": "object"
976
950
  },
977
951
  "boxShadow": {
978
- "description": "Shadow styling",
952
+ "description": "Custom shadow styling",
979
953
  "properties": {
980
954
  "color": {
981
955
  "description": "Shadow color",
@@ -1004,55 +978,8 @@ declare const _default: {
1004
978
  },
1005
979
  "type": "object"
1006
980
  },
1007
- "colors": {
1008
- "description": "A list of theme colors",
1009
- "examples": [
1010
- [
1011
- "rgb(122, 112, 112)",
1012
- "rgb(175, 169, 169)",
1013
- "rgb(228, 226, 226)"
1014
- ],
1015
- [
1016
- "rgb(48, 36, 179)",
1017
- "rgb(105, 93, 255)",
1018
- "rgb(199, 194, 255)",
1019
- "rgb(134, 4, 129)",
1020
- "rgb(204, 55, 198)",
1021
- "rgb(236, 180, 234)",
1022
- "rgb(220, 141, 0)",
1023
- "rgb(249, 206, 61)",
1024
- "rgb(253, 237, 182)",
1025
- "rgb(6, 142, 84)",
1026
- "rgb(58, 213, 147)",
1027
- "rgb(181, 239, 215)",
1028
- "rgb(85, 78, 78)",
1029
- "rgb(149, 141, 141)",
1030
- "rgb(215, 212, 212)"
1031
- ]
1032
- ],
1033
- "items": {
1034
- "type": "string"
1035
- },
1036
- "type": "array"
1037
- },
1038
- "editBackground": {
1039
- "description": "Edit background",
1040
- "examples": [
1041
- "rgb(228, 228, 228)",
1042
- "rgb(245, 245, 245)",
1043
- "rgb(61, 61, 61)"
1044
- ],
1045
- "type": "string"
1046
- },
1047
- "editModeBackground": {
1048
- "description": "Edit mode background",
1049
- "examples": [
1050
- "rgb(245, 245, 245)"
1051
- ],
1052
- "type": "string"
1053
- },
1054
981
  "font": {
1055
- "description": "Font styling",
982
+ "description": "Custom font styling",
1056
983
  "properties": {
1057
984
  "font-style": {
1058
985
  "const": "normal",
@@ -1096,40 +1023,15 @@ declare const _default: {
1096
1023
  "type": "object"
1097
1024
  },
1098
1025
  "id": {
1099
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
1026
+ "description": "Id of the theme, for example, \"seasonal\", \"urban\" or custom theme uuid. If you just pass custom theme options, it have to be skipped.",
1100
1027
  "examples": [
1101
1028
  "seasonal",
1102
1029
  "urban"
1103
1030
  ],
1104
1031
  "type": "string"
1105
1032
  },
1106
- "itemSpecific": {
1107
- "description": "Item specific styling",
1108
- "properties": {
1109
- "padding": {
1110
- "description": "Padding of the item",
1111
- "examples": [
1112
- 0,
1113
- 4,
1114
- 8,
1115
- 10
1116
- ],
1117
- "type": "number"
1118
- },
1119
- "rounding": {
1120
- "description": "Rounding of the item",
1121
- "examples": [
1122
- 0,
1123
- 8,
1124
- 12
1125
- ],
1126
- "type": "number"
1127
- }
1128
- },
1129
- "type": "object"
1130
- },
1131
1033
  "itemsBackground": {
1132
- "description": "Item background color",
1034
+ "description": "Custom item background color",
1133
1035
  "examples": [
1134
1036
  "rgb(255, 255, 255)",
1135
1037
  "rgb(71, 69, 69)",
@@ -1137,85 +1039,8 @@ declare const _default: {
1137
1039
  ],
1138
1040
  "type": "string"
1139
1041
  },
1140
- "legend": {
1141
- "description": "Legend styling",
1142
- "properties": {
1143
- "fontSize": {
1144
- "description": "Legend font size in px",
1145
- "examples": [
1146
- 12,
1147
- 16
1148
- ],
1149
- "type": "number"
1150
- },
1151
- "lineHeight": {
1152
- "description": "Legend line height in px",
1153
- "examples": [
1154
- 12,
1155
- 16,
1156
- 20
1157
- ],
1158
- "type": "number"
1159
- },
1160
- "type": {
1161
- "description": "Legend type",
1162
- "enum": [
1163
- "circle",
1164
- "line",
1165
- "normal"
1166
- ],
1167
- "examples": [
1168
- "normal",
1169
- "line",
1170
- "circle"
1171
- ],
1172
- "type": "string"
1173
- }
1174
- },
1175
- "type": "object"
1176
- },
1177
- "mainColor": {
1178
- "description": "Theme main color",
1179
- "examples": [
1180
- "rgb(123, 144, 255)",
1181
- "rgb(255, 174, 52)",
1182
- "rgb(123, 144, 255)"
1183
- ],
1184
- "type": "string"
1185
- },
1186
- "margins": {
1187
- "description": "Dashboard vertical and horizontal margins",
1188
- "examples": [
1189
- [
1190
- 16,
1191
- 16
1192
- ],
1193
- [
1194
- 20,
1195
- 20
1196
- ]
1197
- ],
1198
- "items": [
1199
- {
1200
- "type": "number"
1201
- },
1202
- {
1203
- "type": "number"
1204
- }
1205
- ],
1206
- "maxItems": 2,
1207
- "minItems": 2,
1208
- "type": "array"
1209
- },
1210
- "name": {
1211
- "description": "Theme name",
1212
- "examples": [
1213
- "manual"
1214
- ],
1215
- "type": "string"
1216
- },
1217
1042
  "title": {
1218
- "description": "Title styling",
1043
+ "description": "Custom title styling",
1219
1044
  "properties": {
1220
1045
  "align": {
1221
1046
  "description": "Title align",
@@ -1283,51 +1108,8 @@ declare const _default: {
1283
1108
  },
1284
1109
  "type": "object"
1285
1110
  },
1286
- "tooltip": {
1287
- "description": "Tooltip styling",
1288
- "properties": {
1289
- "background": {
1290
- "description": "Tooltip's background",
1291
- "examples": [
1292
- "rgb(248, 248, 248)",
1293
- "rgb(248, 248, 248)",
1294
- "rgb(130, 128, 128)",
1295
- "rgb(61, 61, 61)"
1296
- ],
1297
- "type": "string"
1298
- },
1299
- "fontSize": {
1300
- "description": "Tooltip's font size in px",
1301
- "examples": [
1302
- 12,
1303
- 16,
1304
- 20
1305
- ],
1306
- "type": "number"
1307
- },
1308
- "lineHeight": {
1309
- "description": "Tooltip's line height in px",
1310
- "examples": [
1311
- 12,
1312
- 16,
1313
- 20
1314
- ],
1315
- "type": "number"
1316
- },
1317
- "opacity": {
1318
- "description": "Tooltip's opacity",
1319
- "examples": [
1320
- 0.5,
1321
- 0.8,
1322
- 1
1323
- ],
1324
- "type": "number"
1325
- }
1326
- },
1327
- "type": "object"
1328
- },
1329
1111
  "type": {
1330
- "description": "Theme type",
1112
+ "description": "It should be \"custom\" if custom theme id is specified or if you specify custom theme options to set the theme. Skip it otherwise.",
1331
1113
  "examples": [
1332
1114
  "custom"
1333
1115
  ],