@blueprint-chart/docs 2.11.0 → 2.13.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 (11) hide show
  1. package/package.json +3 -3
  2. package/src/charts/area.md +2 -1
  3. package/src/charts/bar-grouped.md +1 -0
  4. package/src/charts/bar-multi.md +1 -0
  5. package/src/charts/bar-split.md +1 -0
  6. package/src/charts/bar-stacked.md +1 -0
  7. package/src/charts/column-stacked.md +3 -0
  8. package/src/charts/donut.md +1 -0
  9. package/src/charts/line-multi.md +2 -0
  10. package/src/charts/line.md +2 -0
  11. package/src/charts/pie.md +1 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blueprint-chart/docs",
3
- "version": "2.11.0",
3
+ "version": "2.13.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.11.0",
37
- "@blueprint-chart/ui": "2.11.0",
36
+ "@blueprint-chart/lib": "2.13.0",
37
+ "@blueprint-chart/ui": "2.13.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.md CHANGED
@@ -59,6 +59,7 @@ Every property `area` accepts, beside the [frame and layout keys](/reference/dsl
59
59
  | `colorPalette` | select, see [Palettes](/guide/palettes) | `Blueprint` |
60
60
  | `autoContrast` | boolean | `false` |
61
61
  | `allowDarkMode` | boolean | `true` |
62
+ | `areaFillOpacity` | text | `0.25` |
62
63
  | `interpolation` | select: `linear`, `monotoneX`, `step`, `stepBefore`, `stepAfter`, `basis`, `cardinal`, `catmullRom` | `monotoneX` |
63
64
  | `edgePadding` | boolean | `false` |
64
65
  | `showVerticalAxis` | boolean | `false` |
@@ -96,7 +97,7 @@ Every property `area` accepts, beside the [frame and layout keys](/reference/dsl
96
97
  ## Common pitfalls
97
98
 
98
99
  - The y-axis must start at zero — the filled area encodes magnitude
99
- - The fill sits at 0.25 opacity so the line stays readable, and `area` exposes no key to change it; [`area-stacked`](./area-stacked) does, via `areaFillOpacity`
100
+ - The fill sits at 0.25 opacity by default (`areaFillOpacity`) so the line stays readable
100
101
  - Don't stack two area charts by overlapping them; reach for [`area-stacked`](./area-stacked)
101
102
 
102
103
  ## Related types
package/src/charts/bar-grouped.md CHANGED
@@ -54,6 +54,7 @@ Every property `bar-grouped` accepts, beside the [frame and layout keys](/refere
54
54
  | `colorPalette` | select, see [Palettes](/guide/palettes) | `Blueprint` |
55
55
  | `autoContrast` | boolean | `false` |
56
56
  | `allowDarkMode` | boolean | `true` |
57
+ | `barGap` | text | `60` |
57
58
  | `sortMode` | select: `none`, `total`, `within-groups` | `total` |
58
59
  | `legend` | boolean | `true` |
59
60
  | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
package/src/charts/bar-multi.md CHANGED
@@ -58,6 +58,7 @@ Every property `bar-multi` accepts, beside the [frame and layout keys](/referenc
58
58
  | `colorPalette` | select, see [Palettes](/guide/palettes) | `Blueprint` |
59
59
  | `autoContrast` | boolean | `false` |
60
60
  | `allowDarkMode` | boolean | `true` |
61
+ | `barGap` | text | `60` |
61
62
  | `sortMode` | select: `none`, `total`, `within-groups` | `total` |
62
63
  | `legend` | boolean | `false` |
63
64
  | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
package/src/charts/bar-split.md CHANGED
@@ -55,6 +55,7 @@ Every property `bar-split` accepts, beside the [frame and layout keys](/referenc
55
55
  | `colorPalette` | select, see [Palettes](/guide/palettes) | `Blueprint` |
56
56
  | `autoContrast` | boolean | `false` |
57
57
  | `allowDarkMode` | boolean | `true` |
58
+ | `barGap` | text | `60` |
58
59
  | `sharedScale` | boolean | `false` |
59
60
  | `sortMode` | select: `none`, `total`, `within-groups` | `none` |
60
61
  | `legend` | boolean | `true` |
package/src/charts/bar-stacked.md CHANGED
@@ -56,6 +56,7 @@ Every property `bar-stacked` accepts, beside the [frame and layout keys](/refere
56
56
  | `colorPalette` | select, see [Palettes](/guide/palettes) | `Blueprint` |
57
57
  | `autoContrast` | boolean | `false` |
58
58
  | `allowDarkMode` | boolean | `true` |
59
+ | `barGap` | text | `60` |
59
60
  | `stackMode` | select: `normal`, `percent` | `normal` |
60
61
  | `sortMode` | select: `none`, `total`, `within-groups` | `none` |
61
62
  | `legend` | boolean | `true` |
package/src/charts/column-stacked.md CHANGED
@@ -51,6 +51,7 @@ Every property `column-stacked` accepts, beside the [frame and layout keys](/ref
51
51
  | `colorPalette` | select, see [Palettes](/guide/palettes) | `Blueprint` |
52
52
  | `autoContrast` | boolean | `false` |
53
53
  | `allowDarkMode` | boolean | `true` |
54
+ | `barGap` | text | `60` |
54
55
  | `stackMode` | select: `normal`, `percent` | `normal` |
55
56
  | `sortMode` | select: `none`, `total`, `within-groups` | `none` |
56
57
  | `legend` | boolean | `true` |
@@ -80,6 +81,7 @@ Every property `column-stacked` accepts, beside the [frame and layout keys](/ref
80
81
  | `crosshairDirection` | select: `both`, `vertical`, `horizontal` | `both` |
81
82
  | `crosshairStyle` | select: `solid`, `dashed`, `dotted` | `dashed` |
82
83
  | `crosshairColor` | text | `#999` |
84
+ | `showTotal` | boolean | `false` |
83
85
 
84
86
  <!-- options:end -->
85
87
 
@@ -88,6 +90,7 @@ Every property `column-stacked` accepts, beside the [frame and layout keys](/ref
88
90
  - Stacking too many series — the top layers float and lose their baseline
89
91
  - Switching to `stackMode = "percent"` without telling the reader hides the change in absolute total
90
92
  - Inconsistent segment ordering between columns destroys the visual flow
93
+ - `showTotal` labels the sum of the positive segments only; negative segments are left out and a column with no positive value gets no total. It is off in percent mode, where every total would read 100 %
91
94
 
92
95
  ## Related types
93
96
 
package/src/charts/donut.md CHANGED
@@ -66,6 +66,7 @@ Every property `donut` accepts, beside the [frame and layout keys](/reference/ds
66
66
  | `directLabelling` | select: `""`, `auto`, `outside`, `inside` | `auto` |
67
67
  | `tooltips` | boolean | `false` |
68
68
  | `displayAsPercentage` | boolean | `false` |
69
+ | `verticalNumberFormat` | numberFormat | (unset) |
69
70
  | `showTotal` | boolean | `true` |
70
71
  | `showLabels` | boolean | `true` |
71
72
  | `showValues` | boolean | `true` |
package/src/charts/line-multi.md CHANGED
@@ -94,6 +94,8 @@ Every property `line-multi` accepts, beside the [frame and layout keys](/referen
94
94
  | `lineSymbolStyle` | select: `filled`, `hollow` | `filled` |
95
95
  | `lineSymbolSize` | text | `3.5` |
96
96
  | `lineSymbolOpacity` | text | `1` |
97
+ | `valueLabelPoints` | select: `all`, `firstLast`, `last`, `everyN` | `all` |
98
+ | `valueLabelEvery` | text | `2` |
97
99
 
98
100
  <!-- options:end -->
99
101
 
package/src/charts/line.md CHANGED
@@ -90,6 +90,8 @@ Every property `line` accepts, beside the [frame and layout keys](/reference/dsl
90
90
  | `lineSymbolStyle` | select: `filled`, `hollow` | `filled` |
91
91
  | `lineSymbolSize` | text | `3.5` |
92
92
  | `lineSymbolOpacity` | text | `1` |
93
+ | `valueLabelPoints` | select: `all`, `firstLast`, `last`, `everyN` | `all` |
94
+ | `valueLabelEvery` | text | `2` |
93
95
 
94
96
  <!-- options:end -->
95
97
 
package/src/charts/pie.md CHANGED
@@ -63,6 +63,7 @@ Every property `pie` accepts, beside the [frame and layout keys](/reference/dsl/
63
63
  | `directLabelling` | select: `""`, `auto`, `outside`, `inside` | `auto` |
64
64
  | `tooltips` | boolean | `false` |
65
65
  | `displayAsPercentage` | boolean | `true` |
66
+ | `verticalNumberFormat` | numberFormat | (unset) |
66
67
  | `showLabels` | boolean | `true` |
67
68
  | `showValues` | boolean | `true` |
68
69
  | `sliceMax` | text | `5` |