@luzmo/dashboard-contents-types 1.0.5 → 1.0.6

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 (88) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/README.md +132 -0
  3. package/assets/json-schemas/area-chart-options.schema.json.d.ts +23 -42
  4. package/assets/json-schemas/bar-chart-options.schema.json.d.ts +23 -42
  5. package/assets/json-schemas/box-plot-options.schema.json.d.ts +20 -39
  6. package/assets/json-schemas/bubble-chart-options.schema.json.d.ts +23 -42
  7. package/assets/json-schemas/bullet-chart-options.schema.json.d.ts +13 -35
  8. package/assets/json-schemas/choropleth-map-options.schema.json.d.ts +16 -38
  9. package/assets/json-schemas/circular-gauge-options.schema.json.d.ts +20 -39
  10. package/assets/json-schemas/column-chart-options.schema.json.d.ts +23 -42
  11. package/assets/json-schemas/combination-chart-options.schema.json.d.ts +23 -42
  12. package/assets/json-schemas/date-filter-options.schema.json.d.ts +10 -23
  13. package/assets/json-schemas/donut-chart-options.schema.json.d.ts +23 -42
  14. package/assets/json-schemas/dropdown-filter-options.schema.json.d.ts +10 -23
  15. package/assets/json-schemas/evolution-number-options.schema.json.d.ts +19 -38
  16. package/assets/json-schemas/funnel-chart-options.schema.json.d.ts +23 -42
  17. package/assets/json-schemas/heat-map-options.schema.json.d.ts +13 -35
  18. package/assets/json-schemas/heat-table-options.schema.json.d.ts +1514 -0
  19. package/assets/json-schemas/heat-table-slots.schema.json.d.ts +514 -0
  20. package/assets/json-schemas/heat-table.schema.json.d.ts +23 -0
  21. package/assets/json-schemas/hexbin-map-options.schema.json.d.ts +20 -39
  22. package/assets/json-schemas/image-options.schema.json.d.ts +7 -7
  23. package/assets/json-schemas/line-chart-options.schema.json.d.ts +23 -42
  24. package/assets/json-schemas/marker-map-options.schema.json.d.ts +13 -35
  25. package/assets/json-schemas/ohlc-chart-options.schema.json.d.ts +1568 -0
  26. package/assets/json-schemas/ohlc-chart-slots.schema.json.d.ts +578 -0
  27. package/assets/json-schemas/ohlc-chart.schema.json.d.ts +23 -0
  28. package/assets/json-schemas/options.schema.json.d.ts +9 -0
  29. package/assets/json-schemas/pivot-table-options.schema.json.d.ts +13 -35
  30. package/assets/json-schemas/regular-table-options.schema.json.d.ts +13 -35
  31. package/assets/json-schemas/route-map-options.schema.json.d.ts +13 -35
  32. package/assets/json-schemas/sankey-diagram-options.schema.json.d.ts +20 -39
  33. package/assets/json-schemas/scatter-plot-options.schema.json.d.ts +23 -42
  34. package/assets/json-schemas/search-filter-options.schema.json.d.ts +10 -23
  35. package/assets/json-schemas/slicer-filter-options.schema.json.d.ts +10 -23
  36. package/assets/json-schemas/slider-filter-options.schema.json.d.ts +10 -23
  37. package/assets/json-schemas/slots.schema.json.d.ts +9 -0
  38. package/assets/json-schemas/speedometer-chart-options.schema.json.d.ts +10 -23
  39. package/assets/json-schemas/spike-map-options.schema.json.d.ts +20 -39
  40. package/assets/json-schemas/sunburst-chart-options.schema.json.d.ts +1419 -0
  41. package/assets/json-schemas/sunburst-chart-slots.schema.json.d.ts +481 -0
  42. package/assets/json-schemas/sunburst-chart.schema.json.d.ts +23 -0
  43. package/assets/json-schemas/symbol-map-options.schema.json.d.ts +20 -39
  44. package/assets/json-schemas/text-options.schema.json.d.ts +8 -21
  45. package/assets/json-schemas/treemap-chart-options.schema.json.d.ts +23 -42
  46. package/assets/json-schemas/video-options.schema.json.d.ts +7 -20
  47. package/assets/json-schemas/wordcloud-chart-options.schema.json.d.ts +22 -41
  48. package/index.js +95 -65
  49. package/index.mjs +12875 -7305
  50. package/json-schemas.d.ts +8181 -4062
  51. package/json-schemas.d.ts.map +1 -1
  52. package/package.json +1 -1
  53. package/src/index.d.ts +1 -1
  54. package/src/index.d.ts.map +1 -1
  55. package/src/lib/heat-table/heat-table-options.d.ts +186 -0
  56. package/src/lib/heat-table/heat-table-options.d.ts.map +1 -0
  57. package/src/lib/heat-table/heat-table-slots.d.ts +41 -0
  58. package/src/lib/heat-table/heat-table-slots.d.ts.map +1 -0
  59. package/src/lib/heat-table/heat-table.d.ts +24 -0
  60. package/src/lib/heat-table/heat-table.d.ts.map +1 -0
  61. package/src/lib/heat-table/index.d.ts +3 -0
  62. package/src/lib/heat-table/index.d.ts.map +1 -1
  63. package/src/lib/ohlc-chart/index.d.ts +3 -0
  64. package/src/lib/ohlc-chart/index.d.ts.map +1 -1
  65. package/src/lib/ohlc-chart/ohlc-chart-options.d.ts +201 -0
  66. package/src/lib/ohlc-chart/ohlc-chart-options.d.ts.map +1 -0
  67. package/src/lib/ohlc-chart/ohlc-chart-slots.d.ts +63 -0
  68. package/src/lib/ohlc-chart/ohlc-chart-slots.d.ts.map +1 -0
  69. package/src/lib/ohlc-chart/ohlc-chart.d.ts +24 -0
  70. package/src/lib/ohlc-chart/ohlc-chart.d.ts.map +1 -0
  71. package/src/lib/shared/legend.d.ts +1 -1
  72. package/src/lib/shared/slots.d.ts +1 -0
  73. package/src/lib/shared/slots.d.ts.map +1 -1
  74. package/src/lib/shared/theme.d.ts +21 -19
  75. package/src/lib/shared/theme.d.ts.map +1 -1
  76. package/src/lib/shared/title.d.ts +1 -1
  77. package/src/lib/sunburst-chart/index.d.ts +3 -0
  78. package/src/lib/sunburst-chart/index.d.ts.map +1 -1
  79. package/src/lib/sunburst-chart/sunburst-chart-options.d.ts +88 -0
  80. package/src/lib/sunburst-chart/sunburst-chart-options.d.ts.map +1 -0
  81. package/src/lib/sunburst-chart/sunburst-chart-slots.d.ts +29 -0
  82. package/src/lib/sunburst-chart/sunburst-chart-slots.d.ts.map +1 -0
  83. package/src/lib/sunburst-chart/sunburst-chart.d.ts +24 -0
  84. package/src/lib/sunburst-chart/sunburst-chart.d.ts.map +1 -0
  85. package/src/options.d.ts +4 -1
  86. package/src/options.d.ts.map +1 -1
  87. package/src/slots.d.ts +0 -35
  88. package/src/slots.d.ts.map +0 -1
