| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000 | 
<!DOCTYPE HTML><html lang="" >    <head>        <meta charset="UTF-8">        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">        <title>Options · 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="colors.html" />            <link rel="prev" href="interactions/modes.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="./">                            <a href="./">                                                    General                            </a>                                    <ul class="articles">                            <li class="chapter " data-level="1.3.1" data-path="responsive.html">                            <a href="responsive.html">                                                    Responsive                            </a>                                </li>            <li class="chapter " data-level="1.3.2" data-path="device-pixel-ratio.html">                            <a href="device-pixel-ratio.html">                                                    Pixel Ratio                            </a>                                </li>            <li class="chapter " data-level="1.3.3" data-path="interactions/">                            <a href="interactions/">                                                    Interactions                            </a>                                    <ul class="articles">                            <li class="chapter " data-level="1.3.3.1" data-path="interactions/events.html">                            <a href="interactions/events.html">                                                    Events                            </a>                                </li>            <li class="chapter " data-level="1.3.3.2" data-path="interactions/modes.html">                            <a href="interactions/modes.html">                                                    Modes                            </a>                                </li>                </ul>                    </li>            <li class="chapter active" data-level="1.3.4" data-path="options.html">                            <a href="options.html">                                                    Options                            </a>                                </li>            <li class="chapter " data-level="1.3.5" data-path="colors.html">                            <a href="colors.html">                                                    Colors                            </a>                                </li>            <li class="chapter " data-level="1.3.6" data-path="fonts.html">                            <a href="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=".." >Options</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="options">Options</h1><h2 id="scriptable-options">Scriptable Options</h2><p>Scriptable options also accept a function which is called for each data and that takes the unique argument <code>context</code> representing contextual information (see <a href="options.html#option-context">option context</a>).</p><p>Example:</p><pre><code class="lang-javascript">color: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">context</span>) </span>{    <span class="hljs-keyword">var</span> index = context.dataIndex;    <span class="hljs-keyword">var</span> value = context.dataset.data[index];    <span class="hljs-keyword">return</span> value < <span class="hljs-number">0</span> ? <span class="hljs-string">'red'</span> :  <span class="hljs-comment">// draw negative values in red</span>        index % <span class="hljs-number">2</span> ? <span class="hljs-string">'blue'</span> :    <span class="hljs-comment">// else, alternate values in blue and green</span>        <span class="hljs-string">'green'</span>;}</code></pre><blockquote><p><strong>Note:</strong> scriptable options are only supported by a few bubble chart options.</p></blockquote><h2 id="indexable-options">Indexable Options</h2><p>Indexable options also accept an array in which each item corresponds to the element at the same index. Note that this method requires to provide as many items as data, so, in most cases, using a <a href="#scriptable-options">function</a> is more appropriated if supported.</p><p>Example:</p><pre><code class="lang-javascript">color: [    <span class="hljs-string">'red'</span>,    <span class="hljs-comment">// color for data at index 0</span>    <span class="hljs-string">'blue'</span>,   <span class="hljs-comment">// color for data at index 1</span>    <span class="hljs-string">'green'</span>,  <span class="hljs-comment">// color for data at index 2</span>    <span class="hljs-string">'black'</span>,  <span class="hljs-comment">// color for data at index 3</span>    <span class="hljs-comment">//...</span>]</code></pre><h2 id="option-context">Option Context</h2><p>The option context is used to give contextual information when resolving options and currently only applies to <a href="#scriptable-options">scriptable options</a>.</p><p>The context object contains the following properties:</p><ul><li><code>chart</code>: the associated chart</li><li><code>dataIndex</code>: index of the current data</li><li><code>dataset</code>: dataset at index <code>datasetIndex</code></li><li><code>datasetIndex</code>: index of the current dataset</li></ul><p><strong>Important</strong>: since the context can represent different types of entities (dataset, data, etc.), some properties may be <code>undefined</code> so be sure to test any context property before using it.</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="interactions/modes.html" class="navigation navigation-prev " aria-label="Previous page: Modes">                    <i class="fa fa-angle-left"></i>                </a>                                                <a href="colors.html" class="navigation navigation-next " aria-label="Next page: Colors">                    <i class="fa fa-angle-right"></i>                </a>                                        </div>    <script>        var gitbook = gitbook || [];        gitbook.push(function() {            gitbook.page.hasChanged({"page":{"title":"Options","level":"1.3.4","depth":2,"next":{"title":"Colors","level":"1.3.5","depth":2,"path":"general/colors.md","ref":"general/colors.md","articles":[]},"previous":{"title":"Modes","level":"1.3.3.2","depth":3,"path":"general/interactions/modes.md","ref":"general/interactions/modes.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":"general/options.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":""}});        });    </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>
 |