@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/pivot-table-options.schema.json.d.ts CHANGED
@@ -283,6 +283,9 @@ declare const _default: {
283
283
  "currency_id": {
284
284
  "type": "string"
285
285
  },
286
+ "description": {
287
+ "type": "object"
288
+ },
286
289
  "duration_format": {
287
290
  "enum": [
288
291
  "long",
@@ -1115,37 +1118,8 @@ declare const _default: {
1115
1118
  "theme": {
1116
1119
  "description": "Theme configuration",
1117
1120
  "properties": {
1118
- "axis": {
1119
- "description": "Axis styling",
1120
- "examples": [
1121
- {
1122
- "fontSize": 12
1123
- },
1124
- {
1125
- "fontSize": 10
1126
- }
1127
- ],
1128
- "type": "object"
1129
- },
1130
- "background": {
1131
- "description": "Background color",
1132
- "examples": [
1133
- "rgb(245, 245, 245)",
1134
- "rgb(61, 61, 61)"
1135
- ],
1136
- "type": "string"
1137
- },
1138
- "baseFontSize": {
1139
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
1140
- "examples": [
1141
- 13,
1142
- 16,
1143
- 20
1144
- ],
1145
- "type": "number"
1146
- },
1147
1121
  "borders": {
1148
- "description": "Border styling",
1122
+ "description": "Custom border styling",
1149
1123
  "properties": {
1150
1124
  "border-bottom-width": {
1151
1125
  "description": "Border bottom width",
@@ -1214,7 +1188,7 @@ declare const _default: {
1214
1188
  "type": "object"
1215
1189
  },
1216
1190
  "boxShadow": {
1217
- "description": "Shadow styling",
1191
+ "description": "Custom shadow styling",
1218
1192
  "properties": {
1219
1193
  "color": {
1220
1194
  "description": "Shadow color",
@@ -1243,55 +1217,8 @@ declare const _default: {
1243
1217
  },
1244
1218
  "type": "object"
1245
1219
  },
1246
- "colors": {
1247
- "description": "A list of theme colors",
1248
- "examples": [
1249
- [
1250
- "rgb(122, 112, 112)",
1251
- "rgb(175, 169, 169)",
1252
- "rgb(228, 226, 226)"
1253
- ],
1254
- [
1255
- "rgb(48, 36, 179)",
1256
- "rgb(105, 93, 255)",
1257
- "rgb(199, 194, 255)",
1258
- "rgb(134, 4, 129)",
1259
- "rgb(204, 55, 198)",
1260
- "rgb(236, 180, 234)",
1261
- "rgb(220, 141, 0)",
1262
- "rgb(249, 206, 61)",
1263
- "rgb(253, 237, 182)",
1264
- "rgb(6, 142, 84)",
1265
- "rgb(58, 213, 147)",
1266
- "rgb(181, 239, 215)",
1267
- "rgb(85, 78, 78)",
1268
- "rgb(149, 141, 141)",
1269
- "rgb(215, 212, 212)"
1270
- ]
1271
- ],
1272
- "items": {
1273
- "type": "string"
1274
- },
1275
- "type": "array"
1276
- },
1277
- "editBackground": {
1278
- "description": "Edit background",
1279
- "examples": [
1280
- "rgb(228, 228, 228)",
1281
- "rgb(245, 245, 245)",
1282
- "rgb(61, 61, 61)"
1283
- ],
1284
- "type": "string"
1285
- },
1286
- "editModeBackground": {
1287
- "description": "Edit mode background",
1288
- "examples": [
1289
- "rgb(245, 245, 245)"
1290
- ],
1291
- "type": "string"
1292
- },
1293
1220
  "font": {
1294
- "description": "Font styling",
1221
+ "description": "Custom font styling",
1295
1222
  "properties": {
1296
1223
  "font-style": {
1297
1224
  "const": "normal",
@@ -1335,40 +1262,15 @@ declare const _default: {
1335
1262
  "type": "object"
1336
1263
  },
1337
1264
  "id": {
1338
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
1265
+ "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.",
1339
1266
  "examples": [
1340
1267
  "seasonal",
1341
1268
  "urban"
1342
1269
  ],
1343
1270
  "type": "string"
1344
1271
  },
1345
- "itemSpecific": {
1346
- "description": "Item specific styling",
1347
- "properties": {
1348
- "padding": {
1349
- "description": "Padding of the item",
1350
- "examples": [
1351
- 0,
1352
- 4,
1353
- 8,
1354
- 10
1355
- ],
1356
- "type": "number"
1357
- },
1358
- "rounding": {
1359
- "description": "Rounding of the item",
1360
- "examples": [
1361
- 0,
1362
- 8,
1363
- 12
1364
- ],
1365
- "type": "number"
1366
- }
1367
- },
1368
- "type": "object"
1369
- },
1370
1272
  "itemsBackground": {
1371
- "description": "Item background color",
1273
+ "description": "Custom item background color",
1372
1274
  "examples": [
1373
1275
  "rgb(255, 255, 255)",
1374
1276
  "rgb(71, 69, 69)",
@@ -1376,85 +1278,8 @@ declare const _default: {
1376
1278
  ],
1377
1279
  "type": "string"
1378
1280
  },
1379
- "legend": {
1380
- "description": "Legend styling",
1381
- "properties": {
1382
- "fontSize": {
1383
- "description": "Legend font size in px",
1384
- "examples": [
1385
- 12,
1386
- 16
1387
- ],
1388
- "type": "number"
1389
- },
1390
- "lineHeight": {
1391
- "description": "Legend line height in px",
1392
- "examples": [
1393
- 12,
1394
- 16,
1395
- 20
1396
- ],
1397
- "type": "number"
1398
- },
1399
- "type": {
1400
- "description": "Legend type",
1401
- "enum": [
1402
- "circle",
1403
- "line",
1404
- "normal"
1405
- ],
1406
- "examples": [
1407
- "normal",
1408
- "line",
1409
- "circle"
1410
- ],
1411
- "type": "string"
1412
- }
1413
- },
1414
- "type": "object"
1415
- },
1416
- "mainColor": {
1417
- "description": "Theme main color",
1418
- "examples": [
1419
- "rgb(123, 144, 255)",
1420
- "rgb(255, 174, 52)",
1421
- "rgb(123, 144, 255)"
1422
- ],
1423
- "type": "string"
1424
- },
1425
- "margins": {
1426
- "description": "Dashboard vertical and horizontal margins",
1427
- "examples": [
1428
- [
1429
- 16,
1430
- 16
1431
- ],
1432
- [
1433
- 20,
1434
- 20
1435
- ]
1436
- ],
1437
- "items": [
1438
- {
1439
- "type": "number"
1440
- },
1441
- {
1442
- "type": "number"
1443
- }
1444
- ],
1445
- "maxItems": 2,
1446
- "minItems": 2,
1447
- "type": "array"
1448
- },
1449
- "name": {
1450
- "description": "Theme name",
1451
- "examples": [
1452
- "manual"
1453
- ],
1454
- "type": "string"
1455
- },
1456
1281
  "title": {
1457
- "description": "Title styling",
1282
+ "description": "Custom title styling",
1458
1283
  "properties": {
1459
1284
  "align": {
1460
1285
  "description": "Title align",
@@ -1523,7 +1348,7 @@ declare const _default: {
1523
1348
  "type": "object"
1524
1349
  },
1525
1350
  "tooltip": {
1526
- "description": "Tooltip styling",
1351
+ "description": "Custom tooltip styling",
1527
1352
  "properties": {
1528
1353
  "background": {
1529
1354
  "description": "Tooltip's background",
@@ -1566,7 +1391,7 @@ declare const _default: {
1566
1391
  "type": "object"
1567
1392
  },
1568
1393
  "type": {
1569
- "description": "Theme type",
1394
+ "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.",
1570
1395
  "examples": [
1571
1396
  "custom"
1572
1397
  ],
package/assets/json-schemas/regular-table-options.schema.json.d.ts CHANGED
@@ -350,6 +350,9 @@ declare const _default: {
350
350
  "currency_id": {
351
351
  "type": "string"
352
352
  },
353
+ "description": {
354
+ "type": "object"
355
+ },
353
356
  "duration_format": {
354
357
  "enum": [
355
358
  "long",
@@ -1175,37 +1178,8 @@ declare const _default: {
1175
1178
  "theme": {
1176
1179
  "description": "Theme configuration",
1177
1180
  "properties": {
1178
- "axis": {
1179
- "description": "Axis styling",
1180
- "examples": [
1181
- {
1182
- "fontSize": 12
1183
- },
1184
- {
1185
- "fontSize": 10
1186
- }
1187
- ],
1188
- "type": "object"
1189
- },
1190
- "background": {
1191
- "description": "Background color",
1192
- "examples": [
1193
- "rgb(245, 245, 245)",
1194
- "rgb(61, 61, 61)"
1195
- ],
1196
- "type": "string"
1197
- },
1198
- "baseFontSize": {
1199
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
1200
- "examples": [
1201
- 13,
1202
- 16,
1203
- 20
1204
- ],
1205
- "type": "number"
1206
- },
1207
1181
  "borders": {
1208
- "description": "Border styling",
1182
+ "description": "Custom border styling",
1209
1183
  "properties": {
1210
1184
  "border-bottom-width": {
1211
1185
  "description": "Border bottom width",
@@ -1274,7 +1248,7 @@ declare const _default: {
1274
1248
  "type": "object"
1275
1249
  },
1276
1250
  "boxShadow": {
1277
- "description": "Shadow styling",
1251
+ "description": "Custom shadow styling",
1278
1252
  "properties": {
1279
1253
  "color": {
1280
1254
  "description": "Shadow color",
@@ -1303,55 +1277,8 @@ declare const _default: {
1303
1277
  },
1304
1278
  "type": "object"
1305
1279
  },
1306
- "colors": {
1307
- "description": "A list of theme colors",
1308
- "examples": [
1309
- [
1310
- "rgb(122, 112, 112)",
1311
- "rgb(175, 169, 169)",
1312
- "rgb(228, 226, 226)"
1313
- ],
1314
- [
1315
- "rgb(48, 36, 179)",
1316
- "rgb(105, 93, 255)",
1317
- "rgb(199, 194, 255)",
1318
- "rgb(134, 4, 129)",
1319
- "rgb(204, 55, 198)",
1320
- "rgb(236, 180, 234)",
1321
- "rgb(220, 141, 0)",
1322
- "rgb(249, 206, 61)",
1323
- "rgb(253, 237, 182)",
1324
- "rgb(6, 142, 84)",
1325
- "rgb(58, 213, 147)",
1326
- "rgb(181, 239, 215)",
1327
- "rgb(85, 78, 78)",
1328
- "rgb(149, 141, 141)",
1329
- "rgb(215, 212, 212)"
1330
- ]
1331
- ],
1332
- "items": {
1333
- "type": "string"
1334
- },
1335
- "type": "array"
1336
- },
1337
- "editBackground": {
1338
- "description": "Edit background",
1339
- "examples": [
1340
- "rgb(228, 228, 228)",
1341
- "rgb(245, 245, 245)",
1342
- "rgb(61, 61, 61)"
1343
- ],
1344
- "type": "string"
1345
- },
1346
- "editModeBackground": {
1347
- "description": "Edit mode background",
1348
- "examples": [
1349
- "rgb(245, 245, 245)"
1350
- ],
1351
- "type": "string"
1352
- },
1353
1280
  "font": {
1354
- "description": "Font styling",
1281
+ "description": "Custom font styling",
1355
1282
  "properties": {
1356
1283
  "font-style": {
1357
1284
  "const": "normal",
@@ -1395,40 +1322,15 @@ declare const _default: {
1395
1322
  "type": "object"
1396
1323
  },
1397
1324
  "id": {
1398
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
1325
+ "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.",
1399
1326
  "examples": [
1400
1327
  "seasonal",
1401
1328
  "urban"
1402
1329
  ],
1403
1330
  "type": "string"
1404
1331
  },
1405
- "itemSpecific": {
1406
- "description": "Item specific styling",
1407
- "properties": {
1408
- "padding": {
1409
- "description": "Padding of the item",
1410
- "examples": [
1411
- 0,
1412
- 4,
1413
- 8,
1414
- 10
1415
- ],
1416
- "type": "number"
1417
- },
1418
- "rounding": {
1419
- "description": "Rounding of the item",
1420
- "examples": [
1421
- 0,
1422
- 8,
1423
- 12
1424
- ],
1425
- "type": "number"
1426
- }
1427
- },
1428
- "type": "object"
1429
- },
1430
1332
  "itemsBackground": {
1431
- "description": "Item background color",
1333
+ "description": "Custom item background color",
1432
1334
  "examples": [
1433
1335
  "rgb(255, 255, 255)",
1434
1336
  "rgb(71, 69, 69)",
@@ -1436,85 +1338,8 @@ declare const _default: {
1436
1338
  ],
1437
1339
  "type": "string"
1438
1340
  },
1439
- "legend": {
1440
- "description": "Legend styling",
1441
- "properties": {
1442
- "fontSize": {
1443
- "description": "Legend font size in px",
1444
- "examples": [
1445
- 12,
1446
- 16
1447
- ],
1448
- "type": "number"
1449
- },
1450
- "lineHeight": {
1451
- "description": "Legend line height in px",
1452
- "examples": [
1453
- 12,
1454
- 16,
1455
- 20
1456
- ],
1457
- "type": "number"
1458
- },
1459
- "type": {
1460
- "description": "Legend type",
1461
- "enum": [
1462
- "circle",
1463
- "line",
1464
- "normal"
1465
- ],
1466
- "examples": [
1467
- "normal",
1468
- "line",
1469
- "circle"
1470
- ],
1471
- "type": "string"
1472
- }
1473
- },
1474
- "type": "object"
1475
- },
1476
- "mainColor": {
1477
- "description": "Theme main color",
1478
- "examples": [
1479
- "rgb(123, 144, 255)",
1480
- "rgb(255, 174, 52)",
1481
- "rgb(123, 144, 255)"
1482
- ],
1483
- "type": "string"
1484
- },
1485
- "margins": {
1486
- "description": "Dashboard vertical and horizontal margins",
1487
- "examples": [
1488
- [
1489
- 16,
1490
- 16
1491
- ],
1492
- [
1493
- 20,
1494
- 20
1495
- ]
1496
- ],
1497
- "items": [
1498
- {
1499
- "type": "number"
1500
- },
1501
- {
1502
- "type": "number"
1503
- }
1504
- ],
1505
- "maxItems": 2,
1506
- "minItems": 2,
1507
- "type": "array"
1508
- },
1509
- "name": {
1510
- "description": "Theme name",
1511
- "examples": [
1512
- "manual"
1513
- ],
1514
- "type": "string"
1515
- },
1516
1341
  "title": {
1517
- "description": "Title styling",
1342
+ "description": "Custom title styling",
1518
1343
  "properties": {
1519
1344
  "align": {
1520
1345
  "description": "Title align",
@@ -1583,7 +1408,7 @@ declare const _default: {
1583
1408
  "type": "object"
1584
1409
  },
1585
1410
  "tooltip": {
1586
- "description": "Tooltip styling",
1411
+ "description": "Custom tooltip styling",
1587
1412
  "properties": {
1588
1413
  "background": {
1589
1414
  "description": "Tooltip's background",
@@ -1626,7 +1451,7 @@ declare const _default: {
1626
1451
  "type": "object"
1627
1452
  },
1628
1453
  "type": {
1629
- "description": "Theme type",
1454
+ "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.",
1630
1455
  "examples": [
1631
1456
  "custom"
1632
1457
  ],