wilson.silva
/
AdminLte
espejo de https://github.com/almasaeed2010/AdminLTE


			
							12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058
							
<!DOCTYPE HTML>
<html lang="" >
    <head>
        <meta charset="UTF-8">
        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
        <title>Plugins · GitBook</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">
    <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="charts.html" />


    <link rel="prev" href="updates.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/interactions/">

                <a href="../general/interactions/">


                    Interactions

                </a>


            <ul class="articles">


        <li class="chapter " data-level="1.3.2.1" data-path="../general/interactions/events.html">

                <a href="../general/interactions/events.html">


                    Events

                </a>


        </li>

        <li class="chapter " data-level="1.3.2.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.3" data-path="../general/options.html">

                <a href="../general/options.html">


                    Options

                </a>


        </li>

        <li class="chapter " data-level="1.3.4" data-path="../general/colors.html">

                <a href="../general/colors.html">


                    Colors

                </a>


        </li>

        <li class="chapter " data-level="1.3.5" 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="../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 active" data-level="1.7.3" data-path="plugins.html">

                <a href="plugins.html">


                    Plugins

                </a>


        </li>

        <li class="chapter " 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=".." >Plugins</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="plugins">Plugins</h1>
<p>Plugins are the most efficient way to customize or change the default behavior of a chart. They have been introduced at <a href="https://github.com/chartjs/Chart.js/releases/tag/2.1.0" target="_blank">version 2.1.0</a> (global plugins only) and extended at <a href="https://github.com/chartjs/Chart.js/releases/tag/v2.5.0" target="_blank">version 2.5.0</a> (per chart plugins and options).</p>
<h2 id="using-plugins">Using plugins</h2>
<p>Plugins can be shared between chart instances:</p>
<pre><code class="lang-javascript"><span class="hljs-keyword">var</span> plugin = { <span class="hljs-comment">/* plugin implementation */</span> };

<span class="hljs-comment">// chart1 and chart2 use &quot;plugin&quot;</span>
<span class="hljs-keyword">var</span> chart1 = <span class="hljs-keyword">new</span> Chart(ctx, {
    plugins: [plugin]
});

<span class="hljs-keyword">var</span> chart2 = <span class="hljs-keyword">new</span> Chart(ctx, {
    plugins: [plugin]
});

<span class="hljs-comment">// chart3 doesn&apos;t use &quot;plugin&quot;</span>
<span class="hljs-keyword">var</span> chart3 = <span class="hljs-keyword">new</span> Chart(ctx, {});
</code></pre>
<p>Plugins can also be defined directly in the chart <code>plugins</code> config (a.k.a. <em>inline plugins</em>):</p>
<pre><code class="lang-javascript"><span class="hljs-keyword">var</span> chart = <span class="hljs-keyword">new</span> Chart(ctx, {
    plugins: [{
        beforeInit: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">chart, options</span>) </span>{
            <span class="hljs-comment">//..</span>
        }
    }]
});
</code></pre>
<p>However, this approach is not ideal when the customization needs to apply to many charts.</p>
<h2 id="global-plugins">Global plugins</h2>
<p>Plugins can be registered globally to be applied on all charts (a.k.a. <em>global plugins</em>):</p>
<pre><code class="lang-javascript">Chart.plugins.register({
    <span class="hljs-comment">// plugin implementation</span>
});
</code></pre>
<blockquote>
<p>Note: <em>inline</em> plugins can&apos;t be registered globally.</p>
</blockquote>
<h2 id="configuration">Configuration</h2>
<h3 id="plugin-id">Plugin ID</h3>
<p>Plugins must define a unique id in order to be configurable.</p>
<p>This id should follow the <a href="https://docs.npmjs.com/files/package.json#name" target="_blank">npm package name convention</a>:</p>
<ul>
<li>can&apos;t start with a dot or an underscore</li>
<li>can&apos;t contain any non-URL-safe characters</li>
<li>can&apos;t contain uppercase letters</li>
<li>should be something short, but also reasonably descriptive</li>
</ul>
<p>If a plugin is intended to be released publicly, you may want to check the <a href="https://www.npmjs.com/search?q=chartjs-plugin-" target="_blank">registry</a> to see if there&apos;s something by that name already. Note that in this case, the package name should be prefixed by <code>chartjs-plugin-</code> to appear in Chart.js plugin registry.</p>
<h3 id="plugin-options">Plugin options</h3>
<p>Plugin options are located under the <code>options.plugins</code> config and are scoped by the plugin ID: <code>options.plugins.{plugin-id}</code>.</p>
<pre><code class="lang-javascript"><span class="hljs-keyword">var</span> chart = <span class="hljs-keyword">new</span> Chart(ctx, {
    config: {
        foo: { ... },           <span class="hljs-comment">// chart &apos;foo&apos; option</span>
        plugins: {
            p1: {
                foo: { ... },   <span class="hljs-comment">// p1 plugin &apos;foo&apos; option</span>
                bar: { ... }
            },
            p2: {
                foo: { ... },   <span class="hljs-comment">// p2 plugin &apos;foo&apos; option</span>
                bla: { ... }
            }
        }
    }
});
</code></pre>
<h4 id="disable-plugins">Disable plugins</h4>
<p>To disable a global plugin for a specific chart instance, the plugin options must be set to <code>false</code>:</p>
<pre><code class="lang-javascript">Chart.plugins.register({
    id: <span class="hljs-string">&apos;p1&apos;</span>,
    <span class="hljs-comment">// ...</span>
});

