2018-03-17 17:07:55 +00:00
<!DOCTYPE HTML>
< html lang = "" >
< head >
< meta charset = "UTF-8" >
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
2018-04-23 00:08:03 +00:00
< title > Usage · Chart.js documentation< / title >
2018-03-17 17:07:55 +00:00
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" / >
< meta name = "description" content = "" >
< meta name = "generator" content = "GitBook 3.2.2" >
< meta name = "author" content = "chartjs" >
< link rel = "stylesheet" href = "../gitbook/style.css" >
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-search-plus/search.css" >
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-highlight/website.css" >
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-fontsettings/website.css" >
< link rel = "stylesheet" href = "../style.css" >
< meta name = "HandheldFriendly" content = "true" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1, user-scalable=no" >
< meta name = "apple-mobile-web-app-capable" content = "yes" >
< meta name = "apple-mobile-web-app-status-bar-style" content = "black" >
< link rel = "apple-touch-icon-precomposed" sizes = "152x152" href = "../gitbook/images/apple-touch-icon-precomposed-152.png" >
< link rel = "shortcut icon" href = "../gitbook/images/favicon.ico" type = "image/x-icon" >
< link rel = "next" href = "../general/" / >
< link rel = "prev" href = "integration.html" / >
< link rel = "stylesheet" href = "../gitbook/gitbook-plugin-chartjs/style.css" >
< script src = "../gitbook/gitbook-plugin-chartjs/Chart.bundle.js" > < / script >
< script src = "../gitbook/gitbook-plugin-chartjs/chartjs-plugin-deferred.js" > < / script >
< / head >
< body >
< div class = "book" >
< div class = "book-summary" >
< div id = "book-search-input" role = "search" >
< input type = "text" placeholder = "Type to search" / >
< / div >
< nav role = "navigation" >
< ul class = "summary" >
< li class = "chapter " data-level = "1.1" data-path = "../" >
< a href = "../" >
Chart.js
< / a >
< / li >
< li class = "chapter " data-level = "1.2" data-path = "./" >
< a href = "./" >
Getting Started
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.2.1" data-path = "installation.html" >
< a href = "installation.html" >
Installation
< / a >
< / li >
< li class = "chapter " data-level = "1.2.2" data-path = "integration.html" >
< a href = "integration.html" >
Integration
< / a >
< / li >
< li class = "chapter active" data-level = "1.2.3" data-path = "usage.html" >
< a href = "usage.html" >
Usage
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.3" data-path = "../general/" >
< a href = "../general/" >
General
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.3.1" data-path = "../general/responsive.html" >
< a href = "../general/responsive.html" >
Responsive
< / a >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.2" data-path = "../general/device-pixel-ratio.html" >
< a href = "../general/device-pixel-ratio.html" >
Pixel Ratio
< / a >
< / li >
< li class = "chapter " data-level = "1.3.3" data-path = "../general/interactions/" >
2018-03-17 17:07:55 +00:00
< a href = "../general/interactions/" >
Interactions
< / a >
< ul class = "articles" >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.3.1" data-path = "../general/interactions/events.html" >
2018-03-17 17:07:55 +00:00
< a href = "../general/interactions/events.html" >
Events
< / a >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.3.2" data-path = "../general/interactions/modes.html" >
2018-03-17 17:07:55 +00:00
< a href = "../general/interactions/modes.html" >
Modes
< / a >
< / li >
< / ul >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.4" data-path = "../general/options.html" >
2018-03-17 17:07:55 +00:00
< a href = "../general/options.html" >
Options
< / a >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.5" data-path = "../general/colors.html" >
2018-03-17 17:07:55 +00:00
< a href = "../general/colors.html" >
Colors
< / a >
< / li >
2018-04-23 00:08:03 +00:00
< li class = "chapter " data-level = "1.3.6" data-path = "../general/fonts.html" >
2018-03-17 17:07:55 +00:00
< a href = "../general/fonts.html" >
Fonts
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.4" data-path = "../configuration/" >
< a href = "../configuration/" >
Configuration
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.4.1" data-path = "../configuration/animations.html" >
< a href = "../configuration/animations.html" >
Animations
< / a >
< / li >
< li class = "chapter " data-level = "1.4.2" data-path = "../configuration/layout.html" >
< a href = "../configuration/layout.html" >
Layout
< / a >
< / li >
< li class = "chapter " data-level = "1.4.3" data-path = "../configuration/legend.html" >
< a href = "../configuration/legend.html" >
Legend
< / a >
< / li >
< li class = "chapter " data-level = "1.4.4" data-path = "../configuration/title.html" >
< a href = "../configuration/title.html" >
Title
< / a >
< / li >
< li class = "chapter " data-level = "1.4.5" data-path = "../configuration/tooltip.html" >
< a href = "../configuration/tooltip.html" >
Tooltip
< / a >
< / li >
< li class = "chapter " data-level = "1.4.6" data-path = "../configuration/elements.html" >
< a href = "../configuration/elements.html" >
Elements
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.5" data-path = "../charts/" >
< a href = "../charts/" >
Charts
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.5.1" data-path = "../charts/line.html" >
< a href = "../charts/line.html" >
Line
< / a >
< / li >
< li class = "chapter " data-level = "1.5.2" data-path = "../charts/bar.html" >
< a href = "../charts/bar.html" >
Bar
< / a >
< / li >
< li class = "chapter " data-level = "1.5.3" data-path = "../charts/radar.html" >
< a href = "../charts/radar.html" >
Radar
< / a >
< / li >
< li class = "chapter " data-level = "1.5.4" data-path = "../charts/doughnut.html" >
< a href = "../charts/doughnut.html" >
Doughnut & Pie
< / a >
< / li >
< li class = "chapter " data-level = "1.5.5" data-path = "../charts/polar.html" >
< a href = "../charts/polar.html" >
Polar Area
< / a >
< / li >
< li class = "chapter " data-level = "1.5.6" data-path = "../charts/bubble.html" >
< a href = "../charts/bubble.html" >
Bubble
< / a >
< / li >
< li class = "chapter " data-level = "1.5.7" data-path = "../charts/scatter.html" >
< a href = "../charts/scatter.html" >
Scatter
< / a >
< / li >
< li class = "chapter " data-level = "1.5.8" data-path = "../charts/area.html" >
< a href = "../charts/area.html" >
Area
< / a >
< / li >
< li class = "chapter " data-level = "1.5.9" data-path = "../charts/mixed.html" >
< a href = "../charts/mixed.html" >
Mixed
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.6" data-path = "../axes/" >
< a href = "../axes/" >
Axes
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.6.1" data-path = "../axes/cartesian/" >
< a href = "../axes/cartesian/" >
Cartesian
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.6.1.1" data-path = "../axes/cartesian/category.html" >
< a href = "../axes/cartesian/category.html" >
Category
< / a >
< / li >
< li class = "chapter " data-level = "1.6.1.2" data-path = "../axes/cartesian/linear.html" >
< a href = "../axes/cartesian/linear.html" >
Linear
< / a >
< / li >
< li class = "chapter " data-level = "1.6.1.3" data-path = "../axes/cartesian/logarithmic.html" >
< a href = "../axes/cartesian/logarithmic.html" >
Logarithmic
< / a >
< / li >
< li class = "chapter " data-level = "1.6.1.4" data-path = "../axes/cartesian/time.html" >
< a href = "../axes/cartesian/time.html" >
Time
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.6.2" data-path = "../axes/radial/" >
< a href = "../axes/radial/" >
Radial
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.6.2.1" data-path = "../axes/radial/linear.html" >
< a href = "../axes/radial/linear.html" >
Linear
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.6.3" data-path = "../axes/labelling.html" >
< a href = "../axes/labelling.html" >
Labelling
< / a >
< / li >
< li class = "chapter " data-level = "1.6.4" data-path = "../axes/styling.html" >
< a href = "../axes/styling.html" >
Styling
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.7" data-path = "../developers/" >
< a href = "../developers/" >
Developers
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.7.1" data-path = "../developers/api.html" >
< a href = "../developers/api.html" >
Chart.js API
< / a >
< / li >
< li class = "chapter " data-level = "1.7.2" data-path = "../developers/updates.html" >
< a href = "../developers/updates.html" >
Updating Charts
< / a >
< / li >
< li class = "chapter " data-level = "1.7.3" data-path = "../developers/plugins.html" >
< a href = "../developers/plugins.html" >
Plugins
< / a >
< / li >
< li class = "chapter " data-level = "1.7.4" data-path = "../developers/charts.html" >
< a href = "../developers/charts.html" >
New Charts
< / a >
< / li >
< li class = "chapter " data-level = "1.7.5" data-path = "../developers/axes.html" >
< a href = "../developers/axes.html" >
New Axes
< / a >
< / li >
< li class = "chapter " data-level = "1.7.6" data-path = "../developers/contributing.html" >
< a href = "../developers/contributing.html" >
Contributing
< / a >
< / li >
< / ul >
< / li >
< li class = "chapter " data-level = "1.8" data-path = "../notes/" >
< a href = "../notes/" >
Additional Notes
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.8.1" data-path = "../notes/comparison.html" >
< a href = "../notes/comparison.html" >
Comparison Table
< / a >
< / li >
< li class = "chapter " data-level = "1.8.2" data-path = "../notes/extensions.html" >
< a href = "../notes/extensions.html" >
Popular Extensions
< / a >
< / li >
< li class = "chapter " data-level = "1.8.3" data-path = "../notes/license.html" >
< a href = "../notes/license.html" >
License
< / a >
< / li >
< / ul >
< / li >
< li class = "divider" > < / li >
< li >
< a href = "https://www.gitbook.com" target = "blank" class = "gitbook-link" >
Published with GitBook
< / a >
< / li >
< / ul >
< / nav >
< / div >
< div class = "book-body" >
< div class = "body-inner" >
< div class = "book-header" role = "navigation" >
<!-- Title -->
< h1 >
< i class = "fa fa-circle-o-notch fa-spin" > < / i >
< a href = ".." > Usage< / a >
< / h1 >
< / div >
< div class = "page-wrapper" tabindex = "-1" role = "main" >
< div class = "page-inner" >
< div class = "search-plus" id = "book-search-results" >
< div class = "search-noresults" >
< section class = "normal markdown-section" >
< h1 id = "usage" > Usage< / h1 >
< p > Chart.js can be used with ES6 modules, plain JavaScript and module loaders.< / p >
< h2 id = "creating-a-chart" > Creating a Chart< / h2 >
< p > To create a chart, we need to instantiate the < code > Chart< / code > 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.< / p >
< pre > < code class = "lang-html" > < span class = "hljs-tag" > < < span class = "hljs-name" > canvas< / span > < span class = "hljs-attr" > id< / span > =< span class = "hljs-string" > " myChart" < / span > < span class = "hljs-attr" > width< / span > =< span class = "hljs-string" > " 400" < / span > < span class = "hljs-attr" > height< / span > =< span class = "hljs-string" > " 400" < / span > > < / span > < span class = "hljs-tag" > < /< span class = "hljs-name" > canvas< / span > > < / span >
< / code > < / pre >
< pre > < code class = "lang-javascript" > < span class = "hljs-comment" > // Any of the following formats may be used< / span >
< span class = "hljs-keyword" > var< / span > ctx = < span class = "hljs-built_in" > document< / span > .getElementById(< span class = "hljs-string" > " myChart" < / span > );
< span class = "hljs-keyword" > var< / span > ctx = < span class = "hljs-built_in" > document< / span > .getElementById(< span class = "hljs-string" > " myChart" < / span > ).getContext(< span class = "hljs-string" > " 2d" < / span > );
< span class = "hljs-keyword" > var< / span > ctx = $(< span class = "hljs-string" > " #myChart" < / span > );
< span class = "hljs-keyword" > var< / span > ctx = < span class = "hljs-string" > " myChart" < / span > ;
< / code > < / pre >
< p > Once you have the element or context, you' re ready to instantiate a pre-defined chart-type or create your own!< / p >
< p > The following example instantiates a bar chart showing the number of votes for different colors and the y-axis starting at 0.< / p >
< pre > < code class = "lang-html" > < span class = "hljs-tag" > < < span class = "hljs-name" > canvas< / span > < span class = "hljs-attr" > id< / span > =< span class = "hljs-string" > " myChart" < / span > < span class = "hljs-attr" > width< / span > =< span class = "hljs-string" > " 400" < / span > < span class = "hljs-attr" > height< / span > =< span class = "hljs-string" > " 400" < / span > > < / span > < span class = "hljs-tag" > < /< span class = "hljs-name" > canvas< / span > > < / span >
< span class = "hljs-tag" > < < span class = "hljs-name" > script< / span > > < / span > < span class = "javascript" >
< span class = "hljs-keyword" > var< / span > ctx = < span class = "hljs-built_in" > document< / span > .getElementById(< span class = "hljs-string" > " myChart" < / span > );
< span class = "hljs-keyword" > var< / span > myChart = < span class = "hljs-keyword" > new< / span > Chart(ctx, {
type: < span class = "hljs-string" > ' bar' < / span > ,
data: {
labels: [< span class = "hljs-string" > " Red" < / span > , < span class = "hljs-string" > " Blue" < / span > , < span class = "hljs-string" > " Yellow" < / span > , < span class = "hljs-string" > " Green" < / span > , < span class = "hljs-string" > " Purple" < / span > , < span class = "hljs-string" > " Orange" < / span > ],
datasets: [{
label: < span class = "hljs-string" > ' # of Votes' < / span > ,
data: [< span class = "hljs-number" > 12< / span > , < span class = "hljs-number" > 19< / span > , < span class = "hljs-number" > 3< / span > , < span class = "hljs-number" > 5< / span > , < span class = "hljs-number" > 2< / span > , < span class = "hljs-number" > 3< / span > ],
backgroundColor: [
< span class = "hljs-string" > ' rgba(255, 99, 132, 0.2)' < / span > ,
< span class = "hljs-string" > ' rgba(54, 162, 235, 0.2)' < / span > ,
< span class = "hljs-string" > ' rgba(255, 206, 86, 0.2)' < / span > ,
< span class = "hljs-string" > ' rgba(75, 192, 192, 0.2)' < / span > ,
< span class = "hljs-string" > ' rgba(153, 102, 255, 0.2)' < / span > ,
< span class = "hljs-string" > ' rgba(255, 159, 64, 0.2)' < / span >
],
borderColor: [
< span class = "hljs-string" > ' rgba(255,99,132,1)' < / span > ,
< span class = "hljs-string" > ' rgba(54, 162, 235, 1)' < / span > ,
< span class = "hljs-string" > ' rgba(255, 206, 86, 1)' < / span > ,
< span class = "hljs-string" > ' rgba(75, 192, 192, 1)' < / span > ,
< span class = "hljs-string" > ' rgba(153, 102, 255, 1)' < / span > ,
< span class = "hljs-string" > ' rgba(255, 159, 64, 1)' < / span >
],
borderWidth: < span class = "hljs-number" > 1< / span >
}]
},
options: {
scales: {
yAxes: [{
ticks: {
beginAtZero:< span class = "hljs-literal" > true< / span >
}
}]
}
}
});
< / span > < span class = "hljs-tag" > < /< span class = "hljs-name" > script< / span > > < / span >
< / code > < / pre >
< / section >
< / div >
< div class = "search-results" >
< div class = "has-results" >
< h1 class = "search-results-title" > < span class = 'search-results-count' > < / span > results matching "< span class = 'search-query' > < / span > "< / h1 >
< ul class = "search-results-list" > < / ul >
< / div >
< div class = "no-results" >
< h1 class = "search-results-title" > No results matching "< span class = 'search-query' > < / span > "< / h1 >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< a href = "integration.html" class = "navigation navigation-prev " aria-label = "Previous page: Integration" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a href = "../general/" class = "navigation navigation-next " aria-label = "Next page: General" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / div >
< script >
var gitbook = gitbook || [];
gitbook.push(function() {
2018-04-23 00:08:03 +00:00
gitbook.page.hasChanged({"page":{"title":"Usage","level":"1.2.3","depth":2,"next":{"title":"General","level":"1.3","depth":1,"path":"general/README.md","ref":"general/README.md","articles":[{"title":"Responsive","level":"1.3.1","depth":2,"path":"general/responsive.md","ref":"general/responsive.md","articles":[]},{"title":"Pixel Ratio","level":"1.3.2","depth":2,"path":"general/device-pixel-ratio.md","ref":"general/device-pixel-ratio.md","articles":[]},{"title":"Interactions","level":"1.3.3","depth":2,"path":"general/interactions/README.md","ref":"general/interactions/README.md","articles":[{"title":"Events","level":"1.3.3.1","depth":3,"path":"general/interactions/events.md","ref":"general/interactions/events.md","articles":[]},{"title":"Modes","level":"1.3.3.2","depth":3,"path":"general/interactions/modes.md","ref":"general/interactions/modes.md","articles":[]}]},{"title":"Options","level":"1.3.4","depth":2,"path":"general/options.md","ref":"general/options.md","articles":[]},{"title":"Colors","level":"1.3.5","depth":2,"path":"general/colors.md","ref":"general/colors.md","articles":[]},{"title":"Fonts","level":"1.3.6","depth":2,"path":"general/fonts.md","ref":"general/fonts.md","articles":[]}]},"previous":{"title":"Integration","level":"1.2.2","depth":2,"path":"getting-started/integration.md","ref":"getting-started/integration.md","articles":[]},"dir":"ltr"},"config":{"plugins":["-lunr","-search","search-plus","anchorjs","chartjs","ga"],"root":"./docs","styles":{"website":"style.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"anchorjs":{"icon":"#","placement":"left","visible":"always"},"ga":{"configuration":"auto","token":"UA-28909194-3"},"theme-default":{"styles":{"website":"style.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"search-plus":{},"chartjs":{"defaults":null},"highlight":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2}},"theme":"default","author":"chartjs","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Chart.js documentation","gitbook":"3.2.2"},"file":{"path":"getting-started/usage.md","mtime":"2018-03-01T21:46:31.679Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2018-03-01T21:50:47.970Z"},"basePath":"..","book":{"language":""}});
2018-03-17 17:07:55 +00:00
});
< / script >
< / div >
< script src = "../gitbook/gitbook.js" > < / script >
< script src = "../gitbook/theme.js" > < / script >
< script src = "../gitbook/gitbook-plugin-search-plus/jquery.mark.min.js" > < / script >
< script src = "../gitbook/gitbook-plugin-search-plus/search.js" > < / script >
2018-04-23 00:08:03 +00:00
< script src = "https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.0/anchor.min.js" > < / script >
2018-03-17 17:07:55 +00:00
< script src = "../gitbook/gitbook-plugin-anchorjs/anchor-style.js" > < / script >
< script src = "../gitbook/gitbook-plugin-ga/plugin.js" > < / script >
< script src = "../gitbook/gitbook-plugin-sharing/buttons.js" > < / script >
< script src = "../gitbook/gitbook-plugin-fontsettings/fontsettings.js" > < / script >
< / body >
< / html >
