]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
Document the `fullSize` property of the title plugin (#8488)
authorEvert Timberg <evert.timberg+github@gmail.com>
Sun, 21 Feb 2021 21:25:03 +0000 (16:25 -0500)
committerGitHub <noreply@github.com>
Sun, 21 Feb 2021 21:25:03 +0000 (23:25 +0200)
docs/docs/configuration/title.md
types/index.esm.d.ts

index e0e5572a183d95725f06055fc709de4040e63936..6fb6afc92ae82da2cb545430f06cce5a0760c546 100644 (file)
@@ -13,6 +13,7 @@ Namespace: `options.plugins.title`, the global options for the chart title is de
 | `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` | `number`\|`{top: number, bottom: number}` | `10` | Adds padding above and below the title text if a single number is specified. It is also possible to change top and bottom padding separately.
index 8d253d3157a1d36afab02785cf482080b982282c..cee5be46e7b6e3083b248d07960ca7f6573ea1b6 100644 (file)
@@ -2189,7 +2189,13 @@ export interface TitleOptions {
         */
        color: Color;
        font: FontSpec;
-       // fullSize: boolean;
+
+       /**
+        * Marks that this box should take the full width/height of the canvas (moving other boxes). If set to `false`, places the box above/beside the
+        * chart area
+        * @default true
+        */
+       fullSize: boolean;
        /**
         *      Adds padding above and below the title text if a single number is specified. It is also possible to change top and bottom padding separately.
         */