From: wcatron Date: Tue, 24 Nov 2015 19:06:38 +0000 (-0500) Subject: Fill out descriptions and add link to scales. X-Git-Tag: 2.0.0-beta1~9^2~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=75fb79f81430969f8b7bf0bf67e53dcded22c2bb;p=thirdparty%2FChart.js.git Fill out descriptions and add link to scales. --- diff --git a/docs/02-Line-Chart.md b/docs/02-Line-Chart.md index f31609f62..18f22fad8 100644 --- a/docs/02-Line-Chart.md +++ b/docs/02-Line-Chart.md @@ -122,12 +122,12 @@ stacked | Boolean | false | If true, lines stack on top of each other along the scales | - | - | - *scales*.xAxes | Array | `[{type:"category","id":"x-axis-1"}]` | Defines all of the x axes used in the chart. See the [scale documentation](#getting-started-scales) for details on the available options. *Options for xAxes* | | | -type | String | "category" | Type of scale. Built in types are 'category' and 'linear'. +type | String | "category" | As defined in ["Category"](#scales-category-scale). id | String | "x-axis-1" | Id of the axis so that data can bind to it. | | | *scales*.yAxes | Array | `[{type:"linear","id":"y-axis-1"}]` | Defines all of the x axes used in the chart. See the [scale documentation](#getting-started-scales) for details on the available options. *Options for yAxes* | | | - type | String | "linear" | Type of scale. Built in types are 'category' and 'linear'. + type | String | "linear" | As defined in ["Linear"](#scales-linear-scale). id | String | "y-axis-1" | Id of the axis so that data can bind to it. You can override these for your `Chart` instance by passing a member `options` into the `Line` method. diff --git a/docs/03-Bar-Chart.md b/docs/03-Bar-Chart.md index dc82174c5..ed51201bb 100644 --- a/docs/03-Bar-Chart.md +++ b/docs/03-Bar-Chart.md @@ -82,23 +82,23 @@ stacked | Boolean | false | scales | Array | - | - *scales*.xAxes | Array | | The bar chart officially supports only 1 x-axis but uses an array to keep the API consistent. Use a scatter chart if you need multiple x axes. *Options for xAxes* | | | -type | String | "Category" | +type | String | "Category" | As defined in [Scales](#scales-category-scale). display | Boolean | true | If true, show the scale. position | String | "bottom" | Position of the scale. Options are "top" and "bottom" for dataset scales. id | String | "x-axis-1" | Id of the axis so that data can bind to it -categoryPercentage | Number | 0.8 | Specific to bar chart. -barPercentage | Number | 0.9 | +categoryPercentage | Number | 0.8 | Percent (0-1) of the available width (the space between the gridlines for small datasets) for each data-point to use for the bars. +barPercentage | Number | 0.9 | Percent (0-1) of the available width each bar should be within the category percentage. 1.0 will take the whole category width and put the bars right next to each other. gridLines | Array | [See Scales](#scales) | -*gridLines*.offsetGridLines | Boolean | true | +*gridLines*.offsetGridLines | Boolean | true | If true, the bars for a particular data point fall between the grid lines. If false, the grid line will go right down the middle of the bars. scaleLabel | Array | [See Scales](#scales) | ticks | Array | [See Scales](#scales) | | | | *scales*.yAxes | Array | `[{ type: "linear" }]` | *Options for xAxes* | | | -type | String | "linear" | +type | String | "linear" | As defined in [Scales](#scales-linear-scale). display | Boolean | true | If true, show the scale. position | String | "left" | Position of the scale. Options are "left" and "right" for dataset scales. -id | String | "y-axis-1" | Id of the axis so that data can bind to it +id | String | "y-axis-1" | Id of the axis so that data can bind to it. gridLines | Array | [See Scales](#scales) | scaleLabel | Array | [See Scales](#scales) | ticks | Array | [See Scales](#scales) | diff --git a/docs/04-Radar-Chart.md b/docs/04-Radar-Chart.md index 2d969547c..ddd006db5 100644 --- a/docs/04-Radar-Chart.md +++ b/docs/04-Radar-Chart.md @@ -63,10 +63,10 @@ The default options for radar chart are defined in `Chart.defaults.radar`. Name | Type | Default | Description --- | --- | --- | --- -scale | Array | [See Scales](#scales) and [Defaults for Radial Linear Scale](#getting-started-radial-linear-scale) | Options for the one scale used on the chart. Use this to style the ticks, labels, and grid. -*scale*.type | String |"radialLinear" | Contains options for the scale. +scale | Array | [See Scales](#scales) and [Defaults for Radial Linear Scale](#scales-radial-linear-scale) | Options for the one scale used on the chart. Use this to style the ticks, labels, and grid lines. +*scale*.type | String |"radialLinear" | As defined in ["Radial Linear"](#scales-radial-linear-scale). *elements*.line | Array | | Options for all line elements used on the chart, as defined in the global elements, duplicated here to show Radar chart specific defaults. -*elements.line*.tension | Number | 0 | +*elements.line*.tension | Number | 0 | Tension exhibited by lines when calculating splineCurve. You can override these for your `Chart` instance by passing a second argument into the `Radar` method as an object with the keys you want to override. diff --git a/docs/05-Polar-Area-Chart.md b/docs/05-Polar-Area-Chart.md index 03bff4a99..30e0d84ea 100644 --- a/docs/05-Polar-Area-Chart.md +++ b/docs/05-Polar-Area-Chart.md @@ -63,7 +63,7 @@ These are the customisation options specific to Polar Area charts. These options Name | Type | Default | Description --- | --- | --- | --- scale | Array | [See Scales](#scales) and [Defaults for Radial Linear Scale](#getting-started-radial-linear-scale) | Options for the one scale used on the chart. Use this to style the ticks, labels, and grid. -*scale*.type | String |"radialLinear" | Contains options for the scale. +*scale*.type | String |"radialLinear" | As defined in ["Radial Linear"](#scales-radial-linear-scale). *scale*.lineArc | Boolean | true | When true, lines are circular. *animation*.animateRotate | Boolean |true | If true, will animate the rotation of the chart. *animation*.animateScale | Boolean | true | If true, will animate scaling the chart. diff --git a/docs/06-Pie-Doughnut-Chart.md b/docs/06-Pie-Doughnut-Chart.md index 48be9d828..51aaaff22 100644 --- a/docs/06-Pie-Doughnut-Chart.md +++ b/docs/06-Pie-Doughnut-Chart.md @@ -75,8 +75,8 @@ Name | Type | Default | Description --- | --- | --- | --- cutoutPercentage | Number | 50 - for doughnut, 0 - for pie | The percentage of the chart that is cut out of the middle. scale | Array | [See Scales](#scales) and [Defaults for Radial Linear Scale](#getting-started-radial-linear-scale) | Options for the one scale used on the chart. Use this to style the ticks, labels, and grid. -*scale*.type | String |"radialLinear" | Contains options for the scale. -*scale*.lineArc | Boolean | true | When true, lines are circular. +*scale*.type | String |"radialLinear" | As defined in ["Radial Linear"](#scales-radial-linear-scale). +*scale*.lineArc | Boolean | true | When true, lines are arced compared to straight when false. *animation*.animateRotate | Boolean |true | If true, will animate the rotation of the chart. *animation*.animateScale | Boolean | false | If true, will animate scaling the Doughnut from the centre.