Rename scaleLabel to title in scale options (#8576)

Author: etimberg

docs/docs/axes/cartesian/_common.md

@@ -8,4 +8,4 @@ Namespace: `options.scales[scaleId]`
 | `position` | `string` | | Position of the axis. [more...](./index.mdx#axis-position)
 | `axis` | `string` | | Which type of axis this is. Possible values are: `'x'`, `'y'`. If not set, this is inferred from the first character of the ID which should be `'x'` or `'y'`.
 | `offset` | `boolean` | `false` | If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to `true` for a bar chart by default.
-| `scaleLabel` | `object` | | Scale title configuration. [more...](../labelling.md#scale-title-configuration)
+| `title` | `object` | | Scale title configuration. [more...](../labelling.md#scale-title-configuration)

docs/docs/axes/labelling.md

@@ -6,13 +6,13 @@ When creating a chart, you want to tell the viewer what data they are viewing. T
 
 ## Scale Title Configuration
 
-Namespace: `options.scales[scaleId].scaleLabel`, it defines options for the scale title. Note that this only applies to cartesian axes.
+Namespace: `options.scales[scaleId].title`, it defines options for the scale title. Note that this only applies to cartesian axes.
 
 | Name | Type | Default | Description
 | ---- | ---- | ------- | -----------
 | `display` | `boolean` | `false` | If true, display the axis title.
 | `align` | `string` | `'center'` | Alignment of the axis title. Possible options are `'start'`, `'center'` and `'end'`
-| `labelString` | `string` | `''` | The text for the title. (i.e. "# of People" or "Response Choices").
+| `text` | `string` | `''` | The text for the title. (i.e. "# of People" or "Response Choices").
 | `color` | [`Color`](../general/colors.md) | `Chart.defaults.color` | Color of label.
 | `font` | `Font` | `Chart.defaults.font` | See [Fonts](../general/fonts.md)
 | `padding` | `number`\|`object` | `4` | Padding to apply around scale labels. Only `top` and `bottom` are implemented.

docs/docs/getting-started/v3-migration.md

@@ -85,6 +85,8 @@ A number of changes were made to the configuration options passed to the `Chart`
 * `scales.[x/y]Axes.categoryPercentage` was moved to dataset option `categoryPercentage`
 * `scales.[x/y]Axes.maxBarThickness` was moved to dataset option `maxBarThickness`
 * `scales.[x/y]Axes.minBarLength` was moved to dataset option `minBarLength`
+* `scales.[x/y]Axes.scaleLabel` was renamed to `scales[id].title`
+* `scales.[x/y]Axes.scaleLabel.labelString` was renamed to `scales[id].title.text`
 * `scales.[x/y]Axes.ticks.beginAtZero` was renamed to `scales[id].beginAtZero`
 * `scales.[x/y]Axes.ticks.max` was renamed to `scales[id].max`
 * `scales.[x/y]Axes.ticks.min` was renamed to `scales[id].min`
@@ -134,9 +136,9 @@ options: {
       id: 'x',
       type: 'time',
       display: true,
-      scaleLabel: {
+      title: {
         display: true,
-        labelString: 'Date'
+        text: 'Date'
       },
       ticks: {
         major: {
@@ -155,9 +157,9 @@ options: {
     yAxes: [{
       id: 'y',
       display: true,
-      scaleLabel: {
+      title: {
         display: true,
-        labelString: 'value'
+        text: 'value'
       }
     }]
   }
@@ -172,9 +174,9 @@ options: {
     x: {
       type: 'time',
       display: true,
-      scaleLabel: {
+      title: {
         display: true,
-        labelString: 'Date'
+        text: 'Date'
       },
       ticks: {
         major: {
@@ -192,9 +194,9 @@ options: {
     },
     y: {
       display: true,
-      scaleLabel: {
+      title: {
         display: true,
-        labelString: 'value'
+        text: 'value'
       }
     }
   }

samples/advanced/line-gradient.html

@@ -86,16 +86,16 @@
 				scales: {
 					x: {
 						display: true,
-						scaleLabel: {
+						title: {
 							display: true,
-							labelString: 'Month'
+							text: 'Month'
 						}
 					},
 					y: {
 						display: true,
-						scaleLabel: {
+						title: {
 							display: true,
-							labelString: 'Value'
+							text: 'Value'
 						}
 					}
 				}

samples/animations/drop.html

@@ -100,16 +100,16 @@
 				scales: {
 					x: {
 						display: true,
-						scaleLabel: {
+						title: {
 							display: true,
-							labelString: 'Month'
+							text: 'Month'
 						}
 					},
 					y: {
 						display: true,
-						scaleLabel: {
+						title: {
 							display: true,
-							labelString: 'Value'
+							text: 'Value'
 						}
 					}
 				}

samples/animations/loop.html

@@ -89,16 +89,16 @@
 				scales: {
 					x: {
 						display: true,
-						scaleLabel: {
+						title: {
 							display: true,
-							labelString: 'Month'
+							text: 'Month'
 						}
 					},
 					y: {
 						display: true,
-						scaleLabel: {
+						title: {
 							display: true,
-							labelString: 'Value'
+							text: 'Value'
 						}
 					}
 				}

samples/charts/area/line-stacked.html

@@ -105,16 +105,16 @@
 				},
 				scales: {
 					x: {
-						scaleLabel: {
+						title: {
 							display: true,
-							labelString: 'Month'
+							text: 'Month'
 						}
 					},
 					y: {
 						stacked: true,
-						scaleLabel: {
+						title: {
 							display: true,
-							labelString: 'Value'
+							text: 'Value'
 						}
 					}
 				}

samples/charts/line/basic.html

@@ -80,16 +80,16 @@
 				scales: {
 					x: {
 						display: true,
-						scaleLabel: {
+						title: {
 							display: true,
-							labelString: 'Month'
+							text: 'Month'
 						}
 					},
 					y: {
 						display: true,
-						scaleLabel: {
+						title: {
 							display: true,
-							labelString: 'Value'
+							text: 'Value'
 						}
 					}
 				}

samples/charts/line/interpolation-modes.html

@@ -69,15 +69,15 @@
 				scales: {
 					x: {
 						display: true,
-						scaleLabel: {
+						title: {
 							display: true
 						}
 					},
 					y: {
 						display: true,
-						scaleLabel: {
+						title: {
 							display: true,
-							labelString: 'Value'
+							text: 'Value'
 						},
 						suggestedMin: -10,
 						suggestedMax: 200

samples/charts/line/line-styles.html

@@ -87,16 +87,16 @@
 				scales: {
 					x: {
 						display: true,
-						scaleLabel: {
+						title: {
 							display: true,
-							labelString: 'Month'
+							text: 'Month'
 						}
 					},
 					y: {
 						display: true,
-						scaleLabel: {
+						title: {
 							display: true,
-							labelString: 'Value'
+							text: 'Value'
 						}
 					}
 				}