Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add pointLabel context type documentation #11054

Merged
merged 1 commit into from
Jan 13, 2023
Merged

Add pointLabel context type documentation #11054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/axes/radial/linear.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Namespace: `options.scales[scaleId].angleLines`

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

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

## Point Label Options

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

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

## Internal data format

Expand Down
8 changes: 8 additions & 0 deletions docs/general/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,14 @@ In addition to [scale](#scale)
* `index`: tick index
* `type`: `'tick'`

### pointLabel

In addition to [scale](#scale)

* `label`: the associated label value
* `index`: label index
* `type`: `'pointLabel'`

### tooltip

In addition to [chart](#chart)
Expand Down