Skip to content

Commit 4f4606f

Browse files
committed
implement kurkles feedback
1 parent 51fed61 commit 4f4606f

25 files changed

+67
-50
lines changed

docs/docs/axes/_common.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
### Common options to all axes
2-
The common scale configuration can be adjusted in the `options.scales[scaleId]` namespace.
2+
3+
Namespace: `options.scales[scaleId]`
34

45
| Name | Type | Default | Description
56
| ---- | ---- | ------- | -----------

docs/docs/axes/_common_ticks.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
### Common tick options to all axes
2-
The common tick options can be configured in the `options.scales[scaleId].ticks` namespace
2+
3+
Namespace: `options.scales[scaleId].ticks`
34

45
| Name | Type | Scriptable | Default | Description
56
| ---- | ---- | :-------------------------------: | ------- | -----------

docs/docs/axes/cartesian/_common.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
### Common options to all cartesian axes
2-
The common scale configuration can be adjusted in the `options.scales[scaleId]` namespace.
2+
3+
Namespace: `options.scales[scaleId]`
34

45
| Name | Type | Default | Description
56
| ---- | ---- | ------- | -----------

docs/docs/axes/cartesian/_common_ticks.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
### Common tick options to all cartesian axes
2-
The common tick configuration can be adjusted in the `options.scales[scaleId].ticks` namespace.
2+
3+
Namespace: `options.scales[scaleId].ticks`
34

45
| Name | Type | Default | Description
56
| ---- | ---- | ------- | -----------

docs/docs/axes/cartesian/category.mdx

