@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/bullet-chart-options.schema.json.d.ts CHANGED
@@ -230,6 +230,9 @@ declare const _default: {
230
230
  "currency_id": {
231
231
  "type": "string"
232
232
  },
233
+ "description": {
234
+ "type": "object"
235
+ },
233
236
  "duration_format": {
234
237
  "enum": [
235
238
  "long",
@@ -1058,7 +1061,7 @@ declare const _default: {
1058
1061
  "description": "Theme configuration",
1059
1062
  "properties": {
1060
1063
  "axis": {
1061
- "description": "Axis styling",
1064
+ "description": "Custom axis styling",
1062
1065
  "examples": [
1063
1066
  {
1064
1067
  "fontSize": 12
@@ -1069,25 +1072,8 @@ declare const _default: {
1069
1072
  ],
1070
1073
  "type": "object"
1071
1074
  },
1072
- "background": {
1073
- "description": "Background color",
1074
- "examples": [
1075
- "rgb(245, 245, 245)",
1076
- "rgb(61, 61, 61)"
1077
- ],
1078
- "type": "string"
1079
- },
1080
- "baseFontSize": {
1081
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
1082
- "examples": [
1083
- 13,
1084
- 16,
1085
- 20
1086
- ],
1087
- "type": "number"
1088
- },
1089
1075
  "borders": {
1090
- "description": "Border styling",
1076
+ "description": "Custom border styling",
1091
1077
  "properties": {
1092
1078
  "border-bottom-width": {
1093
1079
  "description": "Border bottom width",
@@ -1156,7 +1142,7 @@ declare const _default: {
1156
1142
  "type": "object"
1157
1143
  },
1158
1144
  "boxShadow": {
1159
- "description": "Shadow styling",
1145
+ "description": "Custom shadow styling",
1160
1146
  "properties": {
1161
1147
  "color": {
1162
1148
  "description": "Shadow color",
@@ -1185,55 +1171,8 @@ declare const _default: {
1185
1171
  },
1186
1172
  "type": "object"
1187
1173
  },
1188
- "colors": {
1189
- "description": "A list of theme colors",
1190
- "examples": [
1191
- [
1192
- "rgb(122, 112, 112)",
1193
- "rgb(175, 169, 169)",
1194
- "rgb(228, 226, 226)"
1195
- ],
1196
- [
1197
- "rgb(48, 36, 179)",
1198
- "rgb(105, 93, 255)",
1199
- "rgb(199, 194, 255)",
1200
- "rgb(134, 4, 129)",
1201
- "rgb(204, 55, 198)",
1202
- "rgb(236, 180, 234)",
1203
- "rgb(220, 141, 0)",
1204
- "rgb(249, 206, 61)",
1205
- "rgb(253, 237, 182)",
1206
- "rgb(6, 142, 84)",
1207
- "rgb(58, 213, 147)",
1208
- "rgb(181, 239, 215)",
1209
- "rgb(85, 78, 78)",
1210
- "rgb(149, 141, 141)",
1211
- "rgb(215, 212, 212)"
1212
- ]
1213
- ],
1214
- "items": {
1215
- "type": "string"
1216
- },
1217
- "type": "array"
1218
- },
1219
- "editBackground": {
1220
- "description": "Edit background",
1221
- "examples": [
1222
- "rgb(228, 228, 228)",
1223
- "rgb(245, 245, 245)",
1224
- "rgb(61, 61, 61)"
1225
- ],
1226
- "type": "string"
1227
- },
1228
- "editModeBackground": {
1229
- "description": "Edit mode background",
1230
- "examples": [
1231
- "rgb(245, 245, 245)"
1232
- ],
1233
- "type": "string"
1234
- },
1235
1174
  "font": {
1236
- "description": "Font styling",
1175
+ "description": "Custom font styling",
1237
1176
  "properties": {
1238
1177
  "font-style": {
1239
1178
  "const": "normal",
@@ -1277,40 +1216,15 @@ declare const _default: {
1277
1216
  "type": "object"
1278
1217
  },
1279
1218
  "id": {
1280
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
1219
+ "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.",
1281
1220
  "examples": [
1282
1221
  "seasonal",
1283
1222
  "urban"
1284
1223
  ],
1285
1224
  "type": "string"
1286
1225
  },
1287
- "itemSpecific": {
1288
- "description": "Item specific styling",
1289
- "properties": {
1290
- "padding": {
1291
- "description": "Padding of the item",
1292
- "examples": [
1293
- 0,
1294
- 4,
1295
- 8,
1296
- 10
1297
- ],
1298
- "type": "number"
1299
- },
1300
- "rounding": {
1301
- "description": "Rounding of the item",
1302
- "examples": [
1303
- 0,
1304
- 8,
1305
- 12
1306
- ],
1307
- "type": "number"
1308
- }
1309
- },
1310
- "type": "object"
1311
- },
1312
1226
  "itemsBackground": {
1313
- "description": "Item background color",
1227
+ "description": "Custom item background color",
1314
1228
  "examples": [
1315
1229
  "rgb(255, 255, 255)",
1316
1230
  "rgb(71, 69, 69)",
@@ -1318,85 +1232,8 @@ declare const _default: {
1318
1232
  ],
1319
1233
  "type": "string"
1320
1234
  },
1321
- "legend": {
1322
- "description": "Legend styling",
1323
- "properties": {
1324
- "fontSize": {
1325
- "description": "Legend font size in px",
1326
- "examples": [
1327
- 12,
1328
- 16
1329
- ],
1330
- "type": "number"
1331
- },
1332
- "lineHeight": {
1333
- "description": "Legend line height in px",
1334
- "examples": [
1335
- 12,
1336
- 16,
1337
- 20
1338
- ],
1339
- "type": "number"
1340
- },
1341
- "type": {
1342
- "description": "Legend type",
1343
- "enum": [
1344
- "circle",
1345
- "line",
1346
- "normal"
1347
- ],
1348
- "examples": [
1349
- "normal",
1350
- "line",
1351
- "circle"
1352
- ],
1353
- "type": "string"
1354
- }
1355
- },
1356
- "type": "object"
1357
- },
1358
- "mainColor": {
1359
- "description": "Theme main color",
1360
- "examples": [
1361
- "rgb(123, 144, 255)",
1362
- "rgb(255, 174, 52)",
1363
- "rgb(123, 144, 255)"
1364
- ],
1365
- "type": "string"
1366
- },
1367
- "margins": {
1368
- "description": "Dashboard vertical and horizontal margins",
1369
- "examples": [
1370
- [
1371
- 16,
1372
- 16
1373
- ],
1374
- [
1375
- 20,
1376
- 20
1377
- ]
1378
- ],
1379
- "items": [
1380
- {
1381
- "type": "number"
1382
- },
1383
- {
1384
- "type": "number"
1385
- }
1386
- ],
1387
- "maxItems": 2,
1388
- "minItems": 2,
1389
- "type": "array"
1390
- },
1391
- "name": {
1392
- "description": "Theme name",
1393
- "examples": [
1394
- "manual"
1395
- ],
1396
- "type": "string"
1397
- },
1398
1235
  "title": {
1399
- "description": "Title styling",
1236
+ "description": "Custom title styling",
1400
1237
  "properties": {
1401
1238
  "align": {
1402
1239
  "description": "Title align",
@@ -1465,7 +1302,7 @@ declare const _default: {
1465
1302
  "type": "object"
1466
1303
  },
1467
1304
  "tooltip": {
1468
- "description": "Tooltip styling",
1305
+ "description": "Custom tooltip styling",
1469
1306
  "properties": {
1470
1307
  "background": {
1471
1308
  "description": "Tooltip's background",
@@ -1508,7 +1345,7 @@ declare const _default: {
1508
1345
  "type": "object"
1509
1346
  },
1510
1347
  "type": {
1511
- "description": "Theme type",
1348
+ "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.",
1512
1349
  "examples": [
1513
1350
  "custom"
1514
1351
  ],
package/assets/json-schemas/choropleth-map-options.schema.json.d.ts CHANGED
@@ -280,6 +280,9 @@ declare const _default: {
280
280
  "currency_id": {
281
281
  "type": "string"
282
282
  },
283
+ "description": {
284
+ "type": "object"
285
+ },
283
286
  "duration_format": {
284
287
  "enum": [
285
288
  "long",
@@ -1095,37 +1098,8 @@ declare const _default: {
1095
1098
  "theme": {
1096
1099
  "description": "Theme configuration",
1097
1100
  "properties": {
1098
- "axis": {
1099
- "description": "Axis styling",
1100
- "examples": [
1101
- {
1102
- "fontSize": 12
1103
- },
1104
- {
1105
- "fontSize": 10
1106
- }
1107
- ],
1108
- "type": "object"
1109
- },
1110
- "background": {
1111
- "description": "Background color",
1112
- "examples": [
1113
- "rgb(245, 245, 245)",
1114
- "rgb(61, 61, 61)"
1115
- ],
1116
- "type": "string"
1117
- },
1118
- "baseFontSize": {
1119
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
1120
- "examples": [
1121
- 13,
1122
- 16,
1123
- 20
1124
- ],
1125
- "type": "number"
1126
- },
1127
1101
  "borders": {
1128
- "description": "Border styling",
1102
+ "description": "Custom border styling",
1129
1103
  "properties": {
1130
1104
  "border-bottom-width": {
1131
1105
  "description": "Border bottom width",
@@ -1194,7 +1168,7 @@ declare const _default: {
1194
1168
  "type": "object"
1195
1169
  },
1196
1170
  "boxShadow": {
1197
- "description": "Shadow styling",
1171
+ "description": "Custom shadow styling",
1198
1172
  "properties": {
1199
1173
  "color": {
1200
1174
  "description": "Shadow color",
@@ -1223,55 +1197,8 @@ declare const _default: {
1223
1197
  },
1224
1198
  "type": "object"
1225
1199
  },
1226
- "colors": {
1227
- "description": "A list of theme colors",
1228
- "examples": [
1229
- [
1230
- "rgb(122, 112, 112)",
1231
- "rgb(175, 169, 169)",
1232
- "rgb(228, 226, 226)"
1233
- ],
1234
- [
1235
- "rgb(48, 36, 179)",
1236
- "rgb(105, 93, 255)",
1237
- "rgb(199, 194, 255)",
1238
- "rgb(134, 4, 129)",
1239
- "rgb(204, 55, 198)",
1240
- "rgb(236, 180, 234)",
1241
- "rgb(220, 141, 0)",
1242
- "rgb(249, 206, 61)",
1243
- "rgb(253, 237, 182)",
1244
- "rgb(6, 142, 84)",
1245
- "rgb(58, 213, 147)",
1246
- "rgb(181, 239, 215)",
1247
- "rgb(85, 78, 78)",
1248
- "rgb(149, 141, 141)",
1249
- "rgb(215, 212, 212)"
1250
- ]
1251
- ],
1252
- "items": {
1253
- "type": "string"
1254
- },
1255
- "type": "array"
1256
- },
1257
- "editBackground": {
1258
- "description": "Edit background",
1259
- "examples": [
1260
- "rgb(228, 228, 228)",
1261
- "rgb(245, 245, 245)",
1262
- "rgb(61, 61, 61)"
1263
- ],
1264
- "type": "string"
1265
- },
1266
- "editModeBackground": {
1267
- "description": "Edit mode background",
1268
- "examples": [
1269
- "rgb(245, 245, 245)"
1270
- ],
1271
- "type": "string"
1272
- },
1273
1200
  "font": {
1274
- "description": "Font styling",
1201
+ "description": "Custom font styling",
1275
1202
  "properties": {
1276
1203
  "font-style": {
1277
1204
  "const": "normal",
@@ -1315,40 +1242,15 @@ declare const _default: {
1315
1242
  "type": "object"
1316
1243
  },
1317
1244
  "id": {
1318
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
1245
+ "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.",
1319
1246
  "examples": [
1320
1247
  "seasonal",
1321
1248
  "urban"
1322
1249
  ],
1323
1250
  "type": "string"
1324
1251
  },
1325
- "itemSpecific": {
1326
- "description": "Item specific styling",
1327
- "properties": {
1328
- "padding": {
1329
- "description": "Padding of the item",
1330
- "examples": [
1331
- 0,
1332
- 4,
1333
- 8,
1334
- 10
1335
- ],
1336
- "type": "number"
1337
- },
1338
- "rounding": {
1339
- "description": "Rounding of the item",
1340
- "examples": [
1341
- 0,
1342
- 8,
1343
- 12
1344
- ],
1345
- "type": "number"
1346
- }
1347
- },
1348
- "type": "object"
1349
- },
1350
1252
  "itemsBackground": {
1351
- "description": "Item background color",
1253
+ "description": "Custom item background color",
1352
1254
  "examples": [
1353
1255
  "rgb(255, 255, 255)",
1354
1256
  "rgb(71, 69, 69)",
@@ -1357,7 +1259,7 @@ declare const _default: {
1357
1259
  "type": "string"
1358
1260
  },
1359
1261
  "legend": {
1360
- "description": "Legend styling",
1262
+ "description": "Custom legend styling",
1361
1263
  "properties": {
1362
1264
  "fontSize": {
1363
1265
  "description": "Legend font size in px",
@@ -1393,48 +1295,8 @@ declare const _default: {
1393
1295
  },
1394
1296
  "type": "object"
1395
1297
  },
1396
- "mainColor": {
1397
- "description": "Theme main color",
1398
- "examples": [
1399
- "rgb(123, 144, 255)",
1400
- "rgb(255, 174, 52)",
1401
- "rgb(123, 144, 255)"
1402
- ],
1403
- "type": "string"
1404
- },
1405
- "margins": {
1406
- "description": "Dashboard vertical and horizontal margins",
1407
- "examples": [
1408
- [
1409
- 16,
1410
- 16
1411
- ],
1412
- [
1413
- 20,
1414
- 20
1415
- ]
1416
- ],
1417
- "items": [
1418
- {
1419
- "type": "number"
1420
- },
1421
- {
1422
- "type": "number"
1423
- }
1424
- ],
1425
- "maxItems": 2,
1426
- "minItems": 2,
1427
- "type": "array"
1428
- },
1429
- "name": {
1430
- "description": "Theme name",
1431
- "examples": [
1432
- "manual"
1433
- ],
1434
- "type": "string"
1435
- },
1436
1298
  "title": {
1437
- "description": "Title styling",
1299
+ "description": "Custom title styling",
1438
1300
  "properties": {
1439
1301
  "align": {
1440
1302
  "description": "Title align",
@@ -1503,7 +1365,7 @@ declare const _default: {
1503
1365
  "type": "object"
1504
1366
  },
1505
1367
  "tooltip": {
1506
- "description": "Tooltip styling",
1368
+ "description": "Custom tooltip styling",
1507
1369
  "properties": {
1508
1370
  "background": {
1509
1371
  "description": "Tooltip's background",
@@ -1546,7 +1408,7 @@ declare const _default: {
1546
1408
  "type": "object"
1547
1409
  },
1548
1410
  "type": {
1549
- "description": "Theme type",
1411
+ "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.",
1550
1412
  "examples": [
1551
1413
  "custom"
1552
1414
  ],