Chart.js/docs/configuration/title.md
Evert Timberg 3e94b9431a Update the docs structure/content to use GitBook (#3751)
Update the docs structure/content to use GitBook
2017-03-20 20:36:54 -04:00

1.2 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 10 Number of pixels to add above and below the title text.
text String '' Title text ti display

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'
        }
    }
})