<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>Area ยท Chart.js documentation</title>
<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="mixed.html" />
<link rel="prev" href="scatter.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>
<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/">
<a href="../general/interactions/">
Interactions
</a>
<ul class="articles">
<li class="chapter " data-level="1.3.3.1" data-path="../general/interactions/events.html">
<a href="../general/interactions/events.html">
Events
</a>
</li>
<li class="chapter " data-level="1.3.3.2" data-path="../general/interactions/modes.html">
<a href="../general/interactions/modes.html">
Modes
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.3.4" data-path="../general/options.html">
<a href="../general/options.html">
Options
</a>
</li>
<li class="chapter " data-level="1.3.5" data-path="../general/colors.html">
<a href="../general/colors.html">
Colors
</a>
</li>
<li class="chapter " data-level="1.3.6" data-path="../general/fonts.html">
<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="./">
<a href="./">
Charts
</a>
<ul class="articles">
<li class="chapter " data-level="1.5.1" data-path="line.html">
<a href="line.html">
Line
</a>
</li>
<li class="chapter " data-level="1.5.2" data-path="bar.html">
<a href="bar.html">
Bar
</a>
</li>
<li class="chapter " data-level="1.5.3" data-path="radar.html">
<a href="radar.html">
Radar
</a>
</li>
<li class="chapter " data-level="1.5.4" data-path="doughnut.html">
<a href="doughnut.html">
Doughnut & Pie
</a>
</li>
<li class="chapter " data-level="1.5.5" data-path="polar.html">
<a href="polar.html">
Polar Area
</a>
</li>
<li class="chapter " data-level="1.5.6" data-path="bubble.html">
<a href="bubble.html">
Bubble
</a>
</li>
<li class="chapter " data-level="1.5.7" data-path="scatter.html">
<a href="scatter.html">
Scatter
</a>
</li>
<li class="chapter active" data-level="1.5.8" data-path="area.html">
<a href="area.html">
Area
</a>
</li>
<li class="chapter " data-level="1.5.9" data-path="mixed.html">
<a href="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=".." >Area</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="area-charts">Area Charts</h1>
<p>Both <a href="line.html">line</a> and <a href="radar.html">radar</a> charts support a <code>fill</code> option on the dataset object which can be used to create area between two datasets or a dataset and a boundary, i.e. the scale <code>origin</code>, <code>start</code> or <code>end</code> (see <a href="#filling-modes">filling modes</a>).</p>
<blockquote>
<p><strong>Note:</strong> this feature is implemented by the <a href="https://github.com/chartjs/Chart.js/blob/master/src/plugins/plugin.filler.js" target="_blank"><code>filler</code> plugin</a>.</p>
</blockquote>
<h2 id="filling-modes">Filling modes</h2>
<table>
<thead>
<tr>
<th style="text-align:left">Mode</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Values</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left">Absolute dataset index <sup>1</sup></td>
<td style="text-align:left"><code>Number</code></td>
<td style="text-align:left"><code>1</code>, <code>2</code>, <code>3</code>, ...</td>
</tr>
<tr>
<td style="text-align:left">Relative dataset index <sup>1</sup></td>
<td style="text-align:left"><code>String</code></td>
<td style="text-align:left"><code>'-1'</code>, <code>'-2'</code>, <code>'+1'</code>, ...</td>
</tr>
<tr>
<td style="text-align:left">Boundary <sup>2</sup></td>
<td style="text-align:left"><code>String</code></td>
<td style="text-align:left"><code>'start'</code>, <code>'end'</code>, <code>'origin'</code></td>
</tr>
<tr>
<td style="text-align:left">Disabled <sup>3</sup></td>
<td style="text-align:left"><code>Boolean</code></td>
<td style="text-align:left"><code>false</code></td>
</tr>
</tbody>
</table>
<blockquote>
<p><sup>1</sup> dataset filling modes have been introduced in version 2.6.0<br>
<sup>2</sup> prior version 2.6.0, boundary values was <code>'zero'</code>, <code>'top'</code>, <code>'bottom'</code> (deprecated)<br>
<sup>3</sup> for backward compatibility, <code>fill: true</code> (default) is equivalent to <code>fill: 'origin'</code><br></p>
</blockquote>
<p><strong>Example</strong></p>
<pre><code class="lang-javascript"><span class="hljs-keyword">new</span> Chart(ctx, {
data: {
datasets: [
{fill: <span class="hljs-string">'origin'</span>}, <span class="hljs-comment">// 0: fill to 'origin'</span>
{fill: <span class="hljs-string">'+2'</span>}, <span class="hljs-comment">// 1: fill to dataset 3</span>
{fill: <span class="hljs-number">1</span>}, <span class="hljs-comment">// 2: fill to dataset 1</span>
{fill: <span class="hljs-literal">false</span>}, <span class="hljs-comment">// 3: no fill</span>
{fill: <span class="hljs-string">'-2'</span>} <span class="hljs-comment">// 4: fill to dataset 2</span>
]
}
})
</code></pre>
<h2 id="configuration">Configuration</h2>
<table>
<thead>
<tr>
<th style="text-align:left">Option</th>
<th style="text-align:left">Type</th>
<th style="text-align:left">Default</th>
<th style="text-align:left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left"><a href="#propagate"><code>plugins.filler.propagate</code></a></td>
<td style="text-align:left"><code>Boolean</code></td>
<td style="text-align:left"><code>true</code></td>
<td style="text-align:left">Fill propagation when target is hidden</td>
</tr>
</tbody>
</table>
<h3 id="propagate">propagate</h3>
<p>Boolean (default: <code>true</code>)</p>
<p>If <code>true</code>, the fill area will be recursively extended to the visible target defined by the <code>fill</code> value of hidden dataset targets:</p>
<p><strong>Example</strong></p>
<pre><code class="lang-javascript"><span class="hljs-keyword">new</span> Chart(ctx, {
data: {
datasets: [
{fill: <span class="hljs-string">'origin'</span>}, <span class="hljs-comment">// 0: fill to 'origin'</span>
{fill: <span class="hljs-string">'-1'</span>}, <span class="hljs-comment">// 1: fill to dataset 0</span>
{fill: <span class="hljs-number">1</span>}, <span class="hljs-comment">// 2: fill to dataset 1</span>
{fill: <span class="hljs-literal">false</span>}, <span class="hljs-comment">// 3: no fill</span>
{fill: <span class="hljs-string">'-2'</span>} <span class="hljs-comment">// 4: fill to dataset 2</span>
]
},
options: {
plugins: {
filler: {
propagate: <span class="hljs-literal">true</span>
}
}
}
})
</code></pre>
<p><code>propagate: true</code>:</p>
<ul>
<li>if dataset 2 is hidden, dataset 4 will fill to dataset 1</li>
<li>if dataset 2 and 1 are hidden, dataset 4 will fill to <code>'origin'</code></li>
</ul>
<p><code>propagate: false</code>:</p>
<ul>
<li>if dataset 2 and/or 4 are hidden, dataset 4 will not be filled</li>
</ul>
</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="scatter.html" class="navigation navigation-prev " aria-label="Previous page: Scatter">
<i class="fa fa-angle-left"></i>
</a>
<a href="mixed.html" class="navigation navigation-next " aria-label="Next page: Mixed">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Area","level":"1.5.8","depth":2,"next":{"title":"Mixed","level":"1.5.9","depth":2,"path":"charts/mixed.md","ref":"charts/mixed.md","articles":[]},"previous":{"title":"Scatter","level":"1.5.7","depth":2,"path":"charts/scatter.md","ref":"charts/scatter.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":"charts/area.md","mtime":"2018-03-01T21:46:31.675Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2018-03-01T21:50:47.970Z"},"basePath":"..","book":{"language":""}});
});
</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>
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.0/anchor.min.js"></script>
<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>