diff --git a/docs/charts/bar.md b/docs/charts/bar.md index f7182b10ee9..0543fed6469 100644 --- a/docs/charts/bar.md +++ b/docs/charts/bar.md @@ -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) | [`pointStyle`](../configuration/elements.md#types) | Yes | - | `'circle'` | [`skipNull`](#general) | `boolean` | - | - | | | [`stack`](#general) | `string` | - | - | `'bar'` | | [`xAxisID`](#general) | `string` | - | - | first x axis diff --git a/docs/charts/bubble.md b/docs/charts/bubble.md index 4f407129683..44bd9bf2b11 100644 --- a/docs/charts/bubble.md +++ b/docs/charts/bubble.md @@ -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) | [`pointStyle`](../configuration/elements.md#types) | Yes | Yes | `'circle'` | [`rotation`](#styling) | `number` | Yes | Yes | `0` | [`radius`](#styling) | `number` | Yes | Yes | `3` diff --git a/docs/charts/line.md b/docs/charts/line.md index ff926a50495..a41d79d1842 100644 --- a/docs/charts/line.md +++ b/docs/charts/line.md @@ -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) | [`pointStyle`](../configuration/elements.md#types) | Yes | Yes | `'circle'` | [`segment`](#segment) | `object` | - | - | `undefined` | [`showLine`](#line-styling) | `boolean` | - | - | `true` | [`spanGaps`](#line-styling) | `boolean`\|`number` | - | - | `undefined` diff --git a/docs/charts/radar.md b/docs/charts/radar.md index fb425c56ef8..5281a73f7e1 100644 --- a/docs/charts/radar.md +++ b/docs/charts/radar.md @@ -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) | [`pointStyle`](../configuration/elements.md#types) | Yes | Yes | `'circle'` | [`spanGaps`](#line-styling) | `boolean` | - | - | `undefined` All these values, if `undefined`, fallback to the scopes described in [option resolution](../general/options) diff --git a/docs/configuration/elements.md b/docs/configuration/elements.md index af39cdb3d79..ffdeff3c41c 100644 --- a/docs/configuration/elements.md +++ b/docs/configuration/elements.md @@ -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) | [`pointStyle`](#types) | `'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. @@ -30,7 +30,12 @@ Namespace: `options.elements.point`, global point options: `Chart.defaults.eleme ### Point Styles -The following values are supported: +#### Types + +The `pointStyle` argument accepts the following type of inputs: `string`, `Image` and `HTMLCanvasElement` + +#### Info +When a string is provided, the following values are supported: - `'circle'` - `'cross'` diff --git a/docs/configuration/legend.md b/docs/configuration/legend.md index 77aa9e0ab67..e0ff5ac7f5d 100644 --- a/docs/configuration/legend.md +++ b/docs/configuration/legend.md @@ -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) | [`pointStyle`](elements.md#types) | `'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). diff --git a/docs/developers/plugins.md b/docs/developers/plugins.md index 2fe6eb4b628..0144839c3b2 100644 --- a/docs/developers/plugins.md +++ b/docs/developers/plugins.md @@ -122,7 +122,7 @@ var chart = new Chart(ctx, { ## Plugin Core API -Read more about the [existing plugin extension hooks](../api/interfaces/plugin). +Read more about the [existing plugin extension hooks](../api/interfaces/Plugin). ### Chart Initialization diff --git a/docs/developers/render_flowchart.png b/docs/developers/render_flowchart.png index a140c55c0a5..211cc160486 100644 Binary files a/docs/developers/render_flowchart.png and b/docs/developers/render_flowchart.png differ