@blueprint-chart/docs 0.1.30 → 0.1.31

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blueprint-chart/docs",
3
- "version": "0.1.30",
3
+ "version": "0.1.31",
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",
@@ -49,8 +49,8 @@
49
49
  "vitepress": "^1.5.0",
50
50
  "vitest": "^3.2.4",
51
51
  "vue": "^3.5",
52
- "@blueprint-chart/lib": "0.1.30",
53
- "@blueprint-chart/ui": "0.1.30"
52
+ "@blueprint-chart/lib": "0.1.31",
53
+ "@blueprint-chart/ui": "0.1.31"
54
54
  },
55
55
  "scripts": {
56
56
  "dev": "vitepress dev src --host 0.0.0.0 --port 4445",
@@ -125,7 +125,7 @@ const html = highlightDsl(`chart line-multi {
125
125
 
126
126
  annotation "2020" {
127
127
  text = "COVID-19 recession"
128
- dy = -10
128
+ textOffsetY = -10
129
129
  showArrow = true
130
130
  }
131
131
 
@@ -166,7 +166,7 @@ A donut chart with an explicit categorical palette, right-anchored legend, and p
166
166
 
167
167
  annotation "Jun 2022" {
168
168
  text = "Peak: 9.1%"
169
- dy = -12
169
+ textOffsetY = -12
170
170
  showArrow = true
171
171
  }
172
172
 
@@ -51,7 +51,7 @@ const source = `
51
51
 
52
52
  annotation "2021" {
53
53
  text = "All-time high cycle"
54
- dy = -12
54
+ textOffsetY = -12
55
55
  showArrow = true
56
56
  }
57
57
 
@@ -89,7 +89,7 @@ chart line {
89
89
 
90
90
  annotation "2021" {
91
91
  text = "All-time high cycle"
92
- dy = -12
92
+ textOffsetY = -12
93
93
  showArrow = true
94
94
  }
95
95
  }
@@ -73,7 +73,7 @@ chart line-multi {
73
73
 
74
74
  annotation "2009" {
75
75
  text = "Great Recession peak"
76
- dy = -10
76
+ textOffsetY = -10
77
77
  showArrow = true
78
78
  }
79
79
 
@@ -206,7 +206,7 @@ Drop a BPC source into the page inside a typed `<script>` tag, then call `initBl
206
206
 
207
207
  annotation "2021" {
208
208
  text = "All-time high cycle"
209
- dy = -12
209
+ textOffsetY = -12
210
210
  showArrow = true
211
211
  }
212
212
 
@@ -78,20 +78,20 @@ No bundled sample currently uses `area-fill`. The grammar is documented and pars
78
78
 
79
79
  ## Annotations
80
80
 
81
- Three kinds of annotation, sharing a body of properties (`text`, `dx`, `dy`, `showArrow`, …):
81
+ Three kinds of annotation, sharing a body of properties (`text`, `textOffsetX`, `textOffsetY`, `showArrow`, …):
82
82
 
83
83
  ### Point annotation — anchored to a data key
84
84
 
85
85
  ```bpc
86
86
  annotation "2021" {
87
87
  text = "All-time high cycle"
88
- dy = -12
88
+ textOffsetY = -12
89
89
  showArrow = true
90
90
  }
91
91
  ```
92
92
 
93
93
  ::: info From `packages/lib/src/samples/bitcoin-price.bpc`
94
- A minimal point annotation: the key matches a data label, `dy` nudges the text up, and an arrow draws back to the point.
94
+ A minimal point annotation: the key matches a data label, `textOffsetY` nudges the text up, and an arrow draws back to the point.
95
95
  :::
96
96
 
97
97
  A richer point annotation with a connector line and curved leader:
@@ -25,7 +25,7 @@ chart line {
25
25
 
26
26
  annotation "2021" {
27
27
  text = "All-time high cycle"
28
- dy = -12
28
+ textOffsetY = -12
29
29
  showArrow = true
30
30
  }
31
31