@luzmo/dashboard-contents-types 1.0.1 → 1.0.2

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 (87) hide show
  1. package/CHANGELOG.md +6 -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/slicer-filter-options.schema.json.d.ts +10 -228
  23. package/assets/json-schemas/slider-filter-options.schema.json.d.ts +10 -228
  24. package/assets/json-schemas/text-options.schema.json.d.ts +6 -296
  25. package/index.js +45 -45
  26. package/index.mjs +462 -4273
  27. package/json-schemas.d.ts +63 -2019
  28. package/json-schemas.d.ts.map +1 -1
  29. package/package.json +1 -1
  30. package/src/lib/area-chart/area-chart-options.d.ts +6 -3
  31. package/src/lib/area-chart/area-chart-options.d.ts.map +1 -1
  32. package/src/lib/bar-chart/bar-chart-options.d.ts +6 -3
  33. package/src/lib/bar-chart/bar-chart-options.d.ts.map +1 -1
  34. package/src/lib/box-plot/box-plot-options.d.ts +6 -3
  35. package/src/lib/box-plot/box-plot-options.d.ts.map +1 -1
  36. package/src/lib/bubble-chart/bubble-chart-options.d.ts +6 -3
  37. package/src/lib/bubble-chart/bubble-chart-options.d.ts.map +1 -1
  38. package/src/lib/bullet-chart/bullet-chart-options.d.ts +6 -1
  39. package/src/lib/bullet-chart/bullet-chart-options.d.ts.map +1 -1
  40. package/src/lib/choropleth-map/choropleth-map-options.d.ts +6 -2
  41. package/src/lib/choropleth-map/choropleth-map-options.d.ts.map +1 -1
  42. package/src/lib/circular-gauge/circular-gauge-options.d.ts +6 -1
  43. package/src/lib/circular-gauge/circular-gauge-options.d.ts.map +1 -1
  44. package/src/lib/column-chart/column-chart-options.d.ts +6 -3
  45. package/src/lib/column-chart/column-chart-options.d.ts.map +1 -1
  46. package/src/lib/combination-chart/combination-chart-options.d.ts +6 -3
  47. package/src/lib/combination-chart/combination-chart-options.d.ts.map +1 -1
  48. package/src/lib/conditional-number/conditional-number-options.d.ts +6 -1
  49. package/src/lib/conditional-number/conditional-number-options.d.ts.map +1 -1
  50. package/src/lib/date-filter/date-filter-options.d.ts +6 -2
  51. package/src/lib/date-filter/date-filter-options.d.ts.map +1 -1
  52. package/src/lib/donut-chart/donut-chart-options.d.ts +6 -2
  53. package/src/lib/donut-chart/donut-chart-options.d.ts.map +1 -1
  54. package/src/lib/dropdown-filter/dropdown-filter-options.d.ts +6 -1
  55. package/src/lib/dropdown-filter/dropdown-filter-options.d.ts.map +1 -1
  56. package/src/lib/evolution-number/evolution-number-options.d.ts +6 -1
  57. package/src/lib/evolution-number/evolution-number-options.d.ts.map +1 -1
  58. package/src/lib/funnel-chart/funnel-chart-options.d.ts +6 -2
  59. package/src/lib/funnel-chart/funnel-chart-options.d.ts.map +1 -1
  60. package/src/lib/image/image-options.d.ts +6 -1
  61. package/src/lib/image/image-options.d.ts.map +1 -1
  62. package/src/lib/line-chart/line-chart-options.d.ts +6 -3
  63. package/src/lib/line-chart/line-chart-options.d.ts.map +1 -1
  64. package/src/lib/pivot-table/pivot-table-options.d.ts +6 -2
  65. package/src/lib/pivot-table/pivot-table-options.d.ts.map +1 -1
  66. package/src/lib/regular-table/regular-table-options.d.ts +6 -1
  67. package/src/lib/regular-table/regular-table-options.d.ts.map +1 -1
  68. package/src/lib/sankey-diagram/sankey-diagram-options.d.ts +6 -2
  69. package/src/lib/sankey-diagram/sankey-diagram-options.d.ts.map +1 -1
  70. package/src/lib/scatter-plot/scatter-plot-options.d.ts +6 -3
  71. package/src/lib/scatter-plot/scatter-plot-options.d.ts.map +1 -1
  72. package/src/lib/search-filter/search-filter-options.d.ts +6 -2
  73. package/src/lib/search-filter/search-filter-options.d.ts.map +1 -1
  74. package/src/lib/shared/index.d.ts +1 -3
  75. package/src/lib/shared/index.d.ts.map +1 -1
  76. package/src/lib/shared/slots.d.ts +1 -0
  77. package/src/lib/shared/slots.d.ts.map +1 -1
  78. package/src/lib/shared/theme.d.ts +87 -81
  79. package/src/lib/shared/theme.d.ts.map +1 -1
  80. package/src/lib/slicer-filter/slicer-filter-options.d.ts +6 -2
  81. package/src/lib/slicer-filter/slicer-filter-options.d.ts.map +1 -1
  82. package/src/lib/slider-filter/slider-filter-options.d.ts +6 -2
  83. package/src/lib/slider-filter/slider-filter-options.d.ts.map +1 -1
  84. package/src/lib/text/text-options.d.ts +6 -1
  85. package/src/lib/text/text-options.d.ts.map +1 -1
  86. package/src/lib/shared/axis-view-options.d.ts +0 -3
  87. package/src/lib/shared/axis-view-options.d.ts.map +0 -1
