From ae010a91b6dba8cb80ba80a765b11643f020b023 Mon Sep 17 00:00:00 2001 From: Michael Oberwasserlechner Date: Sat, 2 Jul 2016 13:55:53 +0200 Subject: [PATCH 1/4] stepSize defined twice. renaming the first to fixedStepSize --- docs/02-Scales.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/02-Scales.md b/docs/02-Scales.md index b77b42f59..44f56ad6b 100644 --- a/docs/02-Scales.md +++ b/docs/02-Scales.md @@ -141,7 +141,7 @@ beginAtZero | Boolean | - | if true, scale will inclulde 0 if it is not already min | Number | - | User defined minimum number for the scale, overrides minimum value from data. max | Number | - | User defined maximum number for the scale, overrides maximum value from data. maxTicksLimit | Number | 11 | Maximum number of ticks and gridlines to show. If not defined, it will limit to 11 ticks but will show all gridlines. -stepSize | Number | - | User defined fixed step size for the scale. If set, the scale ticks will be enumerated by multiple of stepSize, having one tick per increment. If not set, the ticks are labeled automatically using the nice numbers algorithm. +fixedStepSize | Number | - | User defined fixed step size for the scale. If set, the scale ticks will be enumerated by multiple of stepSize, having one tick per increment. If not set, the ticks are labeled automatically using the nice numbers algorithm. stepSize | Number | - | if defined, it can be used along with the min and the max to give a custom number of steps. See the example below. suggestedMax | Number | - | User defined maximum number for the scale, overrides maximum value *except for if* it is lower than the maximum value. suggestedMin | Number | - | User defined minimum number for the scale, overrides minimum value *except for if* it is higher than the minimum value. From 2feebb1cd29e89479194ffe66488b223e75a0c50 Mon Sep 17 00:00:00 2001 From: Michael Oberwasserlechner Date: Sat, 2 Jul 2016 16:35:33 +0200 Subject: [PATCH 2/4] remove redundant option entry --- docs/02-Scales.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/02-Scales.md b/docs/02-Scales.md index 44f56ad6b..79549c43d 100644 --- a/docs/02-Scales.md +++ b/docs/02-Scales.md @@ -52,7 +52,7 @@ drawTicks | Boolean | true | If true, draw lines beside the ticks in the axis a tickMarkLength | Number | 10 | Length in pixels that the grid lines will draw into the axis area. zeroLineWidth | Number | 1 | Stroke width of the grid line for the first index (index 0). zeroLineColor | Color | "rgba(0, 0, 0, 0.25)" | Stroke color of the grid line for the first index (index 0). -offsetGridLines | Boolean | false | If true, offset labels from grid lines. +offsetGridLines | Boolean | false | If true, labels are shifted to be between grid lines. This is used in the bar chart. #### Scale Title Configuration @@ -124,8 +124,6 @@ Name | Type | Default | Description --- | --- | --- | --- ticks.min | String | - | The minimum item to display. Must be a value in the `labels` array ticks.max | String | - | The maximum item to display. Must be a value in the `labels` array -gridLines.offsetGridLines | Boolean | - | If true, labels are shifted to be between grid lines. This is used in the bar chart. - ### Linear Scale From aed3d40263b77aa5014d8c3734e2dcbc9ca5122d Mon Sep 17 00:00:00 2001 From: Michael Oberwasserlechner Date: Sat, 2 Jul 2016 16:42:36 +0200 Subject: [PATCH 3/4] add id property to common configuration --- docs/02-Scales.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/02-Scales.md b/docs/02-Scales.md index 79549c43d..5597b4c1a 100644 --- a/docs/02-Scales.md +++ b/docs/02-Scales.md @@ -19,6 +19,7 @@ Name | Type | Default | Description type | String | Chart specific. | Type of scale being employed. Custom scales can be created and registered with a string key. Options: ["category"](#scales-category-scale), ["linear"](#scales-linear-scale), ["logarithmic"](#scales-logarithmic-scale), ["time"](#scales-time-scale), ["radialLinear"](#scales-radial-linear-scale) display | Boolean | true | If true, show the scale including gridlines, ticks, and labels. Overrides *gridLines.display*, *scaleLabel.display*, and *ticks.display*. position | String | "left" | Position of the scale. Possible values are 'top', 'left', 'bottom' and 'right'. +id | String | | The ID is used to link datasets and scale axes together. The properties `datasets.xAxisID` or `datasets.yAxisID` have to match the scale properties `scales.xAxes.id` or `scales.yAxes.id`. This is especially needed if multi-axes charts are used. beforeUpdate | Function | undefined | Callback called before the update process starts. Passed a single argument, the scale instance. beforeSetDimensions | Function | undefined | Callback that runs before dimensions are set. Passed a single argument, the scale instance. afterSetDimensions | Function | undefined | Callback that runs after dimensions are set. Passed a single argument, the scale instance. From 148577836396666f9d8ba64acb1408ae6429fefc Mon Sep 17 00:00:00 2001 From: Michael Oberwasserlechner Date: Sat, 2 Jul 2016 16:46:29 +0200 Subject: [PATCH 4/4] Finish incomplete sentence and remove trailing spaces. --- docs/01-Chart-Configuration.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/01-Chart-Configuration.md b/docs/01-Chart-Configuration.md index e34c99777..cba95c080 100644 --- a/docs/01-Chart-Configuration.md +++ b/docs/01-Chart-Configuration.md @@ -86,7 +86,7 @@ fullWidth | Boolean | true | Marks that this box should take the full width of t fontSize | Number | 12 | Font size inherited from global configuration fontFamily | String | "'Helvetica Neue', 'Helvetica', 'Arial', sans-serif" | Font family inherited from global configuration fontColor | Color | "#666" | Font color inherited from global configuration -fontStyle | String | 'bold' | Font styling of the title. +fontStyle | String | 'bold' | Font styling of the title. padding | Number | 10 | Number of pixels to add above and below the title text text | String | '' | Title text @@ -160,7 +160,7 @@ Items passed to the legend `onClick` function are the ones returned from `labels // For box border. See https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin lineJoin: String, - // Width of box border + // Width of box border lineWidth: Number, // Stroke style of the legend box @@ -193,7 +193,7 @@ The tooltip configuration is passed into the `options.tooltips` namespace. The g Name | Type | Default | Description --- | --- | --- | --- -enabled | Boolean | true | Are tooltips +enabled | Boolean | true | Are tooltips enabled custom | Function | null | See [section](#chart-configuration-custom-tooltips) below mode | String | 'single' | Sets which elements appear in the tooltip. Acceptable options are `'single'`, `'label'` or `'x-axis'`.
 
