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 > New Charts · 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 = "axes.html" / >
< link rel = "prev" href = "plugins.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 = "../getting-started/" >
< a href = "../getting-started/" >
Getting Started
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.2.1" data-path = "../getting-started/installation.html" >
< a href = "../getting-started/installation.html" >
Installation
< / a >
< / li >
< li class = "chapter " data-level = "1.2.2" data-path = "../getting-started/integration.html" >
< a href = "../getting-started/integration.html" >
Integration
< / a >
< / li >
< li class = "chapter " data-level = "1.2.3" data-path = "../getting-started/usage.html" >
< a href = "../getting-started/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 = "./" >
< a href = "./" >
Developers
< / a >
< ul class = "articles" >
< li class = "chapter " data-level = "1.7.1" data-path = "api.html" >
< a href = "api.html" >
Chart.js API
< / a >
< / li >
< li class = "chapter " data-level = "1.7.2" data-path = "updates.html" >
< a href = "updates.html" >
Updating Charts
< / a >
< / li >
< li class = "chapter " data-level = "1.7.3" data-path = "plugins.html" >
< a href = "plugins.html" >
Plugins
< / a >
< / li >
< li class = "chapter active" data-level = "1.7.4" data-path = "charts.html" >
< a href = "charts.html" >
New Charts
< / a >
< / li >
< li class = "chapter " data-level = "1.7.5" data-path = "axes.html" >
< a href = "axes.html" >
New Axes
< / a >
< / li >
< li class = "chapter " data-level = "1.7.6" data-path = "contributing.html" >
< a href = "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 = ".." > New Charts< / 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 = "new-charts" > New Charts< / h1 >
< p > Chart.js 2.0 introduces the concept of controllers for each dataset. Like scales, new controllers can be written as needed.< / p >
< pre > < code class = "lang-javascript" > Chart.controllers.MyType = Chart.DatasetController.extend({
});
< span class = "hljs-comment" > // Now we can create a new instance of our chart, using the Chart.js API< / span >
< span class = "hljs-keyword" > new< / span > Chart(ctx, {
< span class = "hljs-comment" > // this is the string the constructor was registered at, ie Chart.controllers.MyType< / span >
type: < span class = "hljs-string" > ' MyType' < / span > ,
data: data,
options: options
});
< / code > < / pre >
< h2 id = "dataset-controller-interface" > Dataset Controller Interface< / h2 >
< p > Dataset controllers must implement the following interface.< / p >
< pre > < code class = "lang-javascript" > {
< span class = "hljs-comment" > // Create elements for each piece of data in the dataset. Store elements in an array on the dataset as dataset.metaData< / span >
addElements: < span class = "hljs-function" > < span class = "hljs-keyword" > function< / span > (< span class = "hljs-params" > < / span > ) < / span > {},
< span class = "hljs-comment" > // Create a single element for the data at the given index and reset its state< / span >
addElementAndReset: < span class = "hljs-function" > < span class = "hljs-keyword" > function< / span > (< span class = "hljs-params" > index< / span > ) < / span > {},
< span class = "hljs-comment" > // Draw the representation of the dataset< / span >
< span class = "hljs-comment" > // @param ease : if specified, this number represents how far to transition elements. See the implementation of draw() in any of the provided controllers to see how this should be used< / span >
draw: < span class = "hljs-function" > < span class = "hljs-keyword" > function< / span > (< span class = "hljs-params" > ease< / span > ) < / span > {},
< span class = "hljs-comment" > // Remove hover styling from the given element< / span >
removeHoverStyle: < span class = "hljs-function" > < span class = "hljs-keyword" > function< / span > (< span class = "hljs-params" > element< / span > ) < / span > {},
< span class = "hljs-comment" > // Add hover styling to the given element< / span >
setHoverStyle: < span class = "hljs-function" > < span class = "hljs-keyword" > function< / span > (< span class = "hljs-params" > element< / span > ) < / span > {},
< span class = "hljs-comment" > // Update the elements in response to new data< / span >
< span class = "hljs-comment" > // @param reset : if true, put the elements into a reset state so they can animate to their final values< / span >
update: < span class = "hljs-function" > < span class = "hljs-keyword" > function< / span > (< span class = "hljs-params" > reset< / span > ) < / span > {},
}
< / code > < / pre >
< p > The following methods may optionally be overridden by derived dataset controllers< / p >
< pre > < code class = "lang-javascript" > {
< span class = "hljs-comment" > // Initializes the controller< / span >
initialize: < span class = "hljs-function" > < span class = "hljs-keyword" > function< / span > (< span class = "hljs-params" > chart, datasetIndex< / span > ) < / span > {},
< span class = "hljs-comment" > // Ensures that the dataset represented by this controller is linked to a scale. Overridden to helpers.noop in the polar area and doughnut controllers as these< / span >
< span class = "hljs-comment" > // chart types using a single scale< / span >
linkScales: < span class = "hljs-function" > < span class = "hljs-keyword" > function< / span > (< span class = "hljs-params" > < / span > ) < / span > {},
< span class = "hljs-comment" > // Called by the main chart controller when an update is triggered. The default implementation handles the number of data points changing and creating elements appropriately.< / span >
buildOrUpdateElements: < span class = "hljs-function" > < span class = "hljs-keyword" > function< / span > (< span class = "hljs-params" > < / span > ) < / span > {}
}
< / code > < / pre >
< h2 id = "extending-existing-chart-types" > Extending Existing Chart Types< / h2 >
< p > Extending or replacing an existing controller type is easy. Simply replace the constructor for one of the built in types with your own.< / p >
< p > The built in controller types are:< / p >
< ul >
< li > < code > Chart.controllers.line< / code > < / li >
< li > < code > Chart.controllers.bar< / code > < / li >
< li > < code > Chart.controllers.radar< / code > < / li >
< li > < code > Chart.controllers.doughnut< / code > < / li >
< li > < code > Chart.controllers.polarArea< / code > < / li >
< li > < code > Chart.controllers.bubble< / code > < / li >
< / ul >
< p > For example, to derive a new chart type that extends from a bubble chart, you would do the following.< / p >
2018-04-23 00:08:03 +00:00
< pre > < code class = "lang-javascript" > < span class = "hljs-comment" > // Sets the default config for ' derivedBubble' to be the same as the bubble defaults.< / span >
2018-03-17 17:07:55 +00:00
< span class = "hljs-comment" > // We look for the defaults by doing Chart.defaults[chartType]< / span >
< span class = "hljs-comment" > // It looks like a bug exists when the defaults don' t exist< / span >
Chart.defaults.derivedBubble = Chart.defaults.bubble;
< span class = "hljs-comment" > // I think the recommend using Chart.controllers.bubble.extend({ extensions here });< / span >
< span class = "hljs-keyword" > var< / span > custom = Chart.controllers.bubble.extend({
draw: < span class = "hljs-function" > < span class = "hljs-keyword" > function< / span > (< span class = "hljs-params" > ease< / span > ) < / span > {
< span class = "hljs-comment" > // Call super method first< / span >
Chart.controllers.bubble.prototype.draw.call(< span class = "hljs-keyword" > this< / span > , ease);
< span class = "hljs-comment" > // Now we can do some custom drawing for this dataset. Here we' ll draw a red box around the first point in each dataset< / span >
< span class = "hljs-keyword" > var< / span > meta = < span class = "hljs-keyword" > this< / span > .getMeta();
< span class = "hljs-keyword" > var< / span > pt0 = meta.data[< span class = "hljs-number" > 0< / span > ];
< span class = "hljs-keyword" > var< / span > radius = pt0._view.radius;
< span class = "hljs-keyword" > var< / span > ctx = < span class = "hljs-keyword" > this< / span > .chart.chart.ctx;
ctx.save();
ctx.strokeStyle = < span class = "hljs-string" > ' red' < / span > ;
ctx.lineWidth = < span class = "hljs-number" > 1< / span > ;
ctx.strokeRect(pt0._view.x - radius, pt0._view.y - radius, < span class = "hljs-number" > 2< / span > * radius, < span class = "hljs-number" > 2< / span > * radius);
ctx.restore();
}
});
< span class = "hljs-comment" > // Stores the controller so that the chart initialization routine can look it up with< / span >
< span class = "hljs-comment" > // Chart.controllers[type]< / span >
2018-04-23 00:08:03 +00:00
Chart.controllers.derivedBubble = custom;
2018-03-17 17:07:55 +00:00
< span class = "hljs-comment" > // Now we can create and use our new chart type< / span >
< span class = "hljs-keyword" > new< / span > Chart(ctx, {
type: < span class = "hljs-string" > ' derivedBubble' < / span > ,
data: data,
options: options,
});
< / code > < / pre >
< h3 id = "bar-controller" > Bar Controller< / h3 >
< p > The bar controller has a special property that you should be aware of. To correctly calculate the width of a bar, the controller must determine the number of datasets that map to bars. To do this, the bar controller attaches a property < code > bar< / code > to the dataset during initialization. If you are creating a replacement or updated bar controller, you should do the same. This will ensure that charts with regular bars and your new derived bars will work seamlessly.< / p >
< / 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 = "plugins.html" class = "navigation navigation-prev " aria-label = "Previous page: Plugins" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a href = "axes.html" class = "navigation navigation-next " aria-label = "Next page: New Axes" >
< 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":"New Charts","level":"1.7.4","depth":2,"next":{"title":"New Axes","level":"1.7.5","depth":2,"path":"developers/axes.md","ref":"developers/axes.md","articles":[]},"previous":{"title":"Plugins","level":"1.7.3","depth":2,"path":"developers/plugins.md","ref":"developers/plugins.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":"developers/charts.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 >