+2-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ let chart = new Chart(ctx, {
4545
## Configuration Options
4646

4747
### Category Axis specific options
48-
The category scale specific configuration can be adjusted in the `options.scales[scaleId]` namespace.
48+
49+
Namespace: `options.scales[scaleId]`
4950

5051
| Name | Type | Description
5152
| ---- | ---- | -----------

docs/docs/axes/cartesian/linear.mdx

+4-1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ The linear scale is used to chart numerical data. It can be placed on either the
1313

1414
### Linear Axis specific options
1515

16+
Namespace: `options.scales[scaleId]`
17+
1618
| Name | Type | Description
1719
| ---- | ---- | -----------
1820
| `beginAtZero` | `boolean` | if true, scale will include 0 if it is not already included.
@@ -23,7 +25,8 @@ The linear scale is used to chart numerical data. It can be placed on either the
2325
## Tick Configuration
2426

2527
### Linear Axis specific options
26-
The linear scale specific configuration can be adjusted in the `options.scales[scaleId]` namespace.
28+
29+
Namespace: `options.scales[scaleId]`
2730

2831
| Name | Type | Default | Description
2932
| ---- | ---- | ------- | -----------

docs/docs/axes/cartesian/logarithmic.mdx

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ The logarithmic scale is used to chart numerical data. It can be placed on eithe
1717
## Tick Configuration
1818

1919
### Logarithmic Axis specific options
20-
The logarithmic scale specific configuration can be adjusted in the `options.scales[scaleId]` namespace.
20+
21+
Namespace: `options.scales[scaleId]`
2122

2223
| Name | Type | Default | Description
2324
| ---- | ---- | ------- | -----------

docs/docs/axes/cartesian/time.mdx

+2-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ When providing data for the time scale, Chart.js uses timestamps defined as mill
2525
## Configuration Options
2626

2727
### Time Axis specific options
28-
The time scale specific configuration can be adjusted in the `options.scales[scaleId]` namespace.
28+
29+
Namespace: `options.scales[scaleId]`
2930

3031
| Name | Type | Default | Description
3132
| ---- | ---- | ------- | -----------

docs/docs/axes/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ In contrast to the `suggested*` settings, the `min` and `max` settings set expli
6464

6565
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.
6666

67-
The callbacks configuration can be adjusted in the `options.scales[scaleId]` namespace.
67+
Namespace: `options.scales[scaleId]`
6868

6969
| Name | Arguments | Description
7070
| ---- | --------- | -----------

docs/docs/axes/labelling.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ When creating a chart, you want to tell the viewer what data they are viewing. T
66

77
## Scale Title Configuration
88

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.
1010

1111
| Name | Type | Default | Description
1212
| ---- | ---- | ------- | -----------

docs/docs/axes/radial/linear.mdx

+6-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ The following additional configuration options are provided by the radial linear
1212
## Configuration Options
1313

1414
### Linear Radial Axis specific options
15-
The radial linear scale specific configuration can be adjusted in the `options.scales[scaleId]` namespace.
15+
16+
Namespace: `options.scales[scaleId]`
1617

1718
| Name | Type | Default | Description
1819
| ---- | ---- | ------- | -----------
@@ -26,7 +27,8 @@ The radial linear scale specific configuration can be adjusted in the `options.s
2627
## Tick Configuration
2728

2829
### Linear Radial Axis specific options
29-
The radial linear scale tick specific configuration can be adjusted in the `options.scales[scaleId].ticks` namespace.
30+
31+
Namespace: `options.scales[scaleId].ticks`
3032

3133
| Name | Type | Scriptable | Default | Description
3234
| ---- | ---- | ------- | ------- | -----------
@@ -102,7 +104,7 @@ let options = {
102104
## Angle Line Options
103105

104106
The following options are used to configure angled lines that radiate from the center of the chart to the point labels.
105-
The angle line specific configuration can be adjusted in the `options.scales[scaleId].angleLines` namespace.
107+
Namespace: `options.scales[scaleId].angleLines`
106108

107109
| Name | Type | Scriptable | Default | Description
108110
| ---- | ---- | ------- | ------- | -----------
@@ -119,7 +121,7 @@ The scriptable context is described in [Options](../../general/options.md#scale)
119121
## Point Label Options
120122

121123
The following options are used to configure the point labels that are shown on the perimeter of the scale.
122-
The point label specific configuration can be adjusted in the `options.scales[scaleId].pointLabels` namespace.
124+
Namespace: `options.scales[scaleId].pointLabels`
123125

124126
| Name | Type | Scriptable | Default | Description
125127
| ---- | ---- | ------- | ------- | -----------

docs/docs/axes/styling.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ There are a number of options to allow styling an axis. There are settings to co
88

99
## Grid Line Configuration
1010

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.
1212

1313
| Name | Type | Scriptable | Indexable | Default | Description
1414
| ---- | ---- | :-------------------------------: | :-----------------------------: | ------- | -----------
@@ -41,7 +41,7 @@ The scriptable context is described in [Options](../general/options.md#tick) sec
4141

4242
## Major Tick Configuration
4343

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.
4545

4646
| Name | Type | Default | Description
4747
| ---- | ---- | ------- | -----------

docs/docs/configuration/animations.mdx

+6-4
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ function example() {
109109

110110
## Animation Configuration
111111

112-
The animation configuration can be adjusted in the `options.animation` namespace. The global options are defined in `Chart.defaults.animation`.
113112
The default configuration is defined here: <a href="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`.
114114

115115
| Name | Type | Default | Description
116116
| ---- | ---- | ------- | -----------
@@ -133,7 +133,8 @@ A custom mode can be used by passing a custom `mode` to [update](../developers/a
133133
A mode option is defined by the same options of the main [animation configuration](#animation-configuration).
134134

135135
### Default modes
136-
The animation mode configuration can be adjusted in the `options.animation` namespace.
136+
137+
Namespace: `options.animation`
137138

138139
| Mode | Option | Value | Description
139140
| -----| ------ | ----- | -----
@@ -146,10 +147,11 @@ The animation mode configuration can be adjusted in the `options.animation` name
146147

147148
## Animation property configuration
148149

149-
The animation property configuration can be adjusted in the `options.animation[animation]` namespace.
150150
Property option configures which element property to use to animate the chart and its starting and ending values.
151151
A property option is defined by the same options of the main [animation configuration](#animation-configuration), adding the following ones:
152152

153+
Namespace: `options.animation[animation]`
154+
153155
| Name | Type | Default | Description
154156
| ---- | ---- | ------- | -----------
155157
| `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/).
240242
The animation configuration provides callbacks which are useful for synchronizing an external draw to the chart animation.
241243
The callbacks can be set only at main [animation configuration](#animation-configuration).
242244

243-
The callbacks configuration can be adjusted in the `options.animation` namespace.
245+
Namespace: `options.animation`
244246

245247
| Name | Type | Default | Description
246248
| ---- | ---- | ------- | -----------

docs/docs/configuration/decimation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The decimation plugin can be used with line charts to automatically decimate dat
66

77
## Configuration Options
88

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`.
1010

1111
| Name | Type | Default | Description
1212
| ---- | ---- | ------- | -----------

docs/docs/configuration/device-pixel-ratio.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ For applications where a chart will be converted to a bitmap, or printed to a hi
99
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.
1010

1111
## Configuration Options
12-
The device pixel ratio configuration can be adjusted in the `options` namespace (root of options object)
12+
13+
Namespace: `options`
1314

1415
| Name | Type | Default | Description
1516
| ---- | ---- | ------- | -----------

docs/docs/configuration/elements.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Chart.defaults.elements.bar.borderWidth = 2;
1616

1717
Point elements are used to represent the points in a line, radar or bubble chart.
1818

19-
The point element configuration is passed into the `options.elements.point` namespace. Global point options: `Chart.defaults.elements.point`.
19+
Namespace: `options.elements.point`, global point options: `Chart.defaults.elements.point`.
2020

2121
| Name | Type | Default | Description
2222
| ---- | ---- | ------- | -----------
@@ -51,7 +51,7 @@ If the value is an image, that image is drawn on the canvas using [drawImage](ht
5151

5252
Line elements are used to represent the line in a line chart.
5353

54-
The line element configuration can be adjusted in the `options.elements.line` namespace. Global line options: `Chart.defaults.elements.line`.
54+
Namespace: `options.elements.line`, global line options: `Chart.defaults.elements.line`.
5555

5656
| Name | Type | Default | Description
5757
| ---- | ---- | ------- | -----------
@@ -72,7 +72,7 @@ The line element configuration can be adjusted in the `options.elements.line` na
7272

7373
Bar elements are used to represent the bars in a bar chart.
7474

75-
The bar element configuration can be adjusted in the `options.elements.bar` namespace. Global bar options: `Chart.defaults.elements.bar`.
75+
Namespace: `options.elements.bar`, global bar options: `Chart.defaults.elements.bar`.
7676

7777
| Name | Type | Default | Description
7878
| ---- | ---- | ------- | -----------
@@ -87,7 +87,7 @@ The bar element configuration can be adjusted in the `options.elements.bar` name
8787

8888
Arcs are used in the polar area, doughnut and pie charts.
8989

90-
The arc element configuration can be adjusted in the `options.elements.arc` namespace. Global arc options: `Chart.defaults.elements.arc`.
90+
Namespace: `options.elements.arc`, global arc options: `Chart.defaults.elements.arc`.
9191

9292
| Name | Type | Default | Description
9393
| ---- | ---- | ------- | -----------

docs/docs/configuration/interactions/events.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Events
33
---
44

55
The following properties define how the chart interacts with events.
6-
The events configuration can be adjusted in the `options` namespace (root of options object)
6+
Namespace: `options`
77

88
| Name | Type | Default | Description
99
| ---- | ---- | ------- | -----------

docs/docs/configuration/interactions/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Interactions
33
---
44

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).
66

77
| Name | Type | Default | Description
88
| ---- | ---- | ------- | -----------

docs/docs/configuration/layout.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Layout
33
---
44

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`.
66

77
| Name | Type | Default | [Scriptable](../general/options.md#scriptable-options) | Description
88
| ---- | ---- | ------- | :----: | -----------

docs/docs/configuration/legend.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The chart legend displays data about the datasets that are appearing on the char
66

77
## Configuration options
88

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`.
1010

1111
| Name | Type | Default | Description
1212
| ---- | ---- | ------- | -----------
@@ -46,7 +46,7 @@ Defaults to `'center'` for unrecognized values.
4646

4747
## Legend Label Configuration
4848

49-
The legend label configuration is nested below the legend configuration using the `options.plugins.legend.labels` namespace.
49+
Namespace: `options.plugins.legend.labels`
5050

5151
| Name | Type | Default | Description
5252
| ---- | ---- | ------- | -----------
@@ -63,7 +63,7 @@ The legend label configuration is nested below the legend configuration using th
6363

6464
## Legend Title Configuration
6565

66-
The legend title configuration is nested below the legend configuration using the `options.plugins.legend.title` namespace.
66+
Namespace: `options.plugins.legend.title`
6767

6868
| Name | Type | Default | Description
6969
| ---- | ---- | ------- | -----------

docs/docs/configuration/locale.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ with all present components separated by hyphens.
1919
By default the chart is using the default locale of the platform which is running on.
2020

2121
## Configuration Options
22-
The locale configuration can be adjusted in the `options` namespace (root of options object)
22+
23+
Namespace: `options`
2324

2425
| Name | Type | Default | Description
2526
| ---- | ---- | ------- | -----------

docs/docs/configuration/responsive.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ The following examples **do not work**:
1212
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.
1313

1414
## Configuration Options
15-
The performance configuration can be adjusted in the `options` namespace (root of options object)
15+
16+
Namespace: `options`
1617

1718
| Name | Type | Default | Description
1819
| ---- | ---- | ------- | -----------

docs/docs/configuration/title.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The chart title defines text to draw at the top of the chart.
66

77
## Title Configuration
88

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`.
1010

1111
| Name | Type | Default | Description
1212
| ---- | ---- | ------- | -----------

docs/docs/configuration/tooltip.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Tooltip
44

55
## Tooltip Configuration
66

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`.
88

99
| Name | Type | Default | Description
1010
| ---- | ---- | ------- | -----------
@@ -101,7 +101,7 @@ Allows filtering of [tooltip items](#tooltip-item-context). Must implement at mi
101101

102102
## Tooltip Callbacks
103103

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.
105105

106106
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.
107107

0 commit comments

Comments
 (0)