@blueprint-chart/docs 2.13.0 → 2.15.0

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 (15) hide show
  1. package/package.json +3 -3
  2. package/src/charts/area-stacked.md +1 -0
  3. package/src/charts/area.md +2 -0
  4. package/src/charts/bar-grouped.md +4 -1
  5. package/src/charts/bar-horizontal.md +1 -0
  6. package/src/charts/bar-multi.md +4 -1
  7. package/src/charts/bar-split.md +4 -1
  8. package/src/charts/bar-stacked.md +4 -1
  9. package/src/charts/bar-vertical.md +2 -0
  10. package/src/charts/column-stacked.md +4 -1
  11. package/src/charts/donut.md +4 -0
  12. package/src/charts/dot-plot.md +9 -3
  13. package/src/charts/line-multi.md +2 -0
  14. package/src/charts/line.md +4 -0
  15. package/src/charts/scatter.md +2 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blueprint-chart/docs",
3
- "version": "2.13.0",
3
+ "version": "2.15.0",
4
4
  "description": "Public documentation for Blueprint Chart — handbook, guide, BPC DSL spec, and lib API reference.",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -33,8 +33,8 @@
33
33
  "provenance": true
34
34
  },
35
35
  "devDependencies": {
36
- "@blueprint-chart/lib": "2.13.0",
37
- "@blueprint-chart/ui": "2.13.0",
36
+ "@blueprint-chart/lib": "2.15.0",
37
+ "@blueprint-chart/ui": "2.15.0",
38
38
  "@fontsource-variable/geist": "^5.3.0",
39
39
  "@fontsource-variable/geist-mono": "^5.3.0",
40
40
  "@fontsource/dm-serif-display": "^5.3.0",
package/src/charts/area-stacked.md CHANGED
@@ -78,6 +78,7 @@ Every property `area-stacked` accepts, beside the [frame and layout keys](/refer
78
78
  | `verticalScaleType` | select: `linear`, `log` | `linear` |
79
79
  | `verticalRangeMin` | text | (unset) |
80
80
  | `verticalRangeMax` | text | (unset) |
81
+ | `verticalTickValues` | text | (unset) |
81
82
  | `showHorizontalAxis` | boolean | `true` |
82
83
  | `showHorizontalTicks` | boolean | `false` |
83
84
  | `horizontalLabelPosition` | select: `auto`, `inside`, `outside`, `off` | `auto` |
package/src/charts/area.md CHANGED
@@ -60,6 +60,7 @@ Every property `area` accepts, beside the [frame and layout keys](/reference/dsl
60
60
  | `autoContrast` | boolean | `false` |
61
61
  | `allowDarkMode` | boolean | `true` |
62
62
  | `areaFillOpacity` | text | `0.25` |
63
+ | `areaFillBaseline` | select: `bottom`, `zero` | `bottom` |
63
64
  | `interpolation` | select: `linear`, `monotoneX`, `step`, `stepBefore`, `stepAfter`, `basis`, `cardinal`, `catmullRom` | `monotoneX` |
64
65
  | `edgePadding` | boolean | `false` |
65
66
  | `showVerticalAxis` | boolean | `false` |
@@ -71,6 +72,7 @@ Every property `area` accepts, beside the [frame and layout keys](/reference/dsl
71
72
  | `verticalScaleType` | select: `linear`, `log` | `linear` |
72
73
  | `verticalRangeMin` | text | (unset) |
73
74
  | `verticalRangeMax` | text | (unset) |
75
+ | `verticalTickValues` | text | (unset) |
74
76
  | `showHorizontalAxis` | boolean | `true` |
75
77
  | `showHorizontalTicks` | boolean | `false` |
76
78
  | `horizontalLabelPosition` | select: `auto`, `inside`, `outside`, `off` | `auto` |
package/src/charts/bar-grouped.md CHANGED
@@ -55,7 +55,9 @@ Every property `bar-grouped` accepts, beside the [frame and layout keys](/refere
55
55
  | `autoContrast` | boolean | `false` |
56
56
  | `allowDarkMode` | boolean | `true` |
57
57
  | `barGap` | text | `60` |
58
- | `sortMode` | select: `none`, `total`, `within-groups` | `total` |
58
+ | `sortMode` | select: `none`, `total`, `within-groups`, `series` | `total` |
59
+ | `sortSeries` | select | `""` |
60
+ | `sortReverse` | boolean | `false` |
59
61
  | `legend` | boolean | `true` |
60
62
  | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
61
63
  | `legendPosition` | select: `top`, `bottom`, `left`, `right` | `top` |
@@ -77,6 +79,7 @@ Every property `bar-grouped` accepts, beside the [frame and layout keys](/refere
77
79
  | `horizontalScaleType` | select: `linear`, `log` | `linear` |
78
80
  | `horizontalRangeMin` | text | (unset) |
79
81
  | `horizontalRangeMax` | text | (unset) |
82
+ | `horizontalTickValues` | text | (unset) |
80
83
  | `valueLabels` | boolean | `true` |
81
84
  | `valueLabelPosition` | select: `auto`, `outside`, `inside` | `auto` |
82
85
  | `tooltips` | boolean | `false` |
package/src/charts/bar-horizontal.md CHANGED
@@ -89,6 +89,7 @@ Every property `bar-horizontal` accepts, beside the [frame and layout keys](/ref
89
89
  | `horizontalScaleType` | select: `linear`, `log` | `linear` |
90
90
  | `horizontalRangeMin` | text | (unset) |
91
91
  | `horizontalRangeMax` | text | (unset) |
92
+ | `horizontalTickValues` | text | (unset) |
92
93
  | `valueLabels` | boolean | `true` |
93
94
  | `valueLabelPosition` | select: `auto`, `outside`, `inside` | `auto` |
94
95
  | `tooltips` | boolean | `false` |
package/src/charts/bar-multi.md CHANGED
@@ -59,7 +59,9 @@ Every property `bar-multi` accepts, beside the [frame and layout keys](/referenc
59
59
  | `autoContrast` | boolean | `false` |
60
60
  | `allowDarkMode` | boolean | `true` |
61
61
  | `barGap` | text | `60` |
62
- | `sortMode` | select: `none`, `total`, `within-groups` | `total` |
62
+ | `sortMode` | select: `none`, `total`, `within-groups`, `series` | `total` |
63
+ | `sortSeries` | select | `""` |
64
+ | `sortReverse` | boolean | `false` |
63
65
  | `legend` | boolean | `false` |
64
66
  | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
65
67
  | `legendPosition` | select: `top`, `bottom`, `left`, `right` | `top` |
@@ -74,6 +76,7 @@ Every property `bar-multi` accepts, beside the [frame and layout keys](/referenc
74
76
  | `verticalScaleType` | select: `linear`, `log` | `linear` |
75
77
  | `verticalRangeMin` | text | (unset) |
76
78
  | `verticalRangeMax` | text | (unset) |
79
+ | `verticalTickValues` | text | (unset) |
77
80
  | `showHorizontalAxis` | boolean | `true` |
78
81
  | `showHorizontalTicks` | boolean | `false` |
79
82
  | `horizontalLabelPosition` | select: `auto`, `inside`, `outside`, `off` | `auto` |
package/src/charts/bar-split.md CHANGED
@@ -57,7 +57,9 @@ Every property `bar-split` accepts, beside the [frame and layout keys](/referenc
57
57
  | `allowDarkMode` | boolean | `true` |
58
58
  | `barGap` | text | `60` |
59
59
  | `sharedScale` | boolean | `false` |
60
- | `sortMode` | select: `none`, `total`, `within-groups` | `none` |
60
+ | `sortMode` | select: `none`, `total`, `within-groups`, `series` | `none` |
61
+ | `sortSeries` | select | `""` |
62
+ | `sortReverse` | boolean | `false` |
61
63
  | `legend` | boolean | `true` |
62
64
  | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
63
65
  | `legendPosition` | select: `top`, `bottom`, `left`, `right` | `top` |
@@ -77,6 +79,7 @@ Every property `bar-split` accepts, beside the [frame and layout keys](/referenc
77
79
  | `horizontalScaleType` | select: `linear`, `log` | `linear` |
78
80
  | `horizontalRangeMin` | text | (unset) |
79
81
  | `horizontalRangeMax` | text | (unset) |
82
+ | `horizontalTickValues` | text | (unset) |
80
83
  | `valueLabels` | boolean | `true` |
81
84
  | `valueLabelPosition` | select: `auto`, `outside`, `inside` | `auto` |
82
85
  | `tooltips` | boolean | `false` |
package/src/charts/bar-stacked.md CHANGED
@@ -58,7 +58,9 @@ Every property `bar-stacked` accepts, beside the [frame and layout keys](/refere
58
58
  | `allowDarkMode` | boolean | `true` |
59
59
  | `barGap` | text | `60` |
60
60
  | `stackMode` | select: `normal`, `percent` | `normal` |
61
- | `sortMode` | select: `none`, `total`, `within-groups` | `none` |
61
+ | `sortMode` | select: `none`, `total`, `within-groups`, `series` | `none` |
62
+ | `sortSeries` | select | `""` |
63
+ | `sortReverse` | boolean | `false` |
62
64
  | `legend` | boolean | `true` |
63
65
  | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
64
66
  | `legendPosition` | select: `top`, `bottom`, `left`, `right` | `top` |
@@ -80,6 +82,7 @@ Every property `bar-stacked` accepts, beside the [frame and layout keys](/refere
80
82
  | `horizontalScaleType` | select: `linear`, `log` | `linear` |
81
83
  | `horizontalRangeMin` | text | (unset) |
82
84
  | `horizontalRangeMax` | text | (unset) |
85
+ | `horizontalTickValues` | text | (unset) |
83
86
  | `valueLabels` | boolean | `true` |
84
87
  | `valueLabelPosition` | select: `auto`, `outside`, `inside` | `auto` |
85
88
  | `tooltips` | boolean | `false` |
package/src/charts/bar-vertical.md CHANGED
@@ -66,6 +66,7 @@ Every property `bar-vertical` accepts, beside the [frame and layout keys](/refer
66
66
  | `autoContrast` | boolean | `false` |
67
67
  | `allowDarkMode` | boolean | `true` |
68
68
  | `swapLabelValue` | boolean | `false` |
69
+ | `negativeColor` | text | `""` |
69
70
  | `barBackground` | boolean | `false` |
70
71
  | `barSeparators` | boolean | `false` |
71
72
  | `barGap` | text | `60` |
@@ -83,6 +84,7 @@ Every property `bar-vertical` accepts, beside the [frame and layout keys](/refer
83
84
  | `verticalScaleType` | select: `linear`, `log` | `linear` |
84
85
  | `verticalRangeMin` | text | (unset) |
85
86
  | `verticalRangeMax` | text | (unset) |
87
+ | `verticalTickValues` | text | (unset) |
86
88
  | `showHorizontalAxis` | boolean | `true` |
87
89
  | `showHorizontalTicks` | boolean | `false` |
88
90
  | `horizontalLabelPosition` | select: `auto`, `inside`, `outside`, `off` | `auto` |
package/src/charts/column-stacked.md CHANGED
@@ -53,7 +53,9 @@ Every property `column-stacked` accepts, beside the [frame and layout keys](/ref
53
53
  | `allowDarkMode` | boolean | `true` |
54
54
  | `barGap` | text | `60` |
55
55
  | `stackMode` | select: `normal`, `percent` | `normal` |
56
- | `sortMode` | select: `none`, `total`, `within-groups` | `none` |
56
+ | `sortMode` | select: `none`, `total`, `within-groups`, `series` | `none` |
57
+ | `sortSeries` | select | `""` |
58
+ | `sortReverse` | boolean | `false` |
57
59
  | `legend` | boolean | `true` |
58
60
  | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
59
61
  | `legendPosition` | select: `top`, `bottom`, `left`, `right` | `top` |
@@ -68,6 +70,7 @@ Every property `column-stacked` accepts, beside the [frame and layout keys](/ref
68
70
  | `verticalScaleType` | select: `linear`, `log` | `linear` |
69
71
  | `verticalRangeMin` | text | (unset) |
70
72
  | `verticalRangeMax` | text | (unset) |
73
+ | `verticalTickValues` | text | (unset) |
71
74
  | `showHorizontalAxis` | boolean | `true` |
72
75
  | `showHorizontalTicks` | boolean | `false` |
73
76
  | `horizontalLabelPosition` | select: `auto`, `inside`, `outside`, `off` | `auto` |
package/src/charts/donut.md CHANGED
@@ -68,6 +68,10 @@ Every property `donut` accepts, beside the [frame and layout keys](/reference/ds
68
68
  | `displayAsPercentage` | boolean | `false` |
69
69
  | `verticalNumberFormat` | numberFormat | (unset) |
70
70
  | `showTotal` | boolean | `true` |
71
+ | `centerLabel` | select: `total`, `slice`, `custom` | `total` |
72
+ | `centerSlice` | text | `""` |
73
+ | `centerText` | text | `""` |
74
+ | `totalLabel` | text | `Total` |
71
75
  | `showLabels` | boolean | `true` |
72
76
  | `showValues` | boolean | `true` |
73
77
  | `sliceMax` | text | `6` |
package/src/charts/dot-plot.md CHANGED
@@ -95,10 +95,13 @@ Arrows apply to dumbbells only and are ignored in range style.
95
95
 
96
96
  `sortMode` orders the rows. The default is `value`.
97
97
 
98
- - `value` sorts by the first value column, largest first.
98
+ - `value` sorts by the last value column, largest first.
99
99
  - `gap` sorts by the last value column minus the first, largest first. Outside a dumbbell it falls back to `value`.
100
+ - `change` sorts by the percent change from the first value column to the last, largest first. Rows starting at 0 count as no change. Outside a dumbbell it falls back to `value`.
100
101
  - `none` keeps the order of your data.
101
102
 
103
+ Set `sortReverse = true` to put the smallest first.
104
+
102
105
  ## Labels
103
106
 
104
107
  Value labels are off by default. `valueLabels = true` adds them:
@@ -198,7 +201,8 @@ Every property `dot-plot` accepts, beside the [frame and layout keys](/reference
198
201
  | `low` | text | `""` |
199
202
  | `high` | text | `""` |
200
203
  | `arrows` | select: `none`, `forward`, `backward`, `both` | `none` |
201
- | `sortMode` | select: `none`, `value`, `gap` | `value` |
204
+ | `sortMode` | select: `none`, `value`, `gap`, `change` | `value` |
205
+ | `sortReverse` | boolean | `false` |
202
206
  | `legend` | boolean | `true` |
203
207
  | `legendPosition` | select: `top`, `bottom`, `left`, `right` | `top` |
204
208
  | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
@@ -218,14 +222,16 @@ Every property `dot-plot` accepts, beside the [frame and layout keys](/reference
218
222
  | `horizontalScaleType` | select: `linear`, `log` | `linear` |
219
223
  | `horizontalRangeMin` | text | (unset) |
220
224
  | `horizontalRangeMax` | text | (unset) |
225
+ | `horizontalTickValues` | text | (unset) |
221
226
  | `valueLabels` | boolean | `false` |
227
+ | `dotLabels` | select: `both`, `start`, `end`, `difference`, `change` | `both` |
222
228
  | `tooltips` | boolean | `true` |
223
229
 
224
230
  <!-- options:end -->
225
231
 
226
232
  ## Common pitfalls
227
233
 
228
- - Using `gap` sort on a single value or a range: it falls back to `value`
234
+ - Using `gap` or `change` sort on a single value or a range: it falls back to `value`
229
235
  - Expecting range bars from columns named `High` and `Low` without setting `dotStyle = "range"`: they draw as dumbbell dots instead
230
236
  - Reading the arrow as a trend: it only points from the first column to the last
231
237
  - Using a log axis with values, lows or highs at or below 0: those rows are not drawn and are reported
package/src/charts/line-multi.md CHANGED
@@ -60,6 +60,7 @@ Every property `line-multi` accepts, beside the [frame and layout keys](/referen
60
60
  | `allowDarkMode` | boolean | `true` |
61
61
  | `interpolation` | select: `linear`, `monotoneX`, `step`, `stepBefore`, `stepAfter`, `basis`, `cardinal`, `catmullRom` | `monotoneX` |
62
62
  | `edgePadding` | boolean | `false` |
63
+ | `connectGaps` | boolean | `false` |
63
64
  | `sortMode` | select: `none`, `total`, `within-groups` | `none` |
64
65
  | `legend` | boolean | `false` |
65
66
  | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
@@ -74,6 +75,7 @@ Every property `line-multi` accepts, beside the [frame and layout keys](/referen
74
75
  | `verticalScaleType` | select: `linear`, `log` | `linear` |
75
76
  | `verticalRangeMin` | text | (unset) |
76
77
  | `verticalRangeMax` | text | (unset) |
78
+ | `verticalTickValues` | text | (unset) |
77
79
  | `showHorizontalAxis` | boolean | `true` |
78
80
  | `showHorizontalTicks` | boolean | `false` |
79
81
  | `horizontalLabelPosition` | select: `auto`, `inside`, `outside`, `off` | `auto` |
package/src/charts/line.md CHANGED
@@ -61,6 +61,9 @@ Every property `line` accepts, beside the [frame and layout keys](/reference/dsl
61
61
  | `allowDarkMode` | boolean | `true` |
62
62
  | `interpolation` | select: `linear`, `monotoneX`, `step`, `stepBefore`, `stepAfter`, `basis`, `cardinal`, `catmullRom` | `monotoneX` |
63
63
  | `edgePadding` | boolean | `false` |
64
+ | `connectGaps` | boolean | `false` |
65
+ | `areaFill` | boolean | `false` |
66
+ | `areaFillBaseline` | select: `bottom`, `zero` | `bottom` |
64
67
  | `showVerticalAxis` | boolean | `false` |
65
68
  | `verticalAxisDirection` | select: `left`, `right` | `left` |
66
69
  | `showVerticalTicks` | boolean | `false` |
@@ -70,6 +73,7 @@ Every property `line` accepts, beside the [frame and layout keys](/reference/dsl
70
73
  | `verticalScaleType` | select: `linear`, `log` | `linear` |
71
74
  | `verticalRangeMin` | text | (unset) |
72
75
  | `verticalRangeMax` | text | (unset) |
76
+ | `verticalTickValues` | text | (unset) |
73
77
  | `showHorizontalAxis` | boolean | `true` |
74
78
  | `showHorizontalTicks` | boolean | `false` |
75
79
  | `horizontalLabelPosition` | select: `auto`, `inside`, `outside`, `off` | `auto` |
package/src/charts/scatter.md CHANGED
@@ -179,6 +179,7 @@ Every property `scatter` accepts, beside the [frame and layout keys](/reference/
179
179
  | `verticalScaleType` | select: `linear`, `log`, `symlog` | `linear` |
180
180
  | `verticalRangeMin` | text | (unset) |
181
181
  | `verticalRangeMax` | text | (unset) |
182
+ | `verticalTickValues` | text | (unset) |
182
183
  | `showHorizontalAxis` | boolean | `true` |
183
184
  | `showHorizontalTicks` | boolean | `false` |
184
185
  | `horizontalLabelPosition` | select: `auto`, `inside`, `outside`, `off` | `auto` |
@@ -188,6 +189,7 @@ Every property `scatter` accepts, beside the [frame and layout keys](/reference/
188
189
  | `horizontalScaleType` | select: `linear`, `log`, `symlog` | `linear` |
189
190
  | `horizontalRangeMin` | text | (unset) |
190
191
  | `horizontalRangeMax` | text | (unset) |
192
+ | `horizontalTickValues` | text | (unset) |
191
193
 
192
194
  <!-- options:end -->
193
195