package/assets/json-schemas/sankey-diagram-options.schema.json.d.ts CHANGED
@@ -253,6 +253,9 @@ declare const _default: {
253
253
  "currency_id": {
254
254
  "type": "string"
255
255
  },
256
+ "description": {
257
+ "type": "object"
258
+ },
256
259
  "duration_format": {
257
260
  "enum": [
258
261
  "long",
@@ -994,37 +997,8 @@ declare const _default: {
994
997
  "theme": {
995
998
  "description": "Theme configuration",
996
999
  "properties": {
997
- "axis": {
998
- "description": "Axis styling",
999
- "examples": [
1000
- {
1001
- "fontSize": 12
1002
- },
1003
- {
1004
- "fontSize": 10
1005
- }
1006
- ],
1007
- "type": "object"
1008
- },
1009
- "background": {
1010
- "description": "Background color",
1011
- "examples": [
1012
- "rgb(245, 245, 245)",
1013
- "rgb(61, 61, 61)"
1014
- ],
1015
- "type": "string"
1016
- },
1017
- "baseFontSize": {
1018
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
1019
- "examples": [
1020
- 13,
1021
- 16,
1022
- 20
1023
- ],
1024
- "type": "number"
1025
- },
1026
1000
  "borders": {
1027
- "description": "Border styling",
1001
+ "description": "Custom border styling",
1028
1002
  "properties": {
1029
1003
  "border-bottom-width": {
1030
1004
  "description": "Border bottom width",
@@ -1093,7 +1067,7 @@ declare const _default: {
1093
1067
  "type": "object"
1094
1068
  },
1095
1069
  "boxShadow": {
1096
- "description": "Shadow styling",
1070
+ "description": "Custom shadow styling",
1097
1071
  "properties": {
1098
1072
  "color": {
1099
1073
  "description": "Shadow color",
@@ -1123,29 +1097,12 @@ declare const _default: {
1123
1097
  "type": "object"
1124
1098
  },
1125
1099
  "colors": {
1126
- "description": "A list of theme colors",
1100
+ "description": "Custom color palette",
1127
1101
  "examples": [
1128
1102
  [
1129
- "rgb(122, 112, 112)",
1130
- "rgb(175, 169, 169)",
1131
- "rgb(228, 226, 226)"
1132
- ],
1133
- [
1134
- "rgb(48, 36, 179)",
1135
- "rgb(105, 93, 255)",
1136
- "rgb(199, 194, 255)",
1137
- "rgb(134, 4, 129)",
1138
- "rgb(204, 55, 198)",
1139
- "rgb(236, 180, 234)",
1140
- "rgb(220, 141, 0)",
1141
- "rgb(249, 206, 61)",
1142
- "rgb(253, 237, 182)",
1143
- "rgb(6, 142, 84)",
1144
- "rgb(58, 213, 147)",
1145
- "rgb(181, 239, 215)",
1146
- "rgb(85, 78, 78)",
1147
- "rgb(149, 141, 141)",
1148
- "rgb(215, 212, 212)"
1103
+ "rgb(68, 52, 255)",
1104
+ "rgb(68, 52, 255)",
1105
+ "rgb(218, 214, 255)"
1149
1106
  ]
1150
1107
  ],
1151
1108
  "items": {
@@ -1153,24 +1110,8 @@ declare const _default: {
1153
1110
  },
1154
1111
  "type": "array"
1155
1112
  },
1156
- "editBackground": {
1157
- "description": "Edit background",
1158
- "examples": [
1159
- "rgb(228, 228, 228)",
1160
- "rgb(245, 245, 245)",
1161
- "rgb(61, 61, 61)"
1162
- ],
1163
- "type": "string"
1164
- },
1165
- "editModeBackground": {
1166
- "description": "Edit mode background",
1167
- "examples": [
1168
- "rgb(245, 245, 245)"
1169
- ],
1170
- "type": "string"
1171
- },
1172
1113
  "font": {
1173
- "description": "Font styling",
1114
+ "description": "Custom font styling",
1174
1115
  "properties": {
1175
1116
  "font-style": {
1176
1117
  "const": "normal",
@@ -1214,40 +1155,15 @@ declare const _default: {
1214
1155
  "type": "object"
1215
1156
  },
1216
1157
  "id": {
1217
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
1158
+ "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.",
1218
1159
  "examples": [
1219
1160
  "seasonal",
1220
1161
  "urban"
1221
1162
  ],
1222
1163
  "type": "string"
1223
1164
  },
1224
- "itemSpecific": {
1225
- "description": "Item specific styling",
1226
- "properties": {
1227
- "padding": {
1228
- "description": "Padding of the item",
1229
- "examples": [
1230
- 0,
1231
- 4,
1232
- 8,
1233
- 10
1234
- ],
1235
- "type": "number"
1236
- },
1237
- "rounding": {
1238
- "description": "Rounding of the item",
1239
- "examples": [
1240
- 0,
1241
- 8,
1242
- 12
1243
- ],
1244
- "type": "number"
1245
- }
1246
- },
1247
- "type": "object"
1248
- },
1249
1165
  "itemsBackground": {
1250
- "description": "Item background color",
1166
+ "description": "Custom item background color",
1251
1167
  "examples": [
1252
1168
  "rgb(255, 255, 255)",
1253
1169
  "rgb(71, 69, 69)",
@@ -1255,85 +1171,8 @@ declare const _default: {
1255
1171
  ],
1256
1172
  "type": "string"
1257
1173
  },
1258
- "legend": {
1259
- "description": "Legend styling",
1260
- "properties": {
1261
- "fontSize": {
1262
- "description": "Legend font size in px",
1263
- "examples": [
1264
- 12,
1265
- 16
1266
- ],
1267
- "type": "number"
1268
- },
1269
- "lineHeight": {
1270
- "description": "Legend line height in px",
1271
- "examples": [
1272
- 12,
1273
- 16,
1274
- 20
1275
- ],
1276
- "type": "number"
1277
- },
1278
- "type": {
1279
- "description": "Legend type",
1280
- "enum": [
1281
- "circle",
1282
- "line",
1283
- "normal"
1284
- ],
1285
- "examples": [
1286
- "normal",
1287
- "line",
1288
- "circle"
1289
- ],
1290
- "type": "string"
1291
- }
1292
- },
1293
- "type": "object"
1294
- },
1295
- "mainColor": {
1296
- "description": "Theme main color",
1297
- "examples": [
1298
- "rgb(123, 144, 255)",
1299
- "rgb(255, 174, 52)",
1300
- "rgb(123, 144, 255)"
1301
- ],
1302
- "type": "string"
1303
- },
1304
- "margins": {
1305
- "description": "Dashboard vertical and horizontal margins",
1306
- "examples": [
1307
- [
1308
- 16,
1309
- 16
1310
- ],
1311
- [
1312
- 20,
1313
- 20
1314
- ]
1315
- ],
1316
- "items": [
1317
- {
1318
- "type": "number"
1319
- },
1320
- {
1321
- "type": "number"
1322
- }
1323
- ],
1324
- "maxItems": 2,
1325
- "minItems": 2,
1326
- "type": "array"
1327
- },
1328
- "name": {
1329
- "description": "Theme name",
1330
- "examples": [
1331
- "manual"
1332
- ],
1333
- "type": "string"
1334
- },
1335
1174
  "title": {
1336
- "description": "Title styling",
1175
+ "description": "Custom title styling",
1337
1176
  "properties": {
1338
1177
  "align": {
1339
1178
  "description": "Title align",
@@ -1402,7 +1241,7 @@ declare const _default: {
1402
1241
  "type": "object"
1403
1242
  },
1404
1243
  "tooltip": {
1405
- "description": "Tooltip styling",
1244
+ "description": "Custom tooltip styling",
1406
1245
  "properties": {
1407
1246
  "background": {
1408
1247
  "description": "Tooltip's background",
@@ -1445,7 +1284,7 @@ declare const _default: {
1445
1284
  "type": "object"
1446
1285
  },
1447
1286
  "type": {
1448
- "description": "Theme type",
1287
+ "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.",
1449
1288
  "examples": [
1450
1289
  "custom"
1451
1290
  ],
package/assets/json-schemas/scatter-plot-options.schema.json.d.ts CHANGED
@@ -539,6 +539,9 @@ declare const _default: {
539
539
  "currency_id": {
540
540
  "type": "string"
541
541
  },
542
+ "description": {
543
+ "type": "object"
544
+ },
542
545
  "duration_format": {
543
546
  "enum": [
544
547
  "long",
@@ -1314,7 +1317,7 @@ declare const _default: {
1314
1317
  "description": "Theme configuration",
1315
1318
  "properties": {
1316
1319
  "axis": {
1317
- "description": "Axis styling",
1320
+ "description": "Custom axis styling",
1318
1321
  "examples": [
1319
1322
  {
1320
1323
  "fontSize": 12
@@ -1325,25 +1328,8 @@ declare const _default: {
1325
1328
  ],
1326
1329
  "type": "object"
1327
1330
  },
1328
- "background": {
1329
- "description": "Background color",
1330
- "examples": [
1331
- "rgb(245, 245, 245)",
1332
- "rgb(61, 61, 61)"
1333
- ],
1334
- "type": "string"
1335
- },
1336
- "baseFontSize": {
1337
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
1338
- "examples": [
1339
- 13,
1340
- 16,
1341
- 20
1342
- ],
1343
- "type": "number"
1344
- },
1345
1331
  "borders": {
1346
- "description": "Border styling",
1332
+ "description": "Custom border styling",
1347
1333
  "properties": {
1348
1334
  "border-bottom-width": {
1349
1335
  "description": "Border bottom width",
@@ -1412,7 +1398,7 @@ declare const _default: {
1412
1398
  "type": "object"
1413
1399
  },
1414
1400
  "boxShadow": {
1415
- "description": "Shadow styling",
1401
+ "description": "Custom shadow styling",
1416
1402
  "properties": {
1417
1403
  "color": {
1418
1404
  "description": "Shadow color",
@@ -1442,29 +1428,12 @@ declare const _default: {
1442
1428
  "type": "object"
1443
1429
  },
1444
1430
  "colors": {
1445
- "description": "A list of theme colors",
1431
+ "description": "Custom color palette",
1446
1432
  "examples": [
1447
1433
  [
1448
- "rgb(122, 112, 112)",
1449
- "rgb(175, 169, 169)",
1450
- "rgb(228, 226, 226)"
1451
- ],
1452
- [
1453
- "rgb(48, 36, 179)",
1454
- "rgb(105, 93, 255)",
1455
- "rgb(199, 194, 255)",
1456
- "rgb(134, 4, 129)",
1457
- "rgb(204, 55, 198)",
1458
- "rgb(236, 180, 234)",
1459
- "rgb(220, 141, 0)",
1460
- "rgb(249, 206, 61)",
1461
- "rgb(253, 237, 182)",
1462
- "rgb(6, 142, 84)",
1463
- "rgb(58, 213, 147)",
1464
- "rgb(181, 239, 215)",
1465
- "rgb(85, 78, 78)",
1466
- "rgb(149, 141, 141)",
1467
- "rgb(215, 212, 212)"
1434
+ "rgb(68, 52, 255)",
1435
+ "rgb(68, 52, 255)",
1436
+ "rgb(218, 214, 255)"
1468
1437
  ]
1469
1438
  ],
1470
1439
  "items": {
@@ -1472,24 +1441,8 @@ declare const _default: {
1472
1441
  },
1473
1442
  "type": "array"
1474
1443
  },
1475
- "editBackground": {
1476
- "description": "Edit background",
1477
- "examples": [
1478
- "rgb(228, 228, 228)",
1479
- "rgb(245, 245, 245)",
1480
- "rgb(61, 61, 61)"
1481
- ],
1482
- "type": "string"
1483
- },
1484
- "editModeBackground": {
1485
- "description": "Edit mode background",
1486
- "examples": [
1487
- "rgb(245, 245, 245)"
1488
- ],
1489
- "type": "string"
1490
- },
1491
1444
  "font": {
1492
- "description": "Font styling",
1445
+ "description": "Custom font styling",
1493
1446
  "properties": {
1494
1447
  "font-style": {
1495
1448
  "const": "normal",
@@ -1533,40 +1486,15 @@ declare const _default: {
1533
1486
  "type": "object"
1534
1487
  },
1535
1488
  "id": {
1536
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
1489
+ "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.",
1537
1490
  "examples": [
1538
1491
  "seasonal",
1539
1492
  "urban"
1540
1493
  ],
1541
1494
  "type": "string"
1542
1495
  },
1543
- "itemSpecific": {
1544
- "description": "Item specific styling",
1545
- "properties": {
1546
- "padding": {
1547
- "description": "Padding of the item",
1548
- "examples": [
1549
- 0,
1550
- 4,
1551
- 8,
1552
- 10
1553
- ],
1554
- "type": "number"
1555
- },
1556
- "rounding": {
1557
- "description": "Rounding of the item",
1558
- "examples": [
1559
- 0,
1560
- 8,
1561
- 12
1562
- ],
1563
- "type": "number"
1564
- }
1565
- },
1566
- "type": "object"
1567
- },
1568
1496
  "itemsBackground": {
1569
- "description": "Item background color",
1497
+ "description": "Custom item background color",
1570
1498
  "examples": [
1571
1499
  "rgb(255, 255, 255)",
1572
1500
  "rgb(71, 69, 69)",
@@ -1575,7 +1503,7 @@ declare const _default: {
1575
1503
  "type": "string"
1576
1504
  },
1577
1505
  "legend": {
1578
- "description": "Legend styling",
1506
+ "description": "Custom legend styling",
1579
1507
  "properties": {
1580
1508
  "fontSize": {
1581
1509
  "description": "Legend font size in px",
@@ -1611,48 +1539,8 @@ declare const _default: {
1611
1539
  },
1612
1540
  "type": "object"
1613
1541
  },
1614
- "mainColor": {
1615
- "description": "Theme main color",
1616
- "examples": [
1617
- "rgb(123, 144, 255)",
1618
- "rgb(255, 174, 52)",
1619
- "rgb(123, 144, 255)"
1620
- ],
1621
- "type": "string"
1622
- },
1623
- "margins": {
1624
- "description": "Dashboard vertical and horizontal margins",
1625
- "examples": [
1626
- [
1627
- 16,
1628
- 16
1629
- ],
1630
- [
1631
- 20,
1632
- 20
1633
- ]
1634
- ],
1635
- "items": [
1636
- {
1637
- "type": "number"
1638
- },
1639
- {
1640
- "type": "number"
1641
- }
1642
- ],
1643
- "maxItems": 2,
1644
- "minItems": 2,
1645
- "type": "array"
1646
- },
1647
- "name": {
1648
- "description": "Theme name",
1649
- "examples": [
1650
- "manual"
1651
- ],
1652
- "type": "string"
1653
- },
1654
1542
  "title": {
1655
- "description": "Title styling",
1543
+ "description": "Custom title styling",
1656
1544
  "properties": {
1657
1545
  "align": {
1658
1546
  "description": "Title align",
@@ -1721,7 +1609,7 @@ declare const _default: {
1721
1609
  "type": "object"
1722
1610
  },
1723
1611
  "tooltip": {
1724
- "description": "Tooltip styling",
1612
+ "description": "Custom tooltip styling",
1725
1613
  "properties": {
1726
1614
  "background": {
1727
1615
  "description": "Tooltip's background",
@@ -1764,7 +1652,7 @@ declare const _default: {
1764
1652
  "type": "object"
1765
1653
  },
1766
1654
  "type": {
1767
- "description": "Theme type",
1655
+ "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.",
1768
1656
  "examples": [
1769
1657
  "custom"
1770
1658
  ],