@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/circular-gauge-options.schema.json.d.ts CHANGED
@@ -277,6 +277,9 @@ declare const _default: {
277
277
  "currency_id": {
278
278
  "type": "string"
279
279
  },
280
+ "description": {
281
+ "type": "object"
282
+ },
280
283
  "duration_format": {
281
284
  "enum": [
282
285
  "long",
@@ -997,37 +1000,8 @@ declare const _default: {
997
1000
  "theme": {
998
1001
  "description": "Theme configuration",
999
1002
  "properties": {
1000
- "axis": {
1001
- "description": "Axis styling",
1002
- "examples": [
1003
- {
1004
- "fontSize": 12
1005
- },
1006
- {
1007
- "fontSize": 10
1008
- }
1009
- ],
1010
- "type": "object"
1011
- },
1012
- "background": {
1013
- "description": "Background color",
1014
- "examples": [
1015
- "rgb(245, 245, 245)",
1016
- "rgb(61, 61, 61)"
1017
- ],
1018
- "type": "string"
1019
- },
1020
- "baseFontSize": {
1021
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
1022
- "examples": [
1023
- 13,
1024
- 16,
1025
- 20
1026
- ],
1027
- "type": "number"
1028
- },
1029
1003
  "borders": {
1030
- "description": "Border styling",
1004
+ "description": "Custom border styling",
1031
1005
  "properties": {
1032
1006
  "border-bottom-width": {
1033
1007
  "description": "Border bottom width",
@@ -1096,7 +1070,7 @@ declare const _default: {
1096
1070
  "type": "object"
1097
1071
  },
1098
1072
  "boxShadow": {
1099
- "description": "Shadow styling",
1073
+ "description": "Custom shadow styling",
1100
1074
  "properties": {
1101
1075
  "color": {
1102
1076
  "description": "Shadow color",
@@ -1126,29 +1100,12 @@ declare const _default: {
1126
1100
  "type": "object"
1127
1101
  },
1128
1102
  "colors": {
1129
- "description": "A list of theme colors",
1103
+ "description": "Custom color palette",
1130
1104
  "examples": [
1131
1105
  [
1132
- "rgb(122, 112, 112)",
1133
- "rgb(175, 169, 169)",
1134
- "rgb(228, 226, 226)"
1135
- ],
1136
- [
1137
- "rgb(48, 36, 179)",
1138
- "rgb(105, 93, 255)",
1139
- "rgb(199, 194, 255)",
1140
- "rgb(134, 4, 129)",
1141
- "rgb(204, 55, 198)",
1142
- "rgb(236, 180, 234)",
1143
- "rgb(220, 141, 0)",
1144
- "rgb(249, 206, 61)",
1145
- "rgb(253, 237, 182)",
1146
- "rgb(6, 142, 84)",
1147
- "rgb(58, 213, 147)",
1148
- "rgb(181, 239, 215)",
1149
- "rgb(85, 78, 78)",
1150
- "rgb(149, 141, 141)",
1151
- "rgb(215, 212, 212)"
1106
+ "rgb(68, 52, 255)",
1107
+ "rgb(68, 52, 255)",
1108
+ "rgb(218, 214, 255)"
1152
1109
  ]
1153
1110
  ],
1154
1111
  "items": {
@@ -1156,24 +1113,8 @@ declare const _default: {
1156
1113
  },
1157
1114
  "type": "array"
1158
1115
  },
1159
- "editBackground": {
1160
- "description": "Edit background",
1161
- "examples": [
1162
- "rgb(228, 228, 228)",
1163
- "rgb(245, 245, 245)",
1164
- "rgb(61, 61, 61)"
1165
- ],
1166
- "type": "string"
1167
- },
1168
- "editModeBackground": {
1169
- "description": "Edit mode background",
1170
- "examples": [
1171
- "rgb(245, 245, 245)"
1172
- ],
1173
- "type": "string"
1174
- },
1175
1116
  "font": {
1176
- "description": "Font styling",
1117
+ "description": "Custom font styling",
1177
1118
  "properties": {
1178
1119
  "font-style": {
1179
1120
  "const": "normal",
@@ -1217,40 +1158,15 @@ declare const _default: {
1217
1158
  "type": "object"
1218
1159
  },
1219
1160
  "id": {
1220
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
1161
+ "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.",
1221
1162
  "examples": [
1222
1163
  "seasonal",
1223
1164
  "urban"
1224
1165
  ],
1225
1166
  "type": "string"
1226
1167
  },
1227
- "itemSpecific": {
1228
- "description": "Item specific styling",
1229
- "properties": {
1230
- "padding": {
1231
- "description": "Padding of the item",
1232
- "examples": [
1233
- 0,
1234
- 4,
1235
- 8,
1236
- 10
1237
- ],
1238
- "type": "number"
1239
- },
1240
- "rounding": {
1241
- "description": "Rounding of the item",
1242
- "examples": [
1243
- 0,
1244
- 8,
1245
- 12
1246
- ],
1247
- "type": "number"
1248
- }
1249
- },
1250
- "type": "object"
1251
- },
1252
1168
  "itemsBackground": {
1253
- "description": "Item background color",
1169
+ "description": "Custom item background color",
1254
1170
  "examples": [
1255
1171
  "rgb(255, 255, 255)",
1256
1172
  "rgb(71, 69, 69)",
@@ -1258,85 +1174,8 @@ declare const _default: {
1258
1174
  ],
1259
1175
  "type": "string"
1260
1176
  },
1261
- "legend": {
1262
- "description": "Legend styling",
1263
- "properties": {
1264
- "fontSize": {
1265
- "description": "Legend font size in px",
1266
- "examples": [
1267
- 12,
1268
- 16
1269
- ],
1270
- "type": "number"
1271
- },
1272
- "lineHeight": {
1273
- "description": "Legend line height in px",
1274
- "examples": [
1275
- 12,
1276
- 16,
1277
- 20
1278
- ],
1279
- "type": "number"
1280
- },
1281
- "type": {
1282
- "description": "Legend type",
1283
- "enum": [
1284
- "circle",
1285
- "line",
1286
- "normal"
1287
- ],
1288
- "examples": [
1289
- "normal",
1290
- "line",
1291
- "circle"
1292
- ],
1293
- "type": "string"
1294
- }
1295
- },
1296
- "type": "object"
1297
- },
1298
- "mainColor": {
1299
- "description": "Theme main color",
1300
- "examples": [
1301
- "rgb(123, 144, 255)",
1302
- "rgb(255, 174, 52)",
1303
- "rgb(123, 144, 255)"
1304
- ],
1305
- "type": "string"
1306
- },
1307
- "margins": {
1308
- "description": "Dashboard vertical and horizontal margins",
1309
- "examples": [
1310
- [
1311
- 16,
1312
- 16
1313
- ],
1314
- [
1315
- 20,
1316
- 20
1317
- ]
1318
- ],
1319
- "items": [
1320
- {
1321
- "type": "number"
1322
- },
1323
- {
1324
- "type": "number"
1325
- }
1326
- ],
1327
- "maxItems": 2,
1328
- "minItems": 2,
1329
- "type": "array"
1330
- },
1331
- "name": {
1332
- "description": "Theme name",
1333
- "examples": [
1334
- "manual"
1335
- ],
1336
- "type": "string"
1337
- },
1338
1177
  "title": {
1339
- "description": "Title styling",
1178
+ "description": "Custom title styling",
1340
1179
  "properties": {
1341
1180
  "align": {
1342
1181
  "description": "Title align",
@@ -1405,7 +1244,7 @@ declare const _default: {
1405
1244
  "type": "object"
1406
1245
  },
1407
1246
  "tooltip": {
1408
- "description": "Tooltip styling",
1247
+ "description": "Custom tooltip styling",
1409
1248
  "properties": {
1410
1249
  "background": {
1411
1250
  "description": "Tooltip's background",
@@ -1448,7 +1287,7 @@ declare const _default: {
1448
1287
  "type": "object"
1449
1288
  },
1450
1289
  "type": {
1451
- "description": "Theme type",
1290
+ "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.",
1452
1291
  "examples": [
1453
1292
  "custom"
1454
1293
  ],
package/assets/json-schemas/column-chart-options.schema.json.d.ts CHANGED
@@ -2597,6 +2597,9 @@ declare const _default: {
2597
2597
  "currency_id": {
2598
2598
  "type": "string"
2599
2599
  },
2600
+ "description": {
2601
+ "type": "object"
2602
+ },
2600
2603
  "duration_format": {
2601
2604
  "enum": [
2602
2605
  "long",
@@ -3457,7 +3460,7 @@ declare const _default: {
3457
3460
  "description": "Theme configuration",
3458
3461
  "properties": {
3459
3462
  "axis": {
3460
- "description": "Axis styling",
3463
+ "description": "Custom axis styling",
3461
3464
  "examples": [
3462
3465
  {
3463
3466
  "fontSize": 12
@@ -3468,25 +3471,8 @@ declare const _default: {
3468
3471
  ],
3469
3472
  "type": "object"
3470
3473
  },
3471
- "background": {
3472
- "description": "Background color",
3473
- "examples": [
3474
- "rgb(245, 245, 245)",
3475
- "rgb(61, 61, 61)"
3476
- ],
3477
- "type": "string"
3478
- },
3479
- "baseFontSize": {
3480
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
3481
- "examples": [
3482
- 13,
3483
- 16,
3484
- 20
3485
- ],
3486
- "type": "number"
3487
- },
3488
3474
  "borders": {
3489
- "description": "Border styling",
3475
+ "description": "Custom border styling",
3490
3476
  "properties": {
3491
3477
  "border-bottom-width": {
3492
3478
  "description": "Border bottom width",
@@ -3555,7 +3541,7 @@ declare const _default: {
3555
3541
  "type": "object"
3556
3542
  },
3557
3543
  "boxShadow": {
3558
- "description": "Shadow styling",
3544
+ "description": "Custom shadow styling",
3559
3545
  "properties": {
3560
3546
  "color": {
3561
3547
  "description": "Shadow color",
@@ -3585,29 +3571,12 @@ declare const _default: {
3585
3571
  "type": "object"
3586
3572
  },
3587
3573
  "colors": {
3588
- "description": "A list of theme colors",
3574
+ "description": "Custom color palette",
3589
3575
  "examples": [
3590
3576
  [
3591
- "rgb(122, 112, 112)",
3592
- "rgb(175, 169, 169)",
3593
- "rgb(228, 226, 226)"
3594
- ],
3595
- [
3596
- "rgb(48, 36, 179)",
3597
- "rgb(105, 93, 255)",
3598
- "rgb(199, 194, 255)",
3599
- "rgb(134, 4, 129)",
3600
- "rgb(204, 55, 198)",
3601
- "rgb(236, 180, 234)",
3602
- "rgb(220, 141, 0)",
3603
- "rgb(249, 206, 61)",
3604
- "rgb(253, 237, 182)",
3605
- "rgb(6, 142, 84)",
3606
- "rgb(58, 213, 147)",
3607
- "rgb(181, 239, 215)",
3608
- "rgb(85, 78, 78)",
3609
- "rgb(149, 141, 141)",
3610
- "rgb(215, 212, 212)"
3577
+ "rgb(68, 52, 255)",
3578
+ "rgb(68, 52, 255)",
3579
+ "rgb(218, 214, 255)"
3611
3580
  ]
3612
3581
  ],
3613
3582
  "items": {
@@ -3615,24 +3584,8 @@ declare const _default: {
3615
3584
  },
3616
3585
  "type": "array"
3617
3586
  },
3618
- "editBackground": {
3619
- "description": "Edit background",
3620
- "examples": [
3621
- "rgb(228, 228, 228)",
3622
- "rgb(245, 245, 245)",
3623
- "rgb(61, 61, 61)"
3624
- ],
3625
- "type": "string"
3626
- },
3627
- "editModeBackground": {
3628
- "description": "Edit mode background",
3629
- "examples": [
3630
- "rgb(245, 245, 245)"
3631
- ],
3632
- "type": "string"
3633
- },
3634
3587
  "font": {
3635
- "description": "Font styling",
3588
+ "description": "Custom font styling",
3636
3589
  "properties": {
3637
3590
  "font-style": {
3638
3591
  "const": "normal",
@@ -3676,40 +3629,15 @@ declare const _default: {
3676
3629
  "type": "object"
3677
3630
  },
3678
3631
  "id": {
3679
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
3632
+ "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.",
3680
3633
  "examples": [
3681
3634
  "seasonal",
3682
3635
  "urban"
3683
3636
  ],
3684
3637
  "type": "string"
3685
3638
  },
3686
- "itemSpecific": {
3687
- "description": "Item specific styling",
3688
- "properties": {
3689
- "padding": {
3690
- "description": "Padding of the item",
3691
- "examples": [
3692
- 0,
3693
- 4,
3694
- 8,
3695
- 10
3696
- ],
3697
- "type": "number"
3698
- },
3699
- "rounding": {
3700
- "description": "Rounding of the item",
3701
- "examples": [
3702
- 0,
3703
- 8,
3704
- 12
3705
- ],
3706
- "type": "number"
3707
- }
3708
- },
3709
- "type": "object"
3710
- },
3711
3639
  "itemsBackground": {
3712
- "description": "Item background color",
3640
+ "description": "Custom item background color",
3713
3641
  "examples": [
3714
3642
  "rgb(255, 255, 255)",
3715
3643
  "rgb(71, 69, 69)",
@@ -3718,7 +3646,7 @@ declare const _default: {
3718
3646
  "type": "string"
3719
3647
  },
3720
3648
  "legend": {
3721
- "description": "Legend styling",
3649
+ "description": "Custom legend styling",
3722
3650
  "properties": {
3723
3651
  "fontSize": {
3724
3652
  "description": "Legend font size in px",
@@ -3754,48 +3682,8 @@ declare const _default: {
3754
3682
  },
3755
3683
  "type": "object"
3756
3684
  },
3757
- "mainColor": {
3758
- "description": "Theme main color",
3759
- "examples": [
3760
- "rgb(123, 144, 255)",
3761
- "rgb(255, 174, 52)",
3762
- "rgb(123, 144, 255)"
3763
- ],
3764
- "type": "string"
3765
- },
3766
- "margins": {
3767
- "description": "Dashboard vertical and horizontal margins",
3768
- "examples": [
3769
- [
3770
- 16,
3771
- 16
3772
- ],
3773
- [
3774
- 20,
3775
- 20
3776
- ]
3777
- ],
3778
- "items": [
3779
- {
3780
- "type": "number"
3781
- },
3782
- {
3783
- "type": "number"
3784
- }
3785
- ],
3786
- "maxItems": 2,
3787
- "minItems": 2,
3788
- "type": "array"
3789
- },
3790
- "name": {
3791
- "description": "Theme name",
3792
- "examples": [
3793
- "manual"
3794
- ],
3795
- "type": "string"
3796
- },
3797
3685
  "title": {
3798
- "description": "Title styling",
3686
+ "description": "Custom title styling",
3799
3687
  "properties": {
3800
3688
  "align": {
3801
3689
  "description": "Title align",
@@ -3864,7 +3752,7 @@ declare const _default: {
3864
3752
  "type": "object"
3865
3753
  },
3866
3754
  "tooltip": {
3867
- "description": "Tooltip styling",
3755
+ "description": "Custom tooltip styling",
3868
3756
  "properties": {
3869
3757
  "background": {
3870
3758
  "description": "Tooltip's background",
@@ -3907,7 +3795,7 @@ declare const _default: {
3907
3795
  "type": "object"
3908
3796
  },
3909
3797
  "type": {
3910
- "description": "Theme type",
3798
+ "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.",
3911
3799
  "examples": [
3912
3800
  "custom"
3913
3801
  ],