@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/donut-chart-options.schema.json.d.ts CHANGED
@@ -2927,7 +2927,7 @@ declare const _default: {
2927
2927
  "type": "object"
2928
2928
  },
2929
2929
  "legend": {
2930
- "description": "Legend options",
2930
+ "description": "Legend options, they are applied if the legend is displayed",
2931
2931
  "properties": {
2932
2932
  "position": {
2933
2933
  "description": "Position of the legend. Only available when the legend is shown.",
@@ -3171,7 +3171,7 @@ declare const _default: {
3171
3171
  "description": "Custom border styling",
3172
3172
  "properties": {
3173
3173
  "border-bottom-width": {
3174
- "description": "Border bottom width",
3174
+ "description": "Border bottom width, it is visible when a border style and color are set",
3175
3175
  "examples": [
3176
3176
  "0px",
3177
3177
  "1px",
@@ -3180,7 +3180,7 @@ declare const _default: {
3180
3180
  "type": "string"
3181
3181
  },
3182
3182
  "border-color": {
3183
- "description": "Border color",
3183
+ "description": "Border color, it is visible when a border style and width are set",
3184
3184
  "examples": [
3185
3185
  "rgba(216, 216, 216, 1)",
3186
3186
  "rgb(147, 146, 148)"
@@ -3188,7 +3188,7 @@ declare const _default: {
3188
3188
  "type": "string"
3189
3189
  },
3190
3190
  "border-left-width": {
3191
- "description": "Border left width",
3191
+ "description": "Border left width, it is visible when a border style and color are set",
3192
3192
  "examples": [
3193
3193
  "0px",
3194
3194
  "1px",
@@ -3206,7 +3206,7 @@ declare const _default: {
3206
3206
  "type": "string"
3207
3207
  },
3208
3208
  "border-right-width": {
3209
- "description": "Border right width",
3209
+ "description": "Border right width, it is visible when a border style and color are set",
3210
3210
  "examples": [
3211
3211
  "0px",
3212
3212
  "1px",
@@ -3215,7 +3215,7 @@ declare const _default: {
3215
3215
  "type": "string"
3216
3216
  },
3217
3217
  "border-style": {
3218
- "description": "Border style",
3218
+ "description": "Border style, it is visible when a border color and width are set",
3219
3219
  "examples": [
3220
3220
  "none",
3221
3221
  "solid",
@@ -3225,7 +3225,7 @@ declare const _default: {
3225
3225
  "type": "string"
3226
3226
  },
3227
3227
  "border-top-width": {
3228
- "description": "Border top width",
3228
+ "description": "Border top width, it is visible when a border style and color are set",
3229
3229
  "examples": [
3230
3230
  "0px",
3231
3231
  "1px",
@@ -3267,12 +3267,15 @@ declare const _default: {
3267
3267
  "type": "object"
3268
3268
  },
3269
3269
  "colors": {
3270
- "description": "Custom color palette",
3270
+ "description": "Custom color palette, an array of colors which may affect different areas of a chart, for example, lines, bars, etc.",
3271
3271
  "examples": [
3272
3272
  [
3273
- "rgb(68, 52, 255)",
3274
- "rgb(68, 52, 255)",
3275
- "rgb(218, 214, 255)"
3273
+ "red",
3274
+ "green",
3275
+ "blue",
3276
+ "yellow",
3277
+ "orange",
3278
+ "purple"
3276
3279
  ]
3277
3280
  ],
3278
3281
  "items": {
@@ -3283,19 +3286,6 @@ declare const _default: {
3283
3286
  "font": {
3284
3287
  "description": "Custom font styling",
3285
3288
  "properties": {
3286
- "font-style": {
3287
- "const": "normal",
3288
- "description": "Use it to reset the font style to \"normal\"",
3289
- "type": "string"
3290
- },
3291
- "font-weight": {
3292
- "description": "Font weight",
3293
- "examples": [
3294
- 400,
3295
- 700
3296
- ],
3297
- "type": "number"
3298
- },
3299
3289
  "fontFamily": {
3300
3290
  "description": "Font family",
3301
3291
  "examples": [
@@ -3308,7 +3298,7 @@ declare const _default: {
3308
3298
  "type": "string"
3309
3299
  },
3310
3300
  "fontSize": {
3311
- "description": "Font size in px",
3301
+ "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.",
3312
3302
  "examples": [
3313
3303
  10,
3314
3304
  15,
@@ -3337,10 +3327,10 @@ declare const _default: {
3337
3327
  "type": "string"
3338
3328
  },
3339
3329
  "legend": {
3340
- "description": "Custom legend styling",
3330
+ "description": "Custom legend styling, it's applied if the legend is displayed",
3341
3331
  "properties": {
3342
3332
  "fontSize": {
3343
- "description": "Legend font size in px",
3333
+ "description": "Legend font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
3344
3334
  "examples": [
3345
3335
  12,
3346
3336
  16
@@ -3374,7 +3364,7 @@ declare const _default: {
3374
3364
  "type": "object"
3375
3365
  },
3376
3366
  "title": {
3377
- "description": "Custom title styling",
3367
+ "description": "Custom title styling, it's applied if the title is displayed",
3378
3368
  "properties": {
3379
3369
  "align": {
3380
3370
  "description": "Title align",
@@ -3407,7 +3397,7 @@ declare const _default: {
3407
3397
  "type": "boolean"
3408
3398
  },
3409
3399
  "fontSize": {
3410
- "description": "Title's font size in px",
3400
+ "description": "Title's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
3411
3401
  "examples": [
3412
3402
  16,
3413
3403
  20
@@ -3443,7 +3433,7 @@ declare const _default: {
3443
3433
  "type": "object"
3444
3434
  },
3445
3435
  "tooltip": {
3446
- "description": "Custom tooltip styling",
3436
+ "description": "Custom tooltip styling, it's applied if the tooltip is turned on",
3447
3437
  "properties": {
3448
3438
  "background": {
3449
3439
  "description": "Tooltip's background",
@@ -3456,16 +3446,7 @@ declare const _default: {
3456
3446
  "type": "string"
3457
3447
  },
3458
3448
  "fontSize": {
3459
- "description": "Tooltip's font size in px",
3460
- "examples": [
3461
- 12,
3462
- 16,
3463
- 20
3464
- ],
3465
- "type": "number"
3466
- },
3467
- "lineHeight": {
3468
- "description": "Tooltip's line height in px",
3449
+ "description": "Tooltip's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
3469
3450
  "examples": [
3470
3451
  12,
3471
3452
  16,
@@ -3474,7 +3455,7 @@ declare const _default: {
3474
3455
  "type": "number"
3475
3456
  },
3476
3457
  "opacity": {
3477
- "description": "Tooltip's opacity",
3458
+ "description": "Tooltip's opacity, it should be between 0 and 1, for example, 0.8",
3478
3459
  "examples": [
3479
3460
  0.5,
3480
3461
  0.8,
@@ -3504,7 +3485,7 @@ declare const _default: {
3504
3485
  "type": "string"
3505
3486
  },
3506
3487
  "title": {
3507
- "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}",
3488
+ "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}. It's applied if the title is displayed.",
3508
3489
  "examples": [
3509
3490
  {
3510
3491
  "en": "Title"
package/assets/json-schemas/dropdown-filter-options.schema.json.d.ts CHANGED
@@ -914,7 +914,7 @@ declare const _default: {
914
914
  "description": "Custom border styling",
915
915
  "properties": {
916
916
  "border-bottom-width": {
917
- "description": "Border bottom width",
917
+ "description": "Border bottom width, it is visible when a border style and color are set",
918
918
  "examples": [
919
919
  "0px",
920
920
  "1px",
@@ -923,7 +923,7 @@ declare const _default: {
923
923
  "type": "string"
924
924
  },
925
925
  "border-color": {
926
- "description": "Border color",
926
+ "description": "Border color, it is visible when a border style and width are set",
927
927
  "examples": [
928
928
  "rgba(216, 216, 216, 1)",
929
929
  "rgb(147, 146, 148)"
@@ -931,7 +931,7 @@ declare const _default: {
931
931
  "type": "string"
932
932
  },
933
933
  "border-left-width": {
934
- "description": "Border left width",
934
+ "description": "Border left width, it is visible when a border style and color are set",
935
935
  "examples": [
936
936
  "0px",
937
937
  "1px",
@@ -949,7 +949,7 @@ declare const _default: {
949
949
  "type": "string"
950
950
  },
951
951
  "border-right-width": {
952
- "description": "Border right width",
952
+ "description": "Border right width, it is visible when a border style and color are set",
953
953
  "examples": [
954
954
  "0px",
955
955
  "1px",
@@ -958,7 +958,7 @@ declare const _default: {
958
958
  "type": "string"
959
959
  },
960
960
  "border-style": {
961
- "description": "Border style",
961
+ "description": "Border style, it is visible when a border color and width are set",
962
962
  "examples": [
963
963
  "none",
964
964
  "solid",
@@ -968,7 +968,7 @@ declare const _default: {
968
968
  "type": "string"
969
969
  },
970
970
  "border-top-width": {
971
- "description": "Border top width",
971
+ "description": "Border top width, it is visible when a border style and color are set",
972
972
  "examples": [
973
973
  "0px",
974
974
  "1px",
@@ -1012,19 +1012,6 @@ declare const _default: {
1012
1012
  "font": {
1013
1013
  "description": "Custom font styling",
1014
1014
  "properties": {
1015
- "font-style": {
1016
- "const": "normal",
1017
- "description": "Use it to reset the font style to \"normal\"",
1018
- "type": "string"
1019
- },
1020
- "font-weight": {
1021
- "description": "Font weight",
1022
- "examples": [
1023
- 400,
1024
- 700
1025
- ],
1026
- "type": "number"
1027
- },
1028
1015
  "fontFamily": {
1029
1016
  "description": "Font family",
1030
1017
  "examples": [
@@ -1037,7 +1024,7 @@ declare const _default: {
1037
1024
  "type": "string"
1038
1025
  },
1039
1026
  "fontSize": {
1040
- "description": "Font size in px",
1027
+ "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.",
1041
1028
  "examples": [
1042
1029
  10,
1043
1030
  15,
@@ -1066,7 +1053,7 @@ declare const _default: {
1066
1053
  "type": "string"
1067
1054
  },
1068
1055
  "title": {
1069
- "description": "Custom title styling",
1056
+ "description": "Custom title styling, it's applied if the title is displayed",
1070
1057
  "properties": {
1071
1058
  "align": {
1072
1059
  "description": "Title align",
@@ -1099,7 +1086,7 @@ declare const _default: {
1099
1086
  "type": "boolean"
1100
1087
  },
1101
1088
  "fontSize": {
1102
- "description": "Title's font size in px",
1089
+ "description": "Title's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
1103
1090
  "examples": [
1104
1091
  16,
1105
1092
  20
@@ -1153,7 +1140,7 @@ declare const _default: {
1153
1140
  "type": "string"
1154
1141
  },
1155
1142
  "title": {
1156
- "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}",
1143
+ "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}. It's applied if the title is displayed.",
1157
1144
  "examples": [
1158
1145
  {
1159
1146
  "en": "Title"
package/assets/json-schemas/evolution-number-options.schema.json.d.ts CHANGED
@@ -1112,7 +1112,7 @@ declare const _default: {
1112
1112
  "description": "Custom border styling",
1113
1113
  "properties": {
1114
1114
  "border-bottom-width": {
1115
- "description": "Border bottom width",
1115
+ "description": "Border bottom width, it is visible when a border style and color are set",
1116
1116
  "examples": [
1117
1117
  "0px",
1118
1118
  "1px",
@@ -1121,7 +1121,7 @@ declare const _default: {
1121
1121
  "type": "string"
1122
1122
  },
1123
1123
  "border-color": {
1124
- "description": "Border color",
1124
+ "description": "Border color, it is visible when a border style and width are set",
1125
1125
  "examples": [
1126
1126
  "rgba(216, 216, 216, 1)",
1127
1127
  "rgb(147, 146, 148)"
@@ -1129,7 +1129,7 @@ declare const _default: {
1129
1129
  "type": "string"
1130
1130
  },
1131
1131
  "border-left-width": {
1132
- "description": "Border left width",
1132
+ "description": "Border left width, it is visible when a border style and color are set",
1133
1133
  "examples": [
1134
1134
  "0px",
1135
1135
  "1px",
@@ -1147,7 +1147,7 @@ declare const _default: {
1147
1147
  "type": "string"
1148
1148
  },
1149
1149
  "border-right-width": {
1150
- "description": "Border right width",
1150
+ "description": "Border right width, it is visible when a border style and color are set",
1151
1151
  "examples": [
1152
1152
  "0px",
1153
1153
  "1px",
@@ -1156,7 +1156,7 @@ declare const _default: {
1156
1156
  "type": "string"
1157
1157
  },
1158
1158
  "border-style": {
1159
- "description": "Border style",
1159
+ "description": "Border style, it is visible when a border color and width are set",
1160
1160
  "examples": [
1161
1161
  "none",
1162
1162
  "solid",
@@ -1166,7 +1166,7 @@ declare const _default: {
1166
1166
  "type": "string"
1167
1167
  },
1168
1168
  "border-top-width": {
1169
- "description": "Border top width",
1169
+ "description": "Border top width, it is visible when a border style and color are set",
1170
1170
  "examples": [
1171
1171
  "0px",
1172
1172
  "1px",
@@ -1208,12 +1208,15 @@ declare const _default: {
1208
1208
  "type": "object"
1209
1209
  },
1210
1210
  "colors": {
1211
- "description": "Custom color palette",
1211
+ "description": "Custom color palette, an array of colors which may affect different areas of a chart, for example, lines, bars, etc.",
1212
1212
  "examples": [
1213
1213
  [
1214
- "rgb(68, 52, 255)",
1215
- "rgb(68, 52, 255)",
1216
- "rgb(218, 214, 255)"
1214
+ "red",
1215
+ "green",
1216
+ "blue",
1217
+ "yellow",
1218
+ "orange",
1219
+ "purple"
1217
1220
  ]
1218
1221
  ],
1219
1222
  "items": {
@@ -1224,19 +1227,6 @@ declare const _default: {
1224
1227
  "font": {
1225
1228
  "description": "Custom font styling",
1226
1229
  "properties": {
1227
- "font-style": {
1228
- "const": "normal",
1229
- "description": "Use it to reset the font style to \"normal\"",
1230
- "type": "string"
1231
- },
1232
- "font-weight": {
1233
- "description": "Font weight",
1234
- "examples": [
1235
- 400,
1236
- 700
1237
- ],
1238
- "type": "number"
1239
- },
1240
1230
  "fontFamily": {
1241
1231
  "description": "Font family",
1242
1232
  "examples": [
@@ -1249,7 +1239,7 @@ declare const _default: {
1249
1239
  "type": "string"
1250
1240
  },
1251
1241
  "fontSize": {
1252
- "description": "Font size in px",
1242
+ "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.",
1253
1243
  "examples": [
1254
1244
  10,
1255
1245
  15,
@@ -1278,7 +1268,7 @@ declare const _default: {
1278
1268
  "type": "string"
1279
1269
  },
1280
1270
  "title": {
1281
- "description": "Custom title styling",
1271
+ "description": "Custom title styling, it's applied if the title is displayed",
1282
1272
  "properties": {
1283
1273
  "align": {
1284
1274
  "description": "Title align",
@@ -1311,7 +1301,7 @@ declare const _default: {
1311
1301
  "type": "boolean"
1312
1302
  },
1313
1303
  "fontSize": {
1314
- "description": "Title's font size in px",
1304
+ "description": "Title's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
1315
1305
  "examples": [
1316
1306
  16,
1317
1307
  20
@@ -1347,7 +1337,7 @@ declare const _default: {
1347
1337
  "type": "object"
1348
1338
  },
1349
1339
  "tooltip": {
1350
- "description": "Custom tooltip styling",
1340
+ "description": "Custom tooltip styling, it's applied if the tooltip is turned on",
1351
1341
  "properties": {
1352
1342
  "background": {
1353
1343
  "description": "Tooltip's background",
@@ -1360,16 +1350,7 @@ declare const _default: {
1360
1350
  "type": "string"
1361
1351
  },
1362
1352
  "fontSize": {
1363
- "description": "Tooltip's font size in px",
1364
- "examples": [
1365
- 12,
1366
- 16,
1367
- 20
1368
- ],
1369
- "type": "number"
1370
- },
1371
- "lineHeight": {
1372
- "description": "Tooltip's line height in px",
1353
+ "description": "Tooltip's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
1373
1354
  "examples": [
1374
1355
  12,
1375
1356
  16,
@@ -1378,7 +1359,7 @@ declare const _default: {
1378
1359
  "type": "number"
1379
1360
  },
1380
1361
  "opacity": {
1381
- "description": "Tooltip's opacity",
1362
+ "description": "Tooltip's opacity, it should be between 0 and 1, for example, 0.8",
1382
1363
  "examples": [
1383
1364
  0.5,
1384
1365
  0.8,
package/assets/json-schemas/funnel-chart-options.schema.json.d.ts CHANGED
@@ -2950,7 +2950,7 @@ declare const _default: {
2950
2950
  "type": "object"
2951
2951
  },
2952
2952
  "legend": {
2953
- "description": "Legend options",
2953
+ "description": "Legend options, they are applied if the legend is displayed",
2954
2954
  "properties": {
2955
2955
  "position": {
2956
2956
  "description": "Position of the legend. Only available when the legend is shown.",
@@ -3159,7 +3159,7 @@ declare const _default: {
3159
3159
  "description": "Custom border styling",
3160
3160
  "properties": {
3161
3161
  "border-bottom-width": {
3162
- "description": "Border bottom width",
3162
+ "description": "Border bottom width, it is visible when a border style and color are set",
3163
3163
  "examples": [
3164
3164
  "0px",
3165
3165
  "1px",
@@ -3168,7 +3168,7 @@ declare const _default: {
3168
3168
  "type": "string"
3169
3169
  },
3170
3170
  "border-color": {
3171
- "description": "Border color",
3171
+ "description": "Border color, it is visible when a border style and width are set",
3172
3172
  "examples": [
3173
3173
  "rgba(216, 216, 216, 1)",
3174
3174
  "rgb(147, 146, 148)"
@@ -3176,7 +3176,7 @@ declare const _default: {
3176
3176
  "type": "string"
3177
3177
  },
3178
3178
  "border-left-width": {
3179
- "description": "Border left width",
3179
+ "description": "Border left width, it is visible when a border style and color are set",
3180
3180
  "examples": [
3181
3181
  "0px",
3182
3182
  "1px",
@@ -3194,7 +3194,7 @@ declare const _default: {
3194
3194
  "type": "string"
3195
3195
  },
3196
3196
  "border-right-width": {
3197
- "description": "Border right width",
3197
+ "description": "Border right width, it is visible when a border style and color are set",
3198
3198
  "examples": [
3199
3199
  "0px",
3200
3200
  "1px",
@@ -3203,7 +3203,7 @@ declare const _default: {
3203
3203
  "type": "string"
3204
3204
  },
3205
3205
  "border-style": {
3206
- "description": "Border style",
3206
+ "description": "Border style, it is visible when a border color and width are set",
3207
3207
  "examples": [
3208
3208
  "none",
3209
3209
  "solid",
@@ -3213,7 +3213,7 @@ declare const _default: {
3213
3213
  "type": "string"
3214
3214
  },
3215
3215
  "border-top-width": {
3216
- "description": "Border top width",
3216
+ "description": "Border top width, it is visible when a border style and color are set",
3217
3217
  "examples": [
3218
3218
  "0px",
3219
3219
  "1px",
@@ -3255,12 +3255,15 @@ declare const _default: {
3255
3255
  "type": "object"
3256
3256
  },
3257
3257
  "colors": {
3258
- "description": "Custom color palette",
3258
+ "description": "Custom color palette, an array of colors which may affect different areas of a chart, for example, lines, bars, etc.",
3259
3259
  "examples": [
3260
3260
  [
3261
- "rgb(68, 52, 255)",
3262
- "rgb(68, 52, 255)",
3263
- "rgb(218, 214, 255)"
3261
+ "red",
3262
+ "green",
3263
+ "blue",
3264
+ "yellow",
3265
+ "orange",
3266
+ "purple"
3264
3267
  ]
3265
3268
  ],
3266
3269
  "items": {
@@ -3271,19 +3274,6 @@ declare const _default: {
3271
3274
  "font": {
3272
3275
  "description": "Custom font styling",
3273
3276
  "properties": {
3274
- "font-style": {
3275
- "const": "normal",
3276
- "description": "Use it to reset the font style to \"normal\"",
3277
- "type": "string"
3278
- },
3279
- "font-weight": {
3280
- "description": "Font weight",
3281
- "examples": [
3282
- 400,
3283
- 700
3284
- ],
3285
- "type": "number"
3286
- },
3287
3277
  "fontFamily": {
3288
3278
  "description": "Font family",
3289
3279
  "examples": [
@@ -3296,7 +3286,7 @@ declare const _default: {
3296
3286
  "type": "string"
3297
3287
  },
3298
3288
  "fontSize": {
3299
- "description": "Font size in px",
3289
+ "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.",
3300
3290
  "examples": [
3301
3291
  10,
3302
3292
  15,
@@ -3325,10 +3315,10 @@ declare const _default: {
3325
3315
  "type": "string"
3326
3316
  },
3327
3317
  "legend": {
3328
- "description": "Custom legend styling",
3318
+ "description": "Custom legend styling, it's applied if the legend is displayed",
3329
3319
  "properties": {
3330
3320
  "fontSize": {
3331
- "description": "Legend font size in px",
3321
+ "description": "Legend font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
3332
3322
  "examples": [
3333
3323
  12,
3334
3324
  16
@@ -3362,7 +3352,7 @@ declare const _default: {
3362
3352
  "type": "object"
3363
3353
  },
3364
3354
  "title": {
3365
- "description": "Custom title styling",
3355
+ "description": "Custom title styling, it's applied if the title is displayed",
3366
3356
  "properties": {
3367
3357
  "align": {
3368
3358
  "description": "Title align",
@@ -3395,7 +3385,7 @@ declare const _default: {
3395
3385
  "type": "boolean"
3396
3386
  },
3397
3387
  "fontSize": {
3398
- "description": "Title's font size in px",
3388
+ "description": "Title's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
3399
3389
  "examples": [
3400
3390
  16,
3401
3391
  20
@@ -3431,7 +3421,7 @@ declare const _default: {
3431
3421
  "type": "object"
3432
3422
  },
3433
3423
  "tooltip": {
3434
- "description": "Custom tooltip styling",
3424
+ "description": "Custom tooltip styling, it's applied if the tooltip is turned on",
3435
3425
  "properties": {
3436
3426
  "background": {
3437
3427
  "description": "Tooltip's background",
@@ -3444,16 +3434,7 @@ declare const _default: {
3444
3434
  "type": "string"
3445
3435
  },
3446
3436
  "fontSize": {
3447
- "description": "Tooltip's font size in px",
3448
- "examples": [
3449
- 12,
3450
- 16,
3451
- 20
3452
- ],
3453
- "type": "number"
3454
- },
3455
- "lineHeight": {
3456
- "description": "Tooltip's line height in px",
3437
+ "description": "Tooltip's font size in px, if not set, it will be inherited from the \"font\"->\"fontSize\" option",
3457
3438
  "examples": [
3458
3439
  12,
3459
3440
  16,
@@ -3462,7 +3443,7 @@ declare const _default: {
3462
3443
  "type": "number"
3463
3444
  },
3464
3445
  "opacity": {
3465
- "description": "Tooltip's opacity",
3446
+ "description": "Tooltip's opacity, it should be between 0 and 1, for example, 0.8",
3466
3447
  "examples": [
3467
3448
  0.5,
3468
3449
  0.8,
@@ -3492,7 +3473,7 @@ declare const _default: {
3492
3473
  "type": "string"
3493
3474
  },
3494
3475
  "title": {
3495
- "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}",
3476
+ "description": "Title in format { \"locale\": \"title\"}, for example, { \"en\": \"Title\"}. It's applied if the title is displayed.",
3496
3477
  "examples": [
3497
3478
  {
3498
3479
  "en": "Title"