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

Move pointStyle types and update plugin link&render chart #9479

Merged
merged 2 commits into from Jul 30, 2021
Merged

Move pointStyle types and update plugin link&render chart #9479

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0e5a44
Place canvasElement on next line to keep table clean
LeeLenaleee Jul 27, 2021
20eff16
move typing to global location, update plugin page
LeeLenaleee Jul 29, 2021
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
2 changes: 1 addition & 1 deletion docs/charts/bar.md
View file
Open in desktop
Expand Up @@ -90,7 +90,7 @@ Only the `data` option needs to be specified in the dataset namespace.
| [`minBarLength`](#styling) | `number` | - | - | |
| [`label`](#general) | `string` | - | - | `''`
| [`order`](#general) | `number` | - | - | `0`
| [`pointStyle`](../configuration/elements.md#point-styles) | `string`\|`Image`\|`HTMLCanvasElement` | Yes | - | `'circle'`
| [`pointStyle`](../configuration/elements.md#point-styles) | `string`\|`Image`\| `HTMLCanvasElement` | Yes | - | `'circle'`
| [`skipNull`](#general) | `boolean` | - | - | |
| [`stack`](#general) | `string` | - | - | `'bar'` |
| [`xAxisID`](#general) | `string` | - | - | first x axis
Expand Down
2 changes: 1 addition & 1 deletion docs/charts/bubble.md
View file
Open in desktop
Expand Up @@ -60,7 +60,7 @@ The bubble chart allows a number of properties to be specified for each dataset.
| [`hitRadius`](#interactions) | `number` | Yes | Yes | `1`
| [`label`](#general) | `string` | - | - | `undefined`
| [`order`](#general) | `number` | - | - | `0`
| [`pointStyle`](#styling) | `string`\|`Image`\|`HTMLCanvasElement` | Yes | Yes | `'circle'`
| [`pointStyle`](#styling) | `string`\|`Image`\| `HTMLCanvasElement` | Yes | Yes | `'circle'`
| [`rotation`](#styling) | `number` | Yes | Yes | `0`
| [`radius`](#styling) | `number` | Yes | Yes | `3`

Expand Down
2 changes: 1 addition & 1 deletion docs/charts/line.md
View file
Open in desktop
Expand Up @@ -75,7 +75,7 @@ The line chart allows a number of properties to be specified for each dataset. T
| [`pointHoverRadius`](#interactions) | `number` | Yes | Yes | `4`
| [`pointRadius`](#point-styling) | `number` | Yes | Yes | `3`
| [`pointRotation`](#point-styling) | `number` | Yes | Yes | `0`
| [`pointStyle`](#point-styling) | `string`\|`Image`\|`HTMLCanvasElement` | Yes | Yes | `'circle'`
| [`pointStyle`](#point-styling) | `string`\|`Image`\| `HTMLCanvasElement` | Yes | Yes | `'circle'`
| [`segment`](#segment) | `object` | - | - | `undefined`
| [`showLine`](#line-styling) | `boolean` | - | - | `true`
| [`spanGaps`](#line-styling) | `boolean`\|`number` | - | - | `undefined`
Expand Down
2 changes: 1 addition & 1 deletion docs/charts/radar.md
View file
Open in desktop
Expand Up @@ -104,7 +104,7 @@ The radar chart allows a number of properties to be specified for each dataset.
| [`pointHoverRadius`](#interactions) | `number` | Yes | Yes | `4`
| [`pointRadius`](#point-styling) | `number` | Yes | Yes | `3`
| [`pointRotation`](#point-styling) | `number` | Yes | Yes | `0`
| [`pointStyle`](#point-styling) | `string`\|`Image`\|`HTMLCanvasElement` | Yes | Yes | `'circle'`
| [`pointStyle`](#point-styling) | `string`\|`Image`\| `HTMLCanvasElement` | Yes | Yes | `'circle'`
| [`spanGaps`](#line-styling) | `boolean` | - | - | `undefined`

All these values, if `undefined`, fallback to the scopes described in [option resolution](../general/options)
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/elements.md
View file
Open in desktop
Expand Up @@ -19,7 +19,7 @@ Namespace: `options.elements.point`, global point options: `Chart.defaults.eleme
| Name | Type | Default | Description
| ---- | ---- | ------- | -----------
| `radius` | `number` | `3` | Point radius.
| [`pointStyle`](#point-styles) | `string`\|`Image`\|`HTMLCanvasElement` | `'circle'` | Point style.
| [`pointStyle`](#point-styles) | `string`\|`Image`\| `HTMLCanvasElement` | `'circle'` | Point style.
| `rotation` | `number` | `0` | Point rotation (in degrees).
| `backgroundColor` | [`Color`](../general/colors.md) | `Chart.defaults.backgroundColor` | Point fill color.
| `borderWidth` | `number` | `1` | Point stroke width.
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/legend.md
View file
Open in desktop
Expand Up @@ -59,7 +59,7 @@ Namespace: `options.plugins.legend.labels`
| `generateLabels` | `function` | | Generates legend items for each thing in the legend. Default implementation returns the text + styling for the color box. See [Legend Item](#legend-item-interface) for details.
| `filter` | `function` | `null` | Filters legend items out of the legend. Receives 2 parameters, a [Legend Item](#legend-item-interface) and the chart data.
| `sort` | `function` | `null` | Sorts legend items. Receives 3 parameters, two [Legend Items](#legend-item-interface) and the chart data.
| [`pointStyle`](elements.md#point-styles) | `string`\|`Image`\|`HTMLCanvasElement` | `'circle'` | If specified, this style of point is used for the legend. Only used if `usePointStyle` is true.
| [`pointStyle`](elements.md#point-styles) | `string`\|`Image`\| `HTMLCanvasElement` | `'circle'` | If specified, this style of point is used for the legend. Only used if `usePointStyle` is true.
| `textAlign` | `string` | `'center'` | Horizontal alignment of the label text. Options are: `'left'`, `'right'` or `'center'`.
| `usePointStyle` | `boolean` | `false` | Label style will match corresponding point style (size is based on the minimum value between boxWidth and font.size).

Expand Down