@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
@@ -333,6 +333,9 @@ declare const _default: {
333
333
  "currency_id": {
334
334
  "type": "string"
335
335
  },
336
+ "description": {
337
+ "type": "object"
338
+ },
336
339
  "duration_format": {
337
340
  "enum": [
338
341
  "long",
@@ -1100,37 +1103,8 @@ declare const _default: {
1100
1103
  "theme": {
1101
1104
  "description": "Theme configuration",
1102
1105
  "properties": {
1103
- "axis": {
1104
- "description": "Axis styling",
1105
- "examples": [
1106
- {
1107
- "fontSize": 12
1108
- },
1109
- {
1110
- "fontSize": 10
1111
- }
1112
- ],
1113
- "type": "object"
1114
- },
1115
- "background": {
1116
- "description": "Background color",
1117
- "examples": [
1118
- "rgb(245, 245, 245)",
1119
- "rgb(61, 61, 61)"
1120
- ],
1121
- "type": "string"
1122
- },
1123
- "baseFontSize": {
1124
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
1125
- "examples": [
1126
- 13,
1127
- 16,
1128
- 20
1129
- ],
1130
- "type": "number"
1131
- },
1132
1106
  "borders": {
1133
- "description": "Border styling",
1107
+ "description": "Custom border styling",
1134
1108
  "properties": {
1135
1109
  "border-bottom-width": {
1136
1110
  "description": "Border bottom width",
@@ -1199,7 +1173,7 @@ declare const _default: {
1199
1173
  "type": "object"
1200
1174
  },
1201
1175
  "boxShadow": {
1202
- "description": "Shadow styling",
1176
+ "description": "Custom shadow styling",
1203
1177
  "properties": {
1204
1178
  "color": {
1205
1179
  "description": "Shadow color",
@@ -1229,29 +1203,12 @@ declare const _default: {
1229
1203
  "type": "object"
1230
1204
  },
1231
1205
  "colors": {
1232
- "description": "A list of theme colors",
1206
+ "description": "Custom color palette",
1233
1207
  "examples": [
1234
1208
  [
1235
- "rgb(122, 112, 112)",
1236
- "rgb(175, 169, 169)",
1237
- "rgb(228, 226, 226)"
1238
- ],
1239
- [
1240
- "rgb(48, 36, 179)",
1241
- "rgb(105, 93, 255)",
1242
- "rgb(199, 194, 255)",
1243
- "rgb(134, 4, 129)",
1244
- "rgb(204, 55, 198)",
1245
- "rgb(236, 180, 234)",
1246
- "rgb(220, 141, 0)",
1247
- "rgb(249, 206, 61)",
1248
- "rgb(253, 237, 182)",
1249
- "rgb(6, 142, 84)",
1250
- "rgb(58, 213, 147)",
1251
- "rgb(181, 239, 215)",
1252
- "rgb(85, 78, 78)",
1253
- "rgb(149, 141, 141)",
1254
- "rgb(215, 212, 212)"
1209
+ "rgb(68, 52, 255)",
1210
+ "rgb(68, 52, 255)",
1211
+ "rgb(218, 214, 255)"
1255
1212
  ]
1256
1213
  ],
1257
1214
  "items": {
@@ -1259,24 +1216,8 @@ declare const _default: {
1259
1216
  },
1260
1217
  "type": "array"
1261
1218
  },
1262
- "editBackground": {
1263
- "description": "Edit background",
1264
- "examples": [
1265
- "rgb(228, 228, 228)",
1266
- "rgb(245, 245, 245)",
1267
- "rgb(61, 61, 61)"
1268
- ],
1269
- "type": "string"
1270
- },
1271
- "editModeBackground": {
1272
- "description": "Edit mode background",
1273
- "examples": [
1274
- "rgb(245, 245, 245)"
1275
- ],
1276
- "type": "string"
1277
- },
1278
1219
  "font": {
1279
- "description": "Font styling",
1220
+ "description": "Custom font styling",
1280
1221
  "properties": {
1281
1222
  "font-style": {
1282
1223
  "const": "normal",
@@ -1320,40 +1261,15 @@ declare const _default: {
1320
1261
  "type": "object"
1321
1262
  },
1322
1263
  "id": {
1323
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
1264
+ "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.",
1324
1265
  "examples": [
1325
1266
  "seasonal",
1326
1267
  "urban"
1327
1268
  ],
1328
1269
  "type": "string"
1329
1270
  },
1330
- "itemSpecific": {
1331
- "description": "Item specific styling",
1332
- "properties": {
1333
- "padding": {
1334
- "description": "Padding of the item",
1335
- "examples": [
1336
- 0,
1337
- 4,
1338
- 8,
1339
- 10
1340
- ],
1341
- "type": "number"
1342
- },
1343
- "rounding": {
1344
- "description": "Rounding of the item",
1345
- "examples": [
1346
- 0,
1347
- 8,
1348
- 12
1349
- ],
1350
- "type": "number"
1351
- }
1352
- },
1353
- "type": "object"
1354
- },
1355
1271
  "itemsBackground": {
1356
- "description": "Item background color",
1272
+ "description": "Custom item background color",
1357
1273
  "examples": [
1358
1274
  "rgb(255, 255, 255)",
1359
1275
  "rgb(71, 69, 69)",
@@ -1361,85 +1277,8 @@ declare const _default: {
1361
1277
  ],
1362
1278
  "type": "string"
1363
1279
  },
1364
- "legend": {
1365
- "description": "Legend styling",
1366
- "properties": {
1367
- "fontSize": {
1368
- "description": "Legend font size in px",
1369
- "examples": [
1370
- 12,
1371
- 16
1372
- ],
1373
- "type": "number"
1374
- },
1375
- "lineHeight": {
1376
- "description": "Legend line height in px",
1377
- "examples": [
1378
- 12,
1379
- 16,
1380
- 20
1381
- ],
1382
- "type": "number"
1383
- },
1384
- "type": {
1385
- "description": "Legend type",
1386
- "enum": [
1387
- "circle",
1388
- "line",
1389
- "normal"
1390
- ],
1391
- "examples": [
1392
- "normal",
1393
- "line",
1394
- "circle"
1395
- ],
1396
- "type": "string"
1397
- }
1398
- },
1399
- "type": "object"
1400
- },
1401
- "mainColor": {
1402
- "description": "Theme main color",
1403
- "examples": [
1404
- "rgb(123, 144, 255)",
1405
- "rgb(255, 174, 52)",
1406
- "rgb(123, 144, 255)"
1407
- ],
1408
- "type": "string"
1409
- },
1410
- "margins": {
1411
- "description": "Dashboard vertical and horizontal margins",
1412
- "examples": [
1413
- [
1414
- 16,
1415
- 16
1416
- ],
1417
- [
1418
- 20,
1419
- 20
1420
- ]
1421
- ],
1422
- "items": [
1423
- {
1424
- "type": "number"
1425
- },
1426
- {
1427
- "type": "number"
1428
- }
1429
- ],
1430
- "maxItems": 2,
1431
- "minItems": 2,
1432
- "type": "array"
1433
- },
1434
- "name": {
1435
- "description": "Theme name",
1436
- "examples": [
1437
- "manual"
1438
- ],
1439
- "type": "string"
1440
- },
1441
1280
  "title": {
1442
- "description": "Title styling",
1281
+ "description": "Custom title styling",
1443
1282
  "properties": {
1444
1283
  "align": {
1445
1284
  "description": "Title align",
@@ -1508,7 +1347,7 @@ declare const _default: {
1508
1347
  "type": "object"
1509
1348
  },
1510
1349
  "tooltip": {
1511
- "description": "Tooltip styling",
1350
+ "description": "Custom tooltip styling",
1512
1351
  "properties": {
1513
1352
  "background": {
1514
1353
  "description": "Tooltip's background",
@@ -1551,7 +1390,7 @@ declare const _default: {
1551
1390
  "type": "object"
1552
1391
  },
1553
1392
  "type": {
1554
- "description": "Theme type",
1393
+ "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.",
1555
1394
  "examples": [
1556
1395
  "custom"
1557
1396
  ],
@@ -2326,6 +2326,9 @@ declare const _default: {
2326
2326
  "currency_id": {
2327
2327
  "type": "string"
2328
2328
  },
2329
+ "description": {
2330
+ "type": "object"
2331
+ },
2329
2332
  "duration_format": {
2330
2333
  "enum": [
2331
2334
  "long",
@@ -3147,37 +3150,8 @@ declare const _default: {
3147
3150
  "theme": {
3148
3151
  "description": "Theme configuration",
3149
3152
  "properties": {
3150
- "axis": {
3151
- "description": "Axis styling",
3152
- "examples": [
3153
- {
3154
- "fontSize": 12
3155
- },
3156
- {
3157
- "fontSize": 10
3158
- }
3159
- ],
3160
- "type": "object"
3161
- },
3162
- "background": {
3163
- "description": "Background color",
3164
- "examples": [
3165
- "rgb(245, 245, 245)",
3166
- "rgb(61, 61, 61)"
3167
- ],
3168
- "type": "string"
3169
- },
3170
- "baseFontSize": {
3171
- "description": "Base font size, usually it participates in calculations related to font sizes, spacings, etc.",
3172
- "examples": [
3173
- 13,
3174
- 16,
3175
- 20
3176
- ],
3177
- "type": "number"
3178
- },
3179
3153
  "borders": {
3180
- "description": "Border styling",
3154
+ "description": "Custom border styling",
3181
3155
  "properties": {
3182
3156
  "border-bottom-width": {
3183
3157
  "description": "Border bottom width",
@@ -3246,7 +3220,7 @@ declare const _default: {
3246
3220
  "type": "object"
3247
3221
  },
3248
3222
  "boxShadow": {
3249
- "description": "Shadow styling",
3223
+ "description": "Custom shadow styling",
3250
3224
  "properties": {
3251
3225
  "color": {
3252
3226
  "description": "Shadow color",
@@ -3276,29 +3250,12 @@ declare const _default: {
3276
3250
  "type": "object"
3277
3251
  },
3278
3252
  "colors": {
3279
- "description": "A list of theme colors",
3253
+ "description": "Custom color palette",
3280
3254
  "examples": [
3281
3255
  [
3282
- "rgb(122, 112, 112)",
3283
- "rgb(175, 169, 169)",
3284
- "rgb(228, 226, 226)"
3285
- ],
3286
- [
3287
- "rgb(48, 36, 179)",
3288
- "rgb(105, 93, 255)",
3289
- "rgb(199, 194, 255)",
3290
- "rgb(134, 4, 129)",
3291
- "rgb(204, 55, 198)",
3292
- "rgb(236, 180, 234)",
3293
- "rgb(220, 141, 0)",
3294
- "rgb(249, 206, 61)",
3295
- "rgb(253, 237, 182)",
3296
- "rgb(6, 142, 84)",
3297
- "rgb(58, 213, 147)",
3298
- "rgb(181, 239, 215)",
3299
- "rgb(85, 78, 78)",
3300
- "rgb(149, 141, 141)",
3301
- "rgb(215, 212, 212)"
3256
+ "rgb(68, 52, 255)",
3257
+ "rgb(68, 52, 255)",
3258
+ "rgb(218, 214, 255)"
3302
3259
  ]
3303
3260
  ],
3304
3261
  "items": {
@@ -3306,24 +3263,8 @@ declare const _default: {
3306
3263
  },
3307
3264
  "type": "array"
3308
3265
  },
3309
- "editBackground": {
3310
- "description": "Edit background",
3311
- "examples": [
3312
- "rgb(228, 228, 228)",
3313
- "rgb(245, 245, 245)",
3314
- "rgb(61, 61, 61)"
3315
- ],
3316
- "type": "string"
3317
- },
3318
- "editModeBackground": {
3319
- "description": "Edit mode background",
3320
- "examples": [
3321
- "rgb(245, 245, 245)"
3322
- ],
3323
- "type": "string"
3324
- },
3325
3266
  "font": {
3326
- "description": "Font styling",
3267
+ "description": "Custom font styling",
3327
3268
  "properties": {
3328
3269
  "font-style": {
3329
3270
  "const": "normal",
@@ -3367,40 +3308,15 @@ declare const _default: {
3367
3308
  "type": "object"
3368
3309
  },
3369
3310
  "id": {
3370
- "description": "Id of the theme, like \"seasonal\", \"urban\", etc.",
3311
+ "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.",
3371
3312
  "examples": [
3372
3313
  "seasonal",
3373
3314
  "urban"
3374
3315
  ],
3375
3316
  "type": "string"
3376
3317
  },
3377
- "itemSpecific": {
3378
- "description": "Item specific styling",
3379
- "properties": {
3380
- "padding": {
3381
- "description": "Padding of the item",
3382
- "examples": [
3383
- 0,
3384
- 4,
3385
- 8,
3386
- 10
3387
- ],
3388
- "type": "number"
3389
- },
3390
- "rounding": {
3391
- "description": "Rounding of the item",
3392
- "examples": [
3393
- 0,
3394
- 8,
3395
- 12
3396
- ],
3397
- "type": "number"
3398
- }
3399
- },
3400
- "type": "object"
3401
- },
3402
3318
  "itemsBackground": {
3403
- "description": "Item background color",
3319
+ "description": "Custom item background color",
3404
3320
  "examples": [
3405
3321
  "rgb(255, 255, 255)",
3406
3322
  "rgb(71, 69, 69)",
@@ -3409,7 +3325,7 @@ declare const _default: {
3409
3325
  "type": "string"
3410
3326
  },
3411
3327
  "legend": {
3412
- "description": "Legend styling",
3328
+ "description": "Custom legend styling",
3413
3329
  "properties": {
3414
3330
  "fontSize": {
3415
3331
  "description": "Legend font size in px",
@@ -3445,48 +3361,8 @@ declare const _default: {
3445
3361
  },
3446
3362
  "type": "object"
3447
3363
  },
3448
- "mainColor": {
3449
- "description": "Theme main color",
3450
- "examples": [
3451
- "rgb(123, 144, 255)",
3452
- "rgb(255, 174, 52)",
3453
- "rgb(123, 144, 255)"
3454
- ],
3455
- "type": "string"
3456
- },
3457
- "margins": {
3458
- "description": "Dashboard vertical and horizontal margins",
3459
- "examples": [
3460
- [
3461
- 16,
3462
- 16
3463
- ],
3464
- [
3465
- 20,
3466
- 20
3467
- ]
3468
- ],
3469
- "items": [
3470
- {
3471
- "type": "number"
3472
- },
3473
- {
3474
- "type": "number"
3475
- }
3476
- ],
3477
- "maxItems": 2,
3478
- "minItems": 2,
3479
- "type": "array"
3480
- },
3481
- "name": {
3482
- "description": "Theme name",
3483
- "examples": [
3484
- "manual"
3485
- ],
3486
- "type": "string"
3487
- },
3488
3364
  "title": {
3489
- "description": "Title styling",
3365
+ "description": "Custom title styling",
3490
3366
  "properties": {
3491
3367
  "align": {
3492
3368
  "description": "Title align",
@@ -3555,7 +3431,7 @@ declare const _default: {
3555
3431
  "type": "object"
3556
3432
  },
3557
3433
  "tooltip": {
3558
- "description": "Tooltip styling",
3434
+ "description": "Custom tooltip styling",
3559
3435
  "properties": {
3560
3436
  "background": {
3561
3437
  "description": "Tooltip's background",
@@ -3598,7 +3474,7 @@ declare const _default: {
3598
3474
  "type": "object"
3599
3475
  },
3600
3476
  "type": {
3601
- "description": "Theme type",
3477
+ "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.",
3602
3478
  "examples": [
3603
3479
  "custom"
3604
3480
  ],