<span class="hljs-keyword">var</span> chart = <span class="hljs-keyword">new</span> Chart(ctx, {
    config: {
        plugins: {
            p1: <span class="hljs-literal">false</span>   <span class="hljs-comment">// disable plugin &apos;p1&apos; for this instance</span>
        }
    }
});
</code></pre>
<h2 id="plugin-core-api">Plugin Core API</h2>
<p>Available hooks (as of version 2.6):</p>
<ul>
<li>beforeInit</li>
<li>afterInit</li>
<li>beforeUpdate <em>(cancellable)</em></li>
<li>afterUpdate</li>
<li>beforeLayout <em>(cancellable)</em></li>
<li>afterLayout</li>
<li>beforeDatasetsUpdate <em>(cancellable)</em></li>
<li>afterDatasetsUpdate</li>
<li>beforeDatasetUpdate <em>(cancellable)</em></li>
<li>afterDatasetUpdate</li>
<li>beforeRender <em>(cancellable)</em></li>
<li>afterRender</li>
<li>beforeDraw <em>(cancellable)</em></li>
<li>afterDraw</li>
<li>beforeDatasetsDraw <em>(cancellable)</em></li>
<li>afterDatasetsDraw</li>
<li>beforeDatasetDraw <em>(cancellable)</em></li>
<li>afterDatasetDraw</li>
<li>beforeEvent <em>(cancellable)</em></li>
<li>afterEvent</li>
<li>resize</li>
<li>destroy</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="updates.html" class="navigation navigation-prev " aria-label="Previous page: Updating Charts">
                    <i class="fa fa-angle-left"></i>
                </a>


                <a href="charts.html" class="navigation navigation-next " aria-label="Next page: New Charts">
                    <i class="fa fa-angle-right"></i>
                </a>


    </div>

    <script>
        var gitbook = gitbook || [];
        gitbook.push(function() {
            gitbook.page.hasChanged({"page":{"title":"Plugins","level":"1.7.3","depth":2,"next":{"title":"New Charts","level":"1.7.4","depth":2,"path":"developers/charts.md","ref":"developers/charts.md","articles":[]},"previous":{"title":"Updating Charts","level":"1.7.2","depth":2,"path":"developers/updates.md","ref":"developers/updates.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":{},"gitbook":"3.2.2"},"file":{"path":"developers/plugins.md","mtime":"2017-10-28T15:03:49.266Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-10-28T15:09:53.587Z"},"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/3.1.1/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>