]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
Adds scriptable column to options table in the title documentation (#8786)
authorstockiNail <stocki.nail@gmail.com>
Fri, 2 Apr 2021 16:13:43 +0000 (18:13 +0200)
committerGitHub <noreply@github.com>
Fri, 2 Apr 2021 16:13:43 +0000 (12:13 -0400)
* Fixes typo on padding doc
* adds column to the options table for scriptable
* Fixes table headers

docs/configuration/title.md
docs/general/padding.md

index 056725b33c7090f758ba8bee9e19abc36fab6067..4e9f30f004b1ebb71a56de5f1a57ada064c51f47 100644 (file)
@@ -6,16 +6,16 @@ The chart title defines text to draw at the top of the chart.
 
 Namespace: `options.plugins.title`, the global options for the chart title is defined in `Chart.defaults.plugins.title`.
 
-| Name | Type | Default | Description
-| ---- | ---- | ------- | -----------
-| `align` | `string` | `'center'` | Alignment of the title. [more...](#align)
-| `color` | [`Color`](../general/colors.md) | `Chart.defaults.color` | Color of text.
-| `display` | `boolean` | `false` | Is the title shown?
-| `fullSize` | `boolean` | `true` | Marks that this box should take the full width/height of the canvas. If `false`, the box is sized and placed above/beside the chart area.
-| `position` | `string` | `'top'` | Position of title. [more...](#position)
-| `font` | `Font` | `{style: 'bold'}` | See [Fonts](../general/fonts.md)
-| `padding` | [`Padding`](../general/padding.md) | `10` | Padding to apply around the title. Only `top` and `bottom` are implemented.
-| `text` | `string`\|`string[]` | `''` | Title text to display. If specified as an array, text is rendered on multiple lines.
+| Name | Type | Default | [Scriptable](../general/options.md#scriptable-options) | Description
+| ---- | ---- | ------- | :----: | -----------
+| `align` | `string` | `'center'` | Yes | Alignment of the title. [more...](#align)
+| `color` | [`Color`](../general/colors.md) | `Chart.defaults.color` | Yes | Color of text.
+| `display` | `boolean` | `false` | Yes | Is the title shown?
+| `fullSize` | `boolean` | `true` | Yes | Marks that this box should take the full width/height of the canvas. If `false`, the box is sized and placed above/beside the chart area.
+| `position` | `string` | `'top'` | Yes | Position of title. [more...](#position)
+| `font` | `Font` | `{style: 'bold'}` | Yes | See [Fonts](../general/fonts.md)
+| `padding` | [`Padding`](../general/padding.md) | `10` | Yes | Padding to apply around the title. Only `top` and `bottom` are implemented.
+| `text` | `string`\|`string[]` | `''` | Yes | Title text to display. If specified as an array, text is rendered on multiple lines.
 
 ### Position
 
index 9d3462bcd590d1a175f973dcef3a5df0ca23ab2d..97d376c9eab5ad8e0f14001265208d101e7f12a3 100644 (file)
@@ -6,7 +6,7 @@ Padding values in Chart options can be supplied in couple of different formats.
 
 If this value is a number, it is applied to all sides (left, top, right, bottom).
 
-For exmaple, defining a 20px padding to all sides of chart:
+For example, defining a 20px padding to all sides of chart:
 
 ```javascript
 let chart = new Chart(ctx, {