From: Zach Panzarino Date: Tue, 9 Aug 2016 14:34:59 +0000 (+0000) Subject: Update docs and add plugin section (suggested by @simonbrunel) X-Git-Tag: v2.2.2~14^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F3110%2Fhead;p=thirdparty%2FChart.js.git Update docs and add plugin section (suggested by @simonbrunel) --- diff --git a/docs/00-Getting-Started.md b/docs/00-Getting-Started.md index 155b40c72..d6e9f0f27 100644 --- a/docs/00-Getting-Started.md +++ b/docs/00-Getting-Started.md @@ -136,4 +136,4 @@ var myChart = new Chart(ctx, { It's that easy to get started using Chart.js! From here you can explore the many options that can help you customise your charts with scales, tooltips, labels, colors, custom actions, and much more. -There are many examples of Chart.js that are available in the [samples folder](https://github.com/chartjs/Chart.js/tree/master/samples) of the GitHub repository. +There are many examples of Chart.js that are available in the `/samples` folder of `Chart.js.zip` that is attatched to every [release](https://github.com/chartjs/Chart.js/releases). diff --git a/docs/09-Advanced.md b/docs/09-Advanced.md index b1e1b65bc..7c96883ba 100644 --- a/docs/09-Advanced.md +++ b/docs/09-Advanced.md @@ -127,7 +127,7 @@ myLineChart.getDatasetAtEvent(e); #### .getDatasetMeta(index) -Looks for the dataset that matches the current index and returns that metadata. This returned data has all of the metadata that is used to construct the chart, and can be used to share data between charts. +Looks for the dataset that matches the current index and returns that metadata. This returned data has all of the metadata that is used to construct the chart. The `data` property of the metadata will contain information about each point, rectangle, etc. depending on the chart type. diff --git a/docs/10-Notes.md b/docs/10-Notes.md index 8cc103851..fbeed85fd 100644 --- a/docs/10-Notes.md +++ b/docs/10-Notes.md @@ -75,9 +75,20 @@ Built in Chart Types | Gauges | | ✓ | | | Maps (Heat/Tree/etc.) | | ✓ | | +### Popular Plugins + +There are many plugins that add additional functionality to Chart.js. Some particularly notable ones are listed here. In addition, many plugins can be found on the [Chart.js GitHub organization](https://github.com/chartjs). + + - Chart.Zoom.js - Enable zooming and panning on charts + - Chart.Annotation.js - Draw lines and boxes on chart area + - Chart.BarFunnel.js - Adds a bar funnel chart type + - Chart.Deferred.js - Defer initial chart update until chart scrolls into viewport + - Chart.Smith.js - Adds a smith chart type + - Chart.LinearGauge.js - Adds a linear gauge chart type + ### Popular Extensions -There are many extensions which are available for use with popular frameworks. Some particularly notable ones are listed here: +There are many extensions which are available for use with popular frameworks. Some particularly notable ones are listed here. #### Angular - angular-chart.js