Skip to content

Commit be049a3

Browse files
authored
Add pointLabel context type documentation (#11054)
1 parent b2b881b commit be049a3

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

docs/axes/radial/linear.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Namespace: `options.scales[scaleId].angleLines`
142142

143143
1. the `borderDash` setting only accepts a static value or a function. Passing an array of arrays is not supported.
144144

145-
The scriptable context is described in [Options](../../general/options.md#scale) section.
145+
The scriptable context is described in [Options](../../general/options.md#pointLabel) section.
146146

147147
## Point Label Options
148148

@@ -161,7 +161,7 @@ Namespace: `options.scales[scaleId].pointLabels`
161161
| `padding` | `number` | Yes | 5 | Padding between chart and point labels.
162162
| [`centerPointLabels`](../../samples/other-charts/polar-area-center-labels.md) | `boolean` | | `false` | If true, point labels are centered.
163163

164-
The scriptable context is described in [Options](../../general/options.md#scale) section.
164+
The scriptable context is described in [Options](../../general/options.md#pointLabel) section.
165165

166166
## Internal data format
167167

docs/general/options.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,14 @@ In addition to [scale](#scale)
168168
* `index`: tick index
169169
* `type`: `'tick'`
170170

171+
### pointLabel
172+
173+
In addition to [scale](#scale)
174+
175+
* `label`: the associated label value
176+
* `index`: label index
177+
* `type`: `'pointLabel'`
178+
171179
### tooltip
172180

173181
In addition to [chart](#chart)

0 commit comments

Comments
 (0)