mirror of
https://github.com/chartjs/Chart.js.git
synced 2024-10-06 20:29:12 +02:00
1d35ebb290
* (feature) Added separate top and bottom padding for title plugin. * Added regular padding multiplier like how it was before. * Now makes use of toPadding helper. Fixed typo in toPadding helper. * Fixed requested changes.
2.0 KiB
2.0 KiB
Title
The chart title defines text to draw at the top of the chart.
Title Configuration
The title configuration is passed into the options.title
namespace. The global options for the chart title is defined in Chart.defaults.global.title
.
Name | Type | Default | Description |
---|---|---|---|
display |
boolean |
false |
Is the title shown? |
position |
string |
'top' |
Position of title. more... |
fontSize |
number |
12 |
Font size. |
fontFamily |
string |
"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif" |
Font family for the title text. |
fontColor |
Color |
'#666' |
Font color. |
fontStyle |
string |
'bold' |
Font style. |
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. |
lineHeight |
number|string |
1.2 |
Height of an individual line of text. See MDN. |
text |
string|string[] |
'' |
Title text to display. If specified as an array, text is rendered on multiple lines. |
Position
Possible title position values are:
'top'
'left'
'bottom'
'right'
Example Usage
The example below would enable a title of 'Custom Chart Title' on the chart that is created.
var chart = new Chart(ctx, {
type: 'line',
data: data,
options: {
title: {
display: true,
text: 'Custom Chart Title'
}
}
});
This example shows how to specify separate top and bottom title text padding:
var chart = new Chart(ctx, {
type: 'line',
data: data,
options: {
title: {
display: true,
text: 'Custom Chart Title',
padding: {
top: 10,
bottom: 30
}
}
}
});