@blueprint-chart/docs 2.12.0 → 2.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blueprint-chart/docs",
-  "version": "2.12.0",
+  "version": "2.14.0",
   "description": "Public documentation for Blueprint Chart — handbook, guide, BPC DSL spec, and lib API reference.",
   "type": "module",
   "license": "MIT",
@@ -33,8 +33,8 @@
     "provenance": true
   },
   "devDependencies": {
-    "@blueprint-chart/lib": "2.12.0",
-    "@blueprint-chart/ui": "2.12.0",
+    "@blueprint-chart/lib": "2.14.0",
+    "@blueprint-chart/ui": "2.14.0",
     "@fontsource-variable/geist": "^5.3.0",
     "@fontsource-variable/geist-mono": "^5.3.0",
     "@fontsource/dm-serif-display": "^5.3.0",

package/src/charts/bar-grouped.md

@@ -55,7 +55,9 @@ Every property `bar-grouped` accepts, beside the [frame and layout keys](/refere
 | `autoContrast` | boolean | `false` |
 | `allowDarkMode` | boolean | `true` |
 | `barGap` | text | `60` |
-| `sortMode` | select: `none`, `total`, `within-groups` | `total` |
+| `sortMode` | select: `none`, `total`, `within-groups`, `series` | `total` |
+| `sortSeries` | select | `""` |
+| `sortReverse` | boolean | `false` |
 | `legend` | boolean | `true` |
 | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
 | `legendPosition` | select: `top`, `bottom`, `left`, `right` | `top` |

package/src/charts/bar-multi.md

@@ -59,7 +59,9 @@ Every property `bar-multi` accepts, beside the [frame and layout keys](/referenc
 | `autoContrast` | boolean | `false` |
 | `allowDarkMode` | boolean | `true` |
 | `barGap` | text | `60` |
-| `sortMode` | select: `none`, `total`, `within-groups` | `total` |
+| `sortMode` | select: `none`, `total`, `within-groups`, `series` | `total` |
+| `sortSeries` | select | `""` |
+| `sortReverse` | boolean | `false` |
 | `legend` | boolean | `false` |
 | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
 | `legendPosition` | select: `top`, `bottom`, `left`, `right` | `top` |

package/src/charts/bar-split.md

@@ -57,7 +57,9 @@ Every property `bar-split` accepts, beside the [frame and layout keys](/referenc
 | `allowDarkMode` | boolean | `true` |
 | `barGap` | text | `60` |
 | `sharedScale` | boolean | `false` |
-| `sortMode` | select: `none`, `total`, `within-groups` | `none` |
+| `sortMode` | select: `none`, `total`, `within-groups`, `series` | `none` |
+| `sortSeries` | select | `""` |
+| `sortReverse` | boolean | `false` |
 | `legend` | boolean | `true` |
 | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
 | `legendPosition` | select: `top`, `bottom`, `left`, `right` | `top` |

package/src/charts/bar-stacked.md

@@ -58,7 +58,9 @@ Every property `bar-stacked` accepts, beside the [frame and layout keys](/refere
 | `allowDarkMode` | boolean | `true` |
 | `barGap` | text | `60` |
 | `stackMode` | select: `normal`, `percent` | `normal` |
-| `sortMode` | select: `none`, `total`, `within-groups` | `none` |
+| `sortMode` | select: `none`, `total`, `within-groups`, `series` | `none` |
+| `sortSeries` | select | `""` |
+| `sortReverse` | boolean | `false` |
 | `legend` | boolean | `true` |
 | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
 | `legendPosition` | select: `top`, `bottom`, `left`, `right` | `top` |

package/src/charts/bar-vertical.md

@@ -66,6 +66,7 @@ Every property `bar-vertical` accepts, beside the [frame and layout keys](/refer
 | `autoContrast` | boolean | `false` |
 | `allowDarkMode` | boolean | `true` |
 | `swapLabelValue` | boolean | `false` |
+| `negativeColor` | text | `""` |
 | `barBackground` | boolean | `false` |
 | `barSeparators` | boolean | `false` |
 | `barGap` | text | `60` |

package/src/charts/column-stacked.md

@@ -53,7 +53,9 @@ Every property `column-stacked` accepts, beside the [frame and layout keys](/ref
 | `allowDarkMode` | boolean | `true` |
 | `barGap` | text | `60` |
 | `stackMode` | select: `normal`, `percent` | `normal` |
-| `sortMode` | select: `none`, `total`, `within-groups` | `none` |
+| `sortMode` | select: `none`, `total`, `within-groups`, `series` | `none` |
+| `sortSeries` | select | `""` |
+| `sortReverse` | boolean | `false` |
 | `legend` | boolean | `true` |
 | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
 | `legendPosition` | select: `top`, `bottom`, `left`, `right` | `top` |
@@ -81,6 +83,7 @@ Every property `column-stacked` accepts, beside the [frame and layout keys](/ref
 | `crosshairDirection` | select: `both`, `vertical`, `horizontal` | `both` |
 | `crosshairStyle` | select: `solid`, `dashed`, `dotted` | `dashed` |
 | `crosshairColor` | text | `#999` |
+| `showTotal` | boolean | `false` |
 
 <!-- options:end -->
 
@@ -89,6 +92,7 @@ Every property `column-stacked` accepts, beside the [frame and layout keys](/ref
 - Stacking too many series — the top layers float and lose their baseline
 - Switching to `stackMode = "percent"` without telling the reader hides the change in absolute total
 - Inconsistent segment ordering between columns destroys the visual flow
+- `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 %
 
 ## Related types
 

package/src/charts/donut.md

@@ -66,7 +66,12 @@ Every property `donut` accepts, beside the [frame and layout keys](/reference/ds
 | `directLabelling` | select: `""`, `auto`, `outside`, `inside` | `auto` |
 | `tooltips` | boolean | `false` |
 | `displayAsPercentage` | boolean | `false` |
+| `verticalNumberFormat` | numberFormat | (unset) |
 | `showTotal` | boolean | `true` |
+| `centerLabel` | select: `total`, `slice`, `custom` | `total` |
+| `centerSlice` | text | `""` |
+| `centerText` | text | `""` |
+| `totalLabel` | text | `Total` |
 | `showLabels` | boolean | `true` |
 | `showValues` | boolean | `true` |
 | `sliceMax` | text | `6` |

package/src/charts/dot-plot.md

@@ -95,10 +95,13 @@ Arrows apply to dumbbells only and are ignored in range style.
 
 `sortMode` orders the rows. The default is `value`.
 
-- `value` sorts by the first value column, largest first.
+- `value` sorts by the last value column, largest first.
 - `gap` sorts by the last value column minus the first, largest first. Outside a dumbbell it falls back to `value`.
+- `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`.
 - `none` keeps the order of your data.
 
+Set `sortReverse = true` to put the smallest first.
+
 ## Labels
 
 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
 | `low` | text | `""` |
 | `high` | text | `""` |
 | `arrows` | select: `none`, `forward`, `backward`, `both` | `none` |
-| `sortMode` | select: `none`, `value`, `gap` | `value` |
+| `sortMode` | select: `none`, `value`, `gap`, `change` | `value` |
+| `sortReverse` | boolean | `false` |
 | `legend` | boolean | `true` |
 | `legendPosition` | select: `top`, `bottom`, `left`, `right` | `top` |
 | `legendAnchor` | select: `start`, `middle`, `end` | `start` |
@@ -219,13 +223,14 @@ Every property `dot-plot` accepts, beside the [frame and layout keys](/reference
 | `horizontalRangeMin` | text | (unset) |
 | `horizontalRangeMax` | text | (unset) |
 | `valueLabels` | boolean | `false` |
+| `dotLabels` | select: `both`, `start`, `end`, `difference`, `change` | `both` |
 | `tooltips` | boolean | `true` |
 
 <!-- options:end -->
 
 ## Common pitfalls
 
-- Using `gap` sort on a single value or a range: it falls back to `value`
+- Using `gap` or `change` sort on a single value or a range: it falls back to `value`
 - Expecting range bars from columns named `High` and `Low` without setting `dotStyle = "range"`: they draw as dumbbell dots instead
 - Reading the arrow as a trend: it only points from the first column to the last
 - 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

@@ -94,6 +94,8 @@ Every property `line-multi` accepts, beside the [frame and layout keys](/referen
 | `lineSymbolStyle` | select: `filled`, `hollow` | `filled` |
 | `lineSymbolSize` | text | `3.5` |
 | `lineSymbolOpacity` | text | `1` |
+| `valueLabelPoints` | select: `all`, `firstLast`, `last`, `everyN` | `all` |
+| `valueLabelEvery` | text | `2` |
 
 <!-- options:end -->
 

package/src/charts/line.md

@@ -90,6 +90,8 @@ Every property `line` accepts, beside the [frame and layout keys](/reference/dsl
 | `lineSymbolStyle` | select: `filled`, `hollow` | `filled` |
 | `lineSymbolSize` | text | `3.5` |
 | `lineSymbolOpacity` | text | `1` |
+| `valueLabelPoints` | select: `all`, `firstLast`, `last`, `everyN` | `all` |
+| `valueLabelEvery` | text | `2` |
 
 <!-- options:end -->
 

package/src/charts/pie.md

@@ -63,6 +63,7 @@ Every property `pie` accepts, beside the [frame and layout keys](/reference/dsl/
 | `directLabelling` | select: `""`, `auto`, `outside`, `inside` | `auto` |
 | `tooltips` | boolean | `false` |
 | `displayAsPercentage` | boolean | `true` |
+| `verticalNumberFormat` | numberFormat | (unset) |
 | `showLabels` | boolean | `true` |
 | `showValues` | boolean | `true` |
 | `sliceMax` | text | `5` |