`single` highlights the closest element.
 
`label` highlights elements in all datasets at the same `X` value.
 
`'x-axis'` also highlights elements in all datasets at the same `X` value, but activates when hovering anywhere within the vertical slice of the x-axis representing that `X` value. itemSort | Function | undefined | Allows sorting of [tooltip items](#chart-configuration-tooltip-item-interface). Must implement a function that can be passed to [Array.prototype.sort](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) @@ -224,7 +224,7 @@ callbacks | Object | | See the [callbacks section](#chart-configuration-tooltip- #### Tooltip Callbacks -The tooltip label configuration is nested below the tooltip configuration using the `callbacks` key. The tooltip has the following callbacks for providing text. For all functions, 'this' will be the tooltip object created from the Chart.Tooltip constructor. +The tooltip label configuration is nested below the tooltip configuration using the `callbacks` key. The tooltip has the following callbacks for providing text. For all functions, 'this' will be the tooltip object created from the Chart.Tooltip constructor. All functions are called with the same arguments: a [tooltip item](#chart-configuration-tooltip-item-interface) and the data object passed to the chart. All functions must return either a string or an array of strings. Arrays of strings are treated as multiple lines of text. @@ -336,7 +336,7 @@ Arcs are used in the polar area, doughnut and pie charts. They can be configured Name | Type | Default | Description --- | --- | --- | --- -backgroundColor | Color | 'rgba(0,0,0,0.1)' | Default fill color for arcs. Inherited from the global default +backgroundColor | Color | 'rgba(0,0,0,0.1)' | Default fill color for arcs. Inherited from the global default borderColor | Color | '#fff' | Default stroke color for arcs borderWidth | Number | 2 | Default stroke width for arcs