package/assets/json-schemas/pivot-table-options.schema.json.d.ts CHANGED
@@ -1127,7 +1127,7 @@ declare const _default: {
1127
1127
  "description": "Custom border styling",
1128
1128
  "properties": {
1129
1129
  "border-bottom-width": {
1130
- "description": "Border bottom width",
1130
+ "description": "Border bottom width, it is visible when a border style and color are set",
1131
1131
  "examples": [
1132
1132
  "0px",
1133
1133
  "1px",
@@ -1136,7 +1136,7 @@ declare const _default: {
1136
1136
  "type": "string"
1137
1137
  },
1138
1138
  "border-color": {
1139
- "description": "Border color",
1139
+ "description": "Border color, it is visible when a border style and width are set",
1140
1140
  "examples": [
1141
1141
  "rgba(216, 216, 216, 1)",
1142
1142
  "rgb(147, 146, 148)"
@@ -1144,7 +1144,7 @@ declare const _default: {
1144
1144
  "type": "string"
1145
1145
  },
1146
1146
  "border-left-width": {
1147
- "description": "Border left width",
1147
+ "description": "Border left width, it is visible when a border style and color are set",
1148
1148
  "examples": [
1149
1149
  "0px",
1150
1150
  "1px",
@@ -1162,7 +1162,7 @@ declare const _default: {
1162
1162
  "type": "string"
1163
1163
  },
1164
1164
  "border-right-width": {
1165
- "description": "Border right width",
1165
+ "description": "Border right width, it is visible when a border style and color are set",
1166
1166
  "examples": [
1167
1167
  "0px",
1168
1168
  "1px",
@@ -1171,7 +1171,7 @@ declare const _default: {
1171
1171
  "type": "string"
1172
1172
  },
1173
1173
  "border-style": {
1174
- "description": "Border style",
1174
+ "description": "Border style, it is visible when a border color and width are set",
1175
1175
  "examples": [
1176
1176
  "none",
1177
1177
  "solid",
@@ -1181,7 +1181,7 @@ declare const _default: {
1181
1181
  "type": "string"
1182
1182
  },
1183
1183
  "border-top-width": {
1184
- "description": "Border top width",
1184
+ "description": "Border top width, it is visible when a border style and color are set",
1185
1185
  "examples": [
1186
1186
  "0px",
1187
1187
  "1px",
@@ -1225,19 +1225,6 @@ declare const _default: {
1225
1225
  "font": {
1226
1226
  "description": "Custom font styling",
1227
1227
  "properties": {
1228
- "font-style": {
1229
- "const": "normal",
1230
- "description": "Use it to reset the font style to \"normal\"",
1231
- "type": "string"
1232
- },
1233
- "font-weight": {
1234
- "description": "Font weight",
1235
- "examples": [
1236
- 400,
1237
- 700
1238
- ],
1239
- "type": "number"
1240
- },
1241
1228
  "fontFamily": {
1242
1229
  "description": "Font family",
1243
1230
  "examples": [
@@ -1250,7 +1237,7 @@ declare const _default: {
1250
1237
  "type": "string"
1251
1238
  },
1252
1239
  "fontSize": {
1253
- "description": "Font size in px",
1240
+ "description": "Font size in px, if not set, it will be inherited from the theme. It can be overridden if more specific \"fontSize\" is set, for example, \"fontSize\" inside options like \"title\", \"axis\", \"legend\", \"tooltip\", etc.",
1254
1241
  "examples": [
1255
1242
  10,
1256
1243
  15,
@@ -1279,7 +1266,7 @@ declare const _default: {
1279
1266
  "type": "string"
1280
1267
  },
1281
1268
  "title": {
1282
- "description": "Custom title styling",
1269
+ "description": "Custom title styling, it's applied if the title is displayed",
1283
1270
  "properties": {
1284
1271
  "align": {
1285
1272
  "description": "Title align",
@@ -1312,7 +1299,7 @@ declare const _default: {
1312
1299
  "type": "boolean"
1313
1300
  },
1314
1301
  "fontSize": {
1315
- "description": "Title's font size in px",
1302
+ "description": "Title's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
1316
1303
  "examples": [
1317
1304
  16,
1318
1305
  20
@@ -1348,7 +1335,7 @@ declare const _default: {
1348
1335
  "type": "object"
1349
1336
  },
1350
1337
  "tooltip": {
1351
- "description": "Custom tooltip styling",
1338
+ "description": "Custom tooltip styling, it's applied if the tooltip is turned on",
1352
1339
  "properties": {
1353
1340
  "background": {
1354
1341
  "description": "Tooltip's background",
@@ -1361,16 +1348,7 @@ declare const _default: {
1361
1348
  "type": "string"
1362
1349
  },
1363
1350
  "fontSize": {
1364
- "description": "Tooltip's font size in px",
1365
- "examples": [
1366
- 12,
1367
- 16,
1368
- 20
1369
- ],
1370
- "type": "number"
1371
- },
1372
- "lineHeight": {
1373
- "description": "Tooltip's line height in px",
1351
+ "description": "Tooltip's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
1374
1352
  "examples": [
1375
1353
  12,
1376
1354
  16,
@@ -1379,7 +1357,7 @@ declare const _default: {
1379
1357
  "type": "number"
1380
1358
  },
1381
1359
  "opacity": {
1382
- "description": "Tooltip's opacity",
1360
+ "description": "Tooltip's opacity, it should be between 0 and 1, for example, 0.8",
1383
1361
  "examples": [
1384
1362
  0.5,
1385
1363
  0.8,
@@ -1409,7 +1387,7 @@ declare const _default: {
1409
1387
  "type": "string"
1410
1388
  },
1411
1389
  "title": {
1412
- "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}",
1390
+ "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}. It's applied if the title is displayed.",
1413
1391
  "examples": [
1414
1392
  {
1415
1393
  "en": "Title"
package/assets/json-schemas/regular-table-options.schema.json.d.ts CHANGED
@@ -1187,7 +1187,7 @@ declare const _default: {
1187
1187
  "description": "Custom border styling",
1188
1188
  "properties": {
1189
1189
  "border-bottom-width": {
1190
- "description": "Border bottom width",
1190
+ "description": "Border bottom width, it is visible when a border style and color are set",
1191
1191
  "examples": [
1192
1192
  "0px",
1193
1193
  "1px",
@@ -1196,7 +1196,7 @@ declare const _default: {
1196
1196
  "type": "string"
1197
1197
  },
1198
1198
  "border-color": {
1199
- "description": "Border color",
1199
+ "description": "Border color, it is visible when a border style and width are set",
1200
1200
  "examples": [
1201
1201
  "rgba(216, 216, 216, 1)",
1202
1202
  "rgb(147, 146, 148)"
@@ -1204,7 +1204,7 @@ declare const _default: {
1204
1204
  "type": "string"
1205
1205
  },
1206
1206
  "border-left-width": {
1207
- "description": "Border left width",
1207
+ "description": "Border left width, it is visible when a border style and color are set",
1208
1208
  "examples": [
1209
1209
  "0px",
1210
1210
  "1px",
@@ -1222,7 +1222,7 @@ declare const _default: {
1222
1222
  "type": "string"
1223
1223
  },
1224
1224
  "border-right-width": {
1225
- "description": "Border right width",
1225
+ "description": "Border right width, it is visible when a border style and color are set",
1226
1226
  "examples": [
1227
1227
  "0px",
1228
1228
  "1px",
@@ -1231,7 +1231,7 @@ declare const _default: {
1231
1231
  "type": "string"
1232
1232
  },
1233
1233
  "border-style": {
1234
- "description": "Border style",
1234
+ "description": "Border style, it is visible when a border color and width are set",
1235
1235
  "examples": [
1236
1236
  "none",
1237
1237
  "solid",
@@ -1241,7 +1241,7 @@ declare const _default: {
1241
1241
  "type": "string"
1242
1242
  },
1243
1243
  "border-top-width": {
1244
- "description": "Border top width",
1244
+ "description": "Border top width, it is visible when a border style and color are set",
1245
1245
  "examples": [
1246
1246
  "0px",
1247
1247
  "1px",
@@ -1285,19 +1285,6 @@ declare const _default: {
1285
1285
  "font": {
1286
1286
  "description": "Custom font styling",
1287
1287
  "properties": {
1288
- "font-style": {
1289
- "const": "normal",
1290
- "description": "Use it to reset the font style to \"normal\"",
1291
- "type": "string"
1292
- },
1293
- "font-weight": {
1294
- "description": "Font weight",
1295
- "examples": [
1296
- 400,
1297
- 700
1298
- ],
1299
- "type": "number"
1300
- },
1301
1288
  "fontFamily": {
1302
1289
  "description": "Font family",
1303
1290
  "examples": [
@@ -1310,7 +1297,7 @@ declare const _default: {
1310
1297
  "type": "string"
1311
1298
  },
1312
1299
  "fontSize": {
1313
- "description": "Font size in px",
1300
+ "description": "Font size in px, if not set, it will be inherited from the theme. It can be overridden if more specific \"fontSize\" is set, for example, \"fontSize\" inside options like \"title\", \"axis\", \"legend\", \"tooltip\", etc.",
1314
1301
  "examples": [
1315
1302
  10,
1316
1303
  15,
@@ -1339,7 +1326,7 @@ declare const _default: {
1339
1326
  "type": "string"
1340
1327
  },
1341
1328
  "title": {
1342
- "description": "Custom title styling",
1329
+ "description": "Custom title styling, it's applied if the title is displayed",
1343
1330
  "properties": {
1344
1331
  "align": {
1345
1332
  "description": "Title align",
@@ -1372,7 +1359,7 @@ declare const _default: {
1372
1359
  "type": "boolean"
1373
1360
  },
1374
1361
  "fontSize": {
1375
- "description": "Title's font size in px",
1362
+ "description": "Title's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
1376
1363
  "examples": [
1377
1364
  16,
1378
1365
  20
@@ -1408,7 +1395,7 @@ declare const _default: {
1408
1395
  "type": "object"
1409
1396
  },
1410
1397
  "tooltip": {
1411
- "description": "Custom tooltip styling",
1398
+ "description": "Custom tooltip styling, it's applied if the tooltip is turned on",
1412
1399
  "properties": {
1413
1400
  "background": {
1414
1401
  "description": "Tooltip's background",
@@ -1421,16 +1408,7 @@ declare const _default: {
1421
1408
  "type": "string"
1422
1409
  },
1423
1410
  "fontSize": {
1424
- "description": "Tooltip's font size in px",
1425
- "examples": [
1426
- 12,
1427
- 16,
1428
- 20
1429
- ],
1430
- "type": "number"
1431
- },
1432
- "lineHeight": {
1433
- "description": "Tooltip's line height in px",
1411
+ "description": "Tooltip's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
1434
1412
  "examples": [
1435
1413
  12,
1436
1414
  16,
@@ -1439,7 +1417,7 @@ declare const _default: {
1439
1417
  "type": "number"
1440
1418
  },
1441
1419
  "opacity": {
1442
- "description": "Tooltip's opacity",
1420
+ "description": "Tooltip's opacity, it should be between 0 and 1, for example, 0.8",
1443
1421
  "examples": [
1444
1422
  0.5,
1445
1423
  0.8,
@@ -1469,7 +1447,7 @@ declare const _default: {
1469
1447
  "type": "string"
1470
1448
  },
1471
1449
  "title": {
1472
- "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}",
1450
+ "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}. It's applied if the title is displayed.",
1473
1451
  "examples": [
1474
1452
  {
1475
1453
  "en": "Title"
package/assets/json-schemas/route-map-options.schema.json.d.ts CHANGED
@@ -1021,7 +1021,7 @@ declare const _default: {
1021
1021
  "description": "Custom border styling",
1022
1022
  "properties": {
1023
1023
  "border-bottom-width": {
1024
- "description": "Border bottom width",
1024
+ "description": "Border bottom width, it is visible when a border style and color are set",
1025
1025
  "examples": [
1026
1026
  "0px",
1027
1027
  "1px",
@@ -1030,7 +1030,7 @@ declare const _default: {
1030
1030
  "type": "string"
1031
1031
  },
1032
1032
  "border-color": {
1033
- "description": "Border color",
1033
+ "description": "Border color, it is visible when a border style and width are set",
1034
1034
  "examples": [
1035
1035
  "rgba(216, 216, 216, 1)",
1036
1036
  "rgb(147, 146, 148)"
@@ -1038,7 +1038,7 @@ declare const _default: {
1038
1038
  "type": "string"
1039
1039
  },
1040
1040
  "border-left-width": {
1041
- "description": "Border left width",
1041
+ "description": "Border left width, it is visible when a border style and color are set",
1042
1042
  "examples": [
1043
1043
  "0px",
1044
1044
  "1px",
@@ -1056,7 +1056,7 @@ declare const _default: {
1056
1056
  "type": "string"
1057
1057
  },
1058
1058
  "border-right-width": {
1059
- "description": "Border right width",
1059
+ "description": "Border right width, it is visible when a border style and color are set",
1060
1060
  "examples": [
1061
1061
  "0px",
1062
1062
  "1px",
@@ -1065,7 +1065,7 @@ declare const _default: {
1065
1065
  "type": "string"
1066
1066
  },
1067
1067
  "border-style": {
1068
- "description": "Border style",
1068
+ "description": "Border style, it is visible when a border color and width are set",
1069
1069
  "examples": [
1070
1070
  "none",
1071
1071
  "solid",
@@ -1075,7 +1075,7 @@ declare const _default: {
1075
1075
  "type": "string"
1076
1076
  },
1077
1077
  "border-top-width": {
1078
- "description": "Border top width",
1078
+ "description": "Border top width, it is visible when a border style and color are set",
1079
1079
  "examples": [
1080
1080
  "0px",
1081
1081
  "1px",
@@ -1119,19 +1119,6 @@ declare const _default: {
1119
1119
  "font": {
1120
1120
  "description": "Custom font styling",
1121
1121
  "properties": {
1122
- "font-style": {
1123
- "const": "normal",
1124
- "description": "Use it to reset the font style to \"normal\"",
1125
- "type": "string"
1126
- },
1127
- "font-weight": {
1128
- "description": "Font weight",
1129
- "examples": [
1130
- 400,
1131
- 700
1132
- ],
1133
- "type": "number"
1134
- },
1135
1122
  "fontFamily": {
1136
1123
  "description": "Font family",
1137
1124
  "examples": [
@@ -1144,7 +1131,7 @@ declare const _default: {
1144
1131
  "type": "string"
1145
1132
  },
1146
1133
  "fontSize": {
1147
- "description": "Font size in px",
1134
+ "description": "Font size in px, if not set, it will be inherited from the theme. It can be overridden if more specific \"fontSize\" is set, for example, \"fontSize\" inside options like \"title\", \"axis\", \"legend\", \"tooltip\", etc.",
1148
1135
  "examples": [
1149
1136
  10,
1150
1137
  15,
@@ -1173,7 +1160,7 @@ declare const _default: {
1173
1160
  "type": "string"
1174
1161
  },
1175
1162
  "title": {
1176
- "description": "Custom title styling",
1163
+ "description": "Custom title styling, it's applied if the title is displayed",
1177
1164
  "properties": {
1178
1165
  "align": {
1179
1166
  "description": "Title align",
@@ -1206,7 +1193,7 @@ declare const _default: {
1206
1193
  "type": "boolean"
1207
1194
  },
1208
1195
  "fontSize": {
1209
- "description": "Title's font size in px",
1196
+ "description": "Title's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
1210
1197
  "examples": [
1211
1198
  16,
1212
1199
  20
@@ -1242,7 +1229,7 @@ declare const _default: {
1242
1229
  "type": "object"
1243
1230
  },
1244
1231
  "tooltip": {
1245
- "description": "Custom tooltip styling",
1232
+ "description": "Custom tooltip styling, it's applied if the tooltip is turned on",
1246
1233
  "properties": {
1247
1234
  "background": {
1248
1235
  "description": "Tooltip's background",
@@ -1255,16 +1242,7 @@ declare const _default: {
1255
1242
  "type": "string"
1256
1243
  },
1257
1244
  "fontSize": {
1258
- "description": "Tooltip's font size in px",
1259
- "examples": [
1260
- 12,
1261
- 16,
1262
- 20
1263
- ],
1264
- "type": "number"
1265
- },
1266
- "lineHeight": {
1267
- "description": "Tooltip's line height in px",
1245
+ "description": "Tooltip's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
1268
1246
  "examples": [
1269
1247
  12,
1270
1248
  16,
@@ -1273,7 +1251,7 @@ declare const _default: {
1273
1251
  "type": "number"
1274
1252
  },
1275
1253
  "opacity": {
1276
- "description": "Tooltip's opacity",
1254
+ "description": "Tooltip's opacity, it should be between 0 and 1, for example, 0.8",
1277
1255
  "examples": [
1278
1256
  0.5,
1279
1257
  0.8,
@@ -1403,7 +1381,7 @@ declare const _default: {
1403
1381
  "type": "string"
1404
1382
  },
1405
1383
  "title": {
1406
- "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}",
1384
+ "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}. It's applied if the title is displayed.",
1407
1385
  "examples": [
1408
1386
  {
1409
1387
  "en": "Title"
package/assets/json-schemas/sankey-diagram-options.schema.json.d.ts CHANGED
@@ -1006,7 +1006,7 @@ declare const _default: {
1006
1006
  "description": "Custom border styling",
1007
1007
  "properties": {
1008
1008
  "border-bottom-width": {
1009
- "description": "Border bottom width",
1009
+ "description": "Border bottom width, it is visible when a border style and color are set",
1010
1010
  "examples": [
1011
1011
  "0px",
1012
1012
  "1px",
@@ -1015,7 +1015,7 @@ declare const _default: {
1015
1015
  "type": "string"
1016
1016
  },
1017
1017
  "border-color": {
1018
- "description": "Border color",
1018
+ "description": "Border color, it is visible when a border style and width are set",
1019
1019
  "examples": [
1020
1020
  "rgba(216, 216, 216, 1)",
1021
1021
  "rgb(147, 146, 148)"
@@ -1023,7 +1023,7 @@ declare const _default: {
1023
1023
  "type": "string"
1024
1024
  },
1025
1025
  "border-left-width": {
1026
- "description": "Border left width",
1026
+ "description": "Border left width, it is visible when a border style and color are set",
1027
1027
  "examples": [
1028
1028
  "0px",
1029
1029
  "1px",
@@ -1041,7 +1041,7 @@ declare const _default: {
1041
1041
  "type": "string"
1042
1042
  },
1043
1043
  "border-right-width": {
1044
- "description": "Border right width",
1044
+ "description": "Border right width, it is visible when a border style and color are set",
1045
1045
  "examples": [
1046
1046
  "0px",
1047
1047
  "1px",
@@ -1050,7 +1050,7 @@ declare const _default: {
1050
1050
  "type": "string"
1051
1051
  },
1052
1052
  "border-style": {
1053
- "description": "Border style",
1053
+ "description": "Border style, it is visible when a border color and width are set",
1054
1054
  "examples": [
1055
1055
  "none",
1056
1056
  "solid",
@@ -1060,7 +1060,7 @@ declare const _default: {
1060
1060
  "type": "string"
1061
1061
  },
1062
1062
  "border-top-width": {
1063
- "description": "Border top width",
1063
+ "description": "Border top width, it is visible when a border style and color are set",
1064
1064
  "examples": [
1065
1065
  "0px",
1066
1066
  "1px",
@@ -1102,12 +1102,15 @@ declare const _default: {
1102
1102
  "type": "object"
1103
1103
  },
1104
1104
  "colors": {
1105
- "description": "Custom color palette",
1105
+ "description": "Custom color palette, an array of colors which may affect different areas of a chart, for example, lines, bars, etc.",
1106
1106
  "examples": [
1107
1107
  [
1108
- "rgb(68, 52, 255)",
1109
- "rgb(68, 52, 255)",
1110
- "rgb(218, 214, 255)"
1108
+ "red",
1109
+ "green",
1110
+ "blue",
1111
+ "yellow",
1112
+ "orange",
1113
+ "purple"
1111
1114
  ]
1112
1115
  ],
1113
1116
  "items": {
@@ -1118,19 +1121,6 @@ declare const _default: {
1118
1121
  "font": {
1119
1122
  "description": "Custom font styling",
1120
1123
  "properties": {
1121
- "font-style": {
1122
- "const": "normal",
1123
- "description": "Use it to reset the font style to \"normal\"",
1124
- "type": "string"
1125
- },
1126
- "font-weight": {
1127
- "description": "Font weight",
1128
- "examples": [
1129
- 400,
1130
- 700
1131
- ],
1132
- "type": "number"
1133
- },
1134
1124
  "fontFamily": {
1135
1125
  "description": "Font family",
1136
1126
  "examples": [
@@ -1143,7 +1133,7 @@ declare const _default: {
1143
1133
  "type": "string"
1144
1134
  },
1145
1135
  "fontSize": {
1146
- "description": "Font size in px",
1136
+ "description": "Font size in px, if not set, it will be inherited from the theme. It can be overridden if more specific \"fontSize\" is set, for example, \"fontSize\" inside options like \"title\", \"axis\", \"legend\", \"tooltip\", etc.",
1147
1137
  "examples": [
1148
1138
  10,
1149
1139
  15,
@@ -1172,7 +1162,7 @@ declare const _default: {
1172
1162
  "type": "string"
1173
1163
  },
1174
1164
  "title": {
1175
- "description": "Custom title styling",
1165
+ "description": "Custom title styling, it's applied if the title is displayed",
1176
1166
  "properties": {
1177
1167
  "align": {
1178
1168
  "description": "Title align",
@@ -1205,7 +1195,7 @@ declare const _default: {
1205
1195
  "type": "boolean"
1206
1196
  },
1207
1197
  "fontSize": {
1208
- "description": "Title's font size in px",
1198
+ "description": "Title's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
1209
1199
  "examples": [
1210
1200
  16,
1211
1201
  20
@@ -1241,7 +1231,7 @@ declare const _default: {
1241
1231
  "type": "object"
1242
1232
  },
1243
1233
  "tooltip": {
1244
- "description": "Custom tooltip styling",
1234
+ "description": "Custom tooltip styling, it's applied if the tooltip is turned on",
1245
1235
  "properties": {
1246
1236
  "background": {
1247
1237
  "description": "Tooltip's background",
@@ -1254,16 +1244,7 @@ declare const _default: {
1254
1244
  "type": "string"
1255
1245
  },
1256
1246
  "fontSize": {
1257
- "description": "Tooltip's font size in px",
1258
- "examples": [
1259
- 12,
1260
- 16,
1261
- 20
1262
- ],
1263
- "type": "number"
1264
- },
1265
- "lineHeight": {
1266
- "description": "Tooltip's line height in px",
1247
+ "description": "Tooltip's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
1267
1248
  "examples": [
1268
1249
  12,
1269
1250
  16,
@@ -1272,7 +1253,7 @@ declare const _default: {
1272
1253
  "type": "number"
1273
1254
  },
1274
1255
  "opacity": {
1275
- "description": "Tooltip's opacity",
1256
+ "description": "Tooltip's opacity, it should be between 0 and 1, for example, 0.8",
1276
1257
  "examples": [
1277
1258
  0.5,
1278
1259
  0.8,
@@ -1302,7 +1283,7 @@ declare const _default: {
1302
1283
  "type": "string"
1303
1284
  },
1304
1285
  "title": {
1305
- "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}",
1286
+ "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}. It's applied if the title is displayed.",
1306
1287
  "examples": [
1307
1288
  {
1308
1289
  "en": "Title"