Skip to content

Commit b27a460

Browse files
authored
Document the fullSize property of the title plugin (#8488)
1 parent 6f0e795 commit b27a460

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/docs/configuration/title.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Namespace: `options.plugins.title`, the global options for the chart title is de
1313
| `align` | `string` | `'center'` | Alignment of the title. [more...](#align)
1414
| `color` | [`Color`](../general/colors.md) | `Chart.defaults.color` | Color of text.
1515
| `display` | `boolean` | `false` | Is the title shown?
16+
| `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.
1617
| `position` | `string` | `'top'` | Position of title. [more...](#position)
1718
| `font` | `Font` | `{style: 'bold'}` | See [Fonts](../general/fonts.md)
1819
| `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.

types/index.esm.d.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2189,7 +2189,13 @@ export interface TitleOptions {
21892189
*/
21902190
color: Color;
21912191
font: FontSpec;
2192-
// fullSize: boolean;
2192+
2193+
/**
2194+
* 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
2195+
* chart area
2196+
* @default true
2197+
*/
2198+
fullSize: boolean;
21932199
/**
21942200
* 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.
21952201
*/

0 commit comments

Comments
 (0)