You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/docs/axes/index.mdx
+1-1
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ In contrast to the `suggested*` settings, the `min` and `max` settings set expli
64
64
65
65
There are a number of config callbacks that can be used to change parameters in the scale at different points in the update process. The options are supplied at the top level of the axis options.
66
66
67
-
The callbacks configuration can be adjusted in the `options.scales[scaleId]` namespace.
Copy file name to clipboardexpand all lines: docs/docs/axes/labelling.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ When creating a chart, you want to tell the viewer what data they are viewing. T
6
6
7
7
## Scale Title Configuration
8
8
9
-
The scale label configuration can be adjusted in the `options.scales[scaleId].scaleLabel` namespace. It defines options for the scale title. Note that this only applies to cartesian axes.
9
+
Namespace: `options.scales[scaleId].scaleLabel`, it defines options for the scale title. Note that this only applies to cartesian axes.
Copy file name to clipboardexpand all lines: docs/docs/axes/styling.mdx
+2-2
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ There are a number of options to allow styling an axis. There are settings to co
8
8
9
9
## Grid Line Configuration
10
10
11
-
The scale label configuration can be adjusted in the `options.scales[scaleId].gridLines` namespace. It defines options for the grid lines that run perpendicular to the axis.
11
+
Namespace: `options.scales[scaleId].gridLines`, it defines options for the grid lines that run perpendicular to the axis.
12
12
13
13
| Name | Type | Scriptable | Indexable | Default | Description
@@ -41,7 +41,7 @@ The scriptable context is described in [Options](../general/options.md#tick) sec
41
41
42
42
## Major Tick Configuration
43
43
44
-
The scale label configuration can be adjusted in the `options.scales[scaleId].ticks.major` namespace. It defines options for the major tick marks that are generated by the axis.
44
+
Namespace: `options.scales[scaleId].ticks.major`, it defines options for the major tick marks that are generated by the axis.
Copy file name to clipboardexpand all lines: docs/docs/configuration/animations.mdx
+6-4
Original file line number
Diff line number
Diff line change
@@ -109,8 +109,8 @@ function example() {
109
109
110
110
## Animation Configuration
111
111
112
-
The animation configuration can be adjusted in the `options.animation` namespace. The global options are defined in `Chart.defaults.animation`.
113
112
The default configuration is defined here: <ahref="https://github.com/chartjs/Chart.js/blob/master/src/core/core.animations.js#L6-L55"target="_blank">core.animations.js</a>
113
+
Namespace: `options.animation`, the global options are defined in `Chart.defaults.animation`.
114
114
115
115
| Name | Type | Default | Description
116
116
| ---- | ---- | ------- | -----------
@@ -133,7 +133,8 @@ A custom mode can be used by passing a custom `mode` to [update](../developers/a
133
133
A mode option is defined by the same options of the main [animation configuration](#animation-configuration).
134
134
135
135
### Default modes
136
-
The animation mode configuration can be adjusted in the `options.animation` namespace.
136
+
137
+
Namespace: `options.animation`
137
138
138
139
| Mode | Option | Value | Description
139
140
| -----| ------ | ----- | -----
@@ -146,10 +147,11 @@ The animation mode configuration can be adjusted in the `options.animation` name
146
147
147
148
## Animation property configuration
148
149
149
-
The animation property configuration can be adjusted in the `options.animation[animation]` namespace.
150
150
Property option configures which element property to use to animate the chart and its starting and ending values.
151
151
A property option is defined by the same options of the main [animation configuration](#animation-configuration), adding the following ones:
152
152
153
+
Namespace: `options.animation[animation]`
154
+
153
155
| Name | Type | Default | Description
154
156
| ---- | ---- | ------- | -----------
155
157
| `type` | `string` | `typeof property` | Type of property, determines the interpolator used. Possible values: `'number'`, `'color'` and `'boolean'`. Only really needed for `'color'`, because `typeof` does not get that right.
@@ -240,7 +242,7 @@ See [Robert Penner's easing equations](http://robertpenner.com/easing/).
240
242
The animation configuration provides callbacks which are useful for synchronizing an external draw to the chart animation.
241
243
The callbacks can be set only at main [animation configuration](#animation-configuration).
242
244
243
-
The callbacks configuration can be adjusted in the `options.animation` namespace.
Copy file name to clipboardexpand all lines: docs/docs/configuration/decimation.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ The decimation plugin can be used with line charts to automatically decimate dat
6
6
7
7
## Configuration Options
8
8
9
-
The decimation plugin configuration can be adjusted in the `options.plugins.decimation` namespace. The global options for the plugin are defined in `Chart.defaults.plugins.decimation`.
9
+
Namespace: `options.plugins.decimation`, the global options for the plugin are defined in `Chart.defaults.plugins.decimation`.
Copy file name to clipboardexpand all lines: docs/docs/configuration/device-pixel-ratio.md
+2-1
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,8 @@ For applications where a chart will be converted to a bitmap, or printed to a hi
9
9
Setting `devicePixelRatio` to a value other than 1 will force the canvas size to be scaled by that amount, relative to the container size. There should be no visible difference on screen; the difference will only be visible when the image is zoomed or printed.
10
10
11
11
## Configuration Options
12
-
The device pixel ratio configuration can be adjusted in the `options` namespace (root of options object)
Copy file name to clipboardexpand all lines: docs/docs/configuration/interactions/index.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Interactions
3
3
---
4
4
5
-
The interaction configuration can be adjusted in the `options.interaction` namespace. The global interaction configuration is at `Chart.defaults.interaction`. To configure which events trigger chart interactions, see [events](events.md#events).
5
+
Namespace: `options.interaction`, the global interaction configuration is at `Chart.defaults.interaction`. To configure which events trigger chart interactions, see [events](events.md#events).
Copy file name to clipboardexpand all lines: docs/docs/configuration/layout.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: Layout
3
3
---
4
4
5
-
The layout configuration can be adjusted in the `options.layout` namespace. The global options for the chart layout is defined in `Chart.defaults.layout`.
5
+
Namespace: `options.layout`, the global options for the chart layout is defined in `Chart.defaults.layout`.
6
6
7
7
| Name | Type | Default | [Scriptable](../general/options.md#scriptable-options) | Description
Copy file name to clipboardexpand all lines: docs/docs/configuration/legend.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ The chart legend displays data about the datasets that are appearing on the char
6
6
7
7
## Configuration options
8
8
9
-
The legend configuration can be adjusted in the `options.plugins.legend` namespace. The global options for the chart legend is defined in `Chart.defaults.plugins.legend`.
9
+
Namespace: `options.plugins.legend`, the global options for the chart legend is defined in `Chart.defaults.plugins.legend`.
10
10
11
11
| Name | Type | Default | Description
12
12
| ---- | ---- | ------- | -----------
@@ -46,7 +46,7 @@ Defaults to `'center'` for unrecognized values.
46
46
47
47
## Legend Label Configuration
48
48
49
-
The legend label configuration is nested below the legend configuration using the `options.plugins.legend.labels` namespace.
49
+
Namespace: `options.plugins.legend.labels`
50
50
51
51
| Name | Type | Default | Description
52
52
| ---- | ---- | ------- | -----------
@@ -63,7 +63,7 @@ The legend label configuration is nested below the legend configuration using th
63
63
64
64
## Legend Title Configuration
65
65
66
-
The legend title configuration is nested below the legend configuration using the `options.plugins.legend.title` namespace.
Copy file name to clipboardexpand all lines: docs/docs/configuration/responsive.md
+2-1
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,8 @@ The following examples **do not work**:
12
12
Chart.js provides a [few options](#configuration-options) to enable responsiveness and control the resize behavior of charts by detecting when the canvas *display* size changes and update the *render* size accordingly.
13
13
14
14
## Configuration Options
15
-
The performance configuration can be adjusted in the `options` namespace (root of options object)
Copy file name to clipboardexpand all lines: docs/docs/configuration/title.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ The chart title defines text to draw at the top of the chart.
6
6
7
7
## Title Configuration
8
8
9
-
The title configuration can be adjusted in the `options.plugins.title` namespace. The global options for the chart title is defined in `Chart.defaults.plugins.title`.
9
+
Namespace: `options.plugins.title`, the global options for the chart title is defined in `Chart.defaults.plugins.title`.
Copy file name to clipboardexpand all lines: docs/docs/configuration/tooltip.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ title: Tooltip
4
4
5
5
## Tooltip Configuration
6
6
7
-
The tooltip configuration can be adjusted in the `options.plugins.tooltip` namespace. The global options for the chart tooltips is defined in `Chart.defaults.plugins.tooltip`.
7
+
Namespace: `options.plugins.tooltip`, the global options for the chart tooltips is defined in `Chart.defaults.plugins.tooltip`.
8
8
9
9
| Name | Type | Default | Description
10
10
| ---- | ---- | ------- | -----------
@@ -101,7 +101,7 @@ Allows filtering of [tooltip items](#tooltip-item-context). Must implement at mi
101
101
102
102
## Tooltip Callbacks
103
103
104
-
The tooltip label configuration is nested below the tooltip configuration using the `options.plugins.tooltip.callbacks` namespace. The tooltip has the following callbacks for providing text. For all functions, `this` will be the tooltip object created from the `Tooltip` constructor.
104
+
Namespace: `options.plugins.tooltip.callbacks`, the tooltip has the following callbacks for providing text. For all functions, `this` will be the tooltip object created from the `Tooltip` constructor.
105
105
106
106
All functions are called with the same arguments: a [tooltip item context](#tooltip-item-context). All functions must return either a string or an array of strings. Arrays of strings are treated as multiple lines of text.
0 commit comments