Chart.js/docs/00-Getting-Started.md

126 lines
4.0 KiB
Markdown
Raw Normal View History

2014-06-29 19:35:49 +02:00
---
title: Getting started
anchor: getting-started
---
2016-03-26 15:57:43 +01:00
### Download Chart.js
2014-06-29 19:35:49 +02:00
You can download the latest version of [Chart.js on GitHub](https://github.com/chartjs/Chart.js/releases/latest) or just use these [Chart.js CDN](https://cdnjs.com/libraries/Chart.js) links.
If you download or clone the repository, you must run `gulp build` to generate the dist files. Chart.js no longer comes with prebuilt release versions, so an alternative option to downloading the repo is **strongly** advised.
### Installation
2016-02-13 07:03:44 +01:00
#### npm
2016-02-13 07:03:44 +01:00
```bash
npm install chart.js --save
```
#### bower
2016-02-13 07:03:44 +01:00
```bash
bower install chart.js --save
2016-02-13 07:03:44 +01:00
```
### Selecting the Correct Build
Chart.js provides two different builds that are available for your use. The `Chart.js` and `Chart.min.js` files include Chart.js and the accompanying color parsing library. If this version is used and you require the use of the time axis, [Moment.js](http://momentjs.com/) will need to be included before Chart.js.
The `Chart.bundle.js` and `Chart.bundle.min.js` builds include Moment.js in a single file. This version should be used if you require time axes and want a single file to include, select this version. Do not use this build if your application already includes Moment.js. If you do, Moment.js will be included twice, increasing the page load time and potentially introducing version issues.
### Usage
2016-02-13 07:03:44 +01:00
To import Chart.js using an old-school script tag:
2014-06-29 19:35:49 +02:00
```html
<script src="Chart.js"></script>
2016-02-13 07:03:44 +01:00
<script>
2016-04-02 04:12:37 +02:00
var myChart = new Chart({...})
2016-02-13 07:03:44 +01:00
</script>
2014-06-29 19:35:49 +02:00
```
2016-02-13 07:03:44 +01:00
To import Chart.js using an awesome module loader:
2014-06-29 19:35:49 +02:00
```javascript
2016-02-13 07:03:44 +01:00
// Using CommonJS
2016-04-02 04:12:37 +02:00
var Chart = require('src/chart.js')
2016-02-13 07:03:44 +01:00
var myChart = new Chart({...})
2014-06-29 19:35:49 +02:00
2016-02-13 07:03:44 +01:00
// ES6
2016-04-02 04:12:37 +02:00
import Chart from 'src/chart.js'
2016-02-13 07:03:44 +01:00
let myChart = new Chart({...})
2014-06-29 19:35:49 +02:00
2016-02-13 07:03:44 +01:00
// Using requirejs
require(['path/to/Chartjs'], function(Chart){
var myChart = new Chart({...})
})
2014-06-29 19:35:49 +02:00
2015-09-30 00:32:43 +02:00
```
2015-03-17 15:12:01 +01:00
2016-03-26 15:57:43 +01:00
### Creating a Chart
2014-06-29 19:35:49 +02:00
2015-09-30 00:32:43 +02:00
To create a chart, we need to instantiate the `Chart` class. To do this, we need to pass in the node, jQuery instance, or 2d context of the canvas of where we want to draw the chart. Here's an example.
2014-06-29 19:35:49 +02:00
```html
<canvas id="myChart" width="400" height="400"></canvas>
```
```javascript
2015-09-30 00:32:43 +02:00
// Any of the following formats may be used
var ctx = document.getElementById("myChart");
2014-06-29 19:35:49 +02:00
var ctx = document.getElementById("myChart").getContext("2d");
2015-11-03 13:49:34 +01:00
var ctx = $("#myChart");
2014-06-29 19:35:49 +02:00
```
2015-09-30 00:32:43 +02:00
Once you have the element or context, you're ready to instantiate a pre-defined chart-type or create your own!
2014-06-29 19:35:49 +02:00
The following example instantiates a bar chart showing the number of votes for different colors and the y-axis starting at 0.
2015-06-23 00:46:12 +02:00
```html
<canvas id="myChart" width="400" height="400"></canvas>
<script>
var ctx = document.getElementById("myChart");
2015-06-23 00:46:12 +02:00
var myChart = new Chart(ctx, {
2016-04-02 04:12:37 +02:00
type: 'bar',
data: {
labels: ["Red", "Blue", "Yellow", "Green", "Purple", "Orange"],
datasets: [{
label: '# of Votes',
2016-05-19 04:10:20 +02:00
data: [12, 19, 3, 5, 2, 3],
backgroundColor: [
'rgba(255, 99, 132, 0.2)',
'rgba(54, 162, 235, 0.2)',
'rgba(255, 206, 86, 0.2)',
'rgba(75, 192, 192, 0.2)',
'rgba(153, 102, 255, 0.2)',
'rgba(255, 159, 64, 0.2)'
],
borderColor: [
'rgba(255,99,132,1)',
'rgba(54, 162, 235, 1)',
'rgba(255, 206, 86, 1)',
'rgba(75, 192, 192, 1)',
'rgba(153, 102, 255, 1)',
'rgba(255, 159, 64, 1)'
],
borderWidth: 1
2016-04-02 04:12:37 +02:00
}]
},
options: {
scales: {
yAxes: [{
ticks: {
beginAtZero:true
}
}]
}
}
2015-06-23 00:46:12 +02:00
});
</script>
2014-06-29 19:35:49 +02:00
```
It's that easy to get started using Chart.js! From here you can explore the many options that can help you customise your charts with scales, tooltips, labels, colors, custom actions, and much more.
There are many examples of Chart.js that are available in the `/samples` folder of `Chart.js.zip` that is attatched to every [release](https://github.com/chartjs/Chart.js/releases).