]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
minor doc fixes (#4851)
authorminusf <minusf@gmail.com>
Mon, 16 Oct 2017 22:45:54 +0000 (00:45 +0200)
committerEvert Timberg <evert.timberg+github@gmail.com>
Mon, 16 Oct 2017 22:45:54 +0000 (18:45 -0400)
docs/axes/cartesian/time.md
docs/axes/labelling.md
docs/axes/radial/linear.md
docs/axes/styling.md
docs/charts/line.md
docs/configuration/legend.md
docs/configuration/title.md
docs/configuration/tooltip.md

index e087d186817330e616328ad7b666a23c7926bf2a..9d15b5e26746cecb9081daf2ed0e3236b7eb1da8 100644 (file)
@@ -34,7 +34,7 @@ The following options are provided by the time scale. You may also set options p
 | `time.isoWeekday` | `Boolean` | `false` | If true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday.
 | `time.max` | [Time](#date-formats) | | If defined, this will override the data maximum
 | `time.min` | [Time](#date-formats) | | If defined, this will override the data minimum
-| `time.parser` | `String` or `Function` | | Custom parser for dates. [more...](#parser)
+| `time.parser` | `String/Function` | | Custom parser for dates. [more...](#parser)
 | `time.round` | `String` | `false` | If defined, dates will be rounded to the start of this unit. See [Time Units](#time-units) below for the allowed units.
 | `time.tooltipFormat` | `String` | | The moment js format string to use for the tooltip.
 | `time.unit` | `String` | `false` | If defined, will force the unit to be a certain type. See [Time Units](#time-units) section below for details.
index aec8d990ff48d45fe407dd434fb341b3656ab240..2e8f28c805cfd79add49cbaaebe4f958c49e3d1f 100644 (file)
@@ -10,12 +10,12 @@ The scale label configuration is nested under the scale configuration in the `sc
 | -----| ---- | --------| -----------
 | `display` | `Boolean` | `false` | If true, display the axis title.
 | `labelString` | `String` | `''` | The text for the title. (i.e. "# of People" or "Response Choices").
-| `lineHeight` | `Number|String` | `1.2` | Height of an individual line of text (see [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height))
-| `fontColor` | Color | `'#666'` | Font color for scale title.
+| `lineHeight` | `Number/String` | `1.2` | Height of an individual line of text (see [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height))
+| `fontColor` | `Color` | `'#666'` | Font color for scale title.
 | `fontFamily` | `String` | `"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"` | Font family for the scale title, follows CSS font-family options.
 | `fontSize` | `Number` | `12` | Font size for scale title.
 | `fontStyle` | `String` | `'normal'` | Font style for the scale title, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
-| `padding` | `Number` or `Object` | `4` | Padding to apply around scale labels. Only `top` and `bottom` are implemented.
+| `padding` | `Number/Object` | `4` | Padding to apply around scale labels. Only `top` and `bottom` are implemented.
 
 ## Creating Custom Tick Formats
 
index f9811c6f98577800a1974c50632f5fca5b8147e2..1636781a84e56278934b75c139863c57573d0393 100644 (file)
@@ -20,7 +20,7 @@ The following options are provided by the linear scale. They are all located in
 
 | Name | Type | Default | Description
 | -----| ---- | --------| -----------
-| `backdropColor` | Color | `'rgba(255, 255, 255, 0.75)'` | Color of label backdrops
+| `backdropColor` | `Color` | `'rgba(255, 255, 255, 0.75)'` | Color of label backdrops
 | `backdropPaddingX` | `Number` | `2` | Horizontal padding of label backdrop.
 | `backdropPaddingY` | `Number` | `2` | Vertical padding of label backdrop.
 | `beginAtZero` | `Boolean` | `false` | if true, scale will include 0 if it is not already included.
@@ -94,7 +94,7 @@ The following options are used to configure angled lines that radiate from the c
 | Name | Type | Default | Description
 | -----| ---- | --------| -----------
 | `display` | `Boolean` | `true` | if true, angle lines are shown
-| `color` | Color | `rgba(0, 0, 0, 0.1)` | Color of angled lines
+| `color` | `Color` | `rgba(0, 0, 0, 0.1)` | Color of angled lines
 | `lineWidth` | `Number` | `1` | Width of angled lines
 
 ## Point Label Options
@@ -104,7 +104,7 @@ The following options are used to configure the point labels that are shown on t
 | Name | Type | Default | Description
 | -----| ---- | --------| -----------
 | `callback` | `Function` | | Callback function to transform data labels to point labels. The default implementation simply returns the current string.
-| `fontColor` | Color | `'#666'` | Font color for point labels.
+| `fontColor` | `Color` | `'#666'` | Font color for point labels.
 | `fontFamily` | `String` | `"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"` | Font family to use when rendering labels.
 | `fontSize` | `Number` | 10 | font size in pixels
-| `fontStyle` | `String` | `'normal'` | Font style to use when rendering point labels.
\ No newline at end of file
+| `fontStyle` | `String` | `'normal'` | Font style to use when rendering point labels.
index 79cb4e9d66f6cf309a7214cd4e70106fd90da556..1de31e01f6c19da174cf25e10d1085923b59c9cf 100644 (file)
@@ -9,10 +9,10 @@ The grid line configuration is nested under the scale configuration in the `grid
 | Name | Type | Default | Description
 | -----| ---- | --------| -----------
 | `display` | `Boolean` | `true` | If false, do not display grid lines for this axis.
-| `color` | Color or Color[] | `'rgba(0, 0, 0, 0.1)'` | The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line and so on.
+| `color` | `Color/Color[]` | `'rgba(0, 0, 0, 0.1)'` | The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line and so on.
 | `borderDash` | `Number[]` | `[]` | Length and spacing of dashes on grid lines. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash)
 | `borderDashOffset` | `Number` | `0` | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset)
-| `lineWidth` | `Number or Number[]` | `1` | Stroke width of grid lines.
+| `lineWidth` | `Number/Number[]` | `1` | Stroke width of grid lines.
 | `drawBorder` | `Boolean` | `true` | If true, draw border at the edge between the axis and the chart area.
 | `drawOnChartArea` | `Boolean` | `true` | If true, draw lines on the chart area inside the axis lines. This is useful when there are multiple axes and you need to control which grid lines are drawn.
 | `drawTicks` | `Boolean` | `true` | If true, draw lines beside the ticks in the axis area beside the chart.
@@ -30,7 +30,7 @@ The tick configuration is nested under the scale configuration in the `ticks` ke
 | -----| ---- | --------| -----------
 | `callback` | `Function` | | Returns the string representation of the tick value as it should be displayed on the chart. See [callback](../axes/labelling.md#creating-custom-tick-formats).
 | `display` | `Boolean` | `true` | If true, show tick marks
-| `fontColor` | Color | `'#666'` | Font color for tick labels.
+| `fontColor` | `Color` | `'#666'` | Font color for tick labels.
 | `fontFamily` | `String` | `"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"` | Font family for the tick labels, follows CSS font-family options.
 | `fontSize` | `Number` | `12` | Font size for the tick labels.
 | `fontStyle` | `String` | `'normal'` | Font style for the tick labels, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
@@ -44,7 +44,7 @@ The minorTick configuration is nested under the ticks configuration in the `mino
 | Name | Type | Default | Description
 | -----| ---- | --------| -----------
 | `callback` | `Function` | | Returns the string representation of the tick value as it should be displayed on the chart. See [callback](../axes/labelling.md#creating-custom-tick-formats).
-| `fontColor` | Color | `'#666'` | Font color for tick labels.
+| `fontColor` | `Color` | `'#666'` | Font color for tick labels.
 | `fontFamily` | `String` | `"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"` | Font family for the tick labels, follows CSS font-family options.
 | `fontSize` | `Number` | `12` | Font size for the tick labels.
 | `fontStyle` | `String` | `'normal'` | Font style for the tick labels, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
@@ -55,7 +55,7 @@ The majorTick configuration is nested under the ticks configuration in the `majo
 | Name | Type | Default | Description
 | -----| ---- | --------| -----------
 | `callback` | `Function` | | Returns the string representation of the tick value as it should be displayed on the chart. See [callback](../axes/labelling.md#creating-custom-tick-formats).
-| `fontColor` | Color | `'#666'` | Font color for tick labels.
+| `fontColor` | `Color` | `'#666'` | Font color for tick labels.
 | `fontFamily` | `String` | `"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"` | Font family for the tick labels, follows CSS font-family options.
 | `fontSize` | `Number` | `12` | Font size for the tick labels.
 | `fontStyle` | `String` | `'normal'` | Font style for the tick labels, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
index cd4141a49a03f8c8170f1f7680a3dcd935b8b468..40441b7afe3e5d3f20f15d0dcf1eef477e2334c9 100644 (file)
@@ -50,7 +50,7 @@ All point* properties can be specified as an array. If these are set to an array
 | `yAxisID` | `String` | The ID of the y axis to plot this dataset on. If not specified, this defaults to the ID of the first found y axis.
 | `backgroundColor` | `Color` | The fill color under the line. See [Colors](../general/colors.md#colors)
 | `borderColor` | `Color` | The color of the line. See [Colors](../general/colors.md#colors)
-| `borderWidth` | `Number/` | The width of the line in pixels.
+| `borderWidth` | `Number` | The width of the line in pixels.
 | `borderDash` | `Number[]` | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash)
 | `borderDashOffset` | `Number` | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset)
 | `borderCapStyle` | `String` | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap)
index 4cad48b556e0c4ec74b49902218b5bfd48ba5bb8..bce69af79db1e2e88bc09066e753bd5654dde0ad 100644 (file)
@@ -31,7 +31,7 @@ The legend label configuration is nested below the legend configuration using th
 | `boxWidth` | `Number` | `40` | width of coloured box
 | `fontSize` | `Number` | `12` | font size of text
 | `fontStyle` | `String` | `'normal'` | font style of text
-| `fontColor` | Color | `'#666'` | Color of text
+| `fontColor` | `Color` | `'#666'` | Color of text
 | `fontFamily` | `String` | `"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"` | Font family of legend text.
 | `padding` | `Number` | `10` | Padding between rows of colored boxes.
 | `generateLabels` | `Function` | | Generates legend items for each thing in the legend. Default implementation returns the text + styling for the color box. See [Legend Item](#legend-item-interface) for details.
index 837ea56eb238bfd5876a28237e9ac2e2d73e8f51..e206dfe0c55cd3209de1497a924bae18f0942c61 100644 (file)
@@ -14,8 +14,8 @@ The title configuration is passed into the `options.title` namespace. The global
 | `fontColor` | `Color` | `'#666'` | Font color
 | `fontStyle` | `String` | `'bold'` | Font style
 | `padding` | `Number` | `10` | Number of pixels to add above and below the title text.
-| `lineHeight` | <code>Number&#124;String</code> | `1.2` | Height of an individual line of text (see [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height))
-| `text` | <code>String&#124;String[]</code>  | `''` | Title text to display. If specified as an array, text is rendered on multiple lines.
+| `lineHeight` | `Number/String` | `1.2` | Height of an individual line of text (see [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height))
+| `text` | `String/String[]` | `''` | Title text to display. If specified as an array, text is rendered on multiple lines.
 
 ### Position
 Possible title position values are:
index 4e1bb12b159597e6463cd75a8f595c985a8d52d8..51004843a33390b8d03fbfff40c04e8b9c71a527 100644 (file)
@@ -14,22 +14,22 @@ The tooltip configuration is passed into the `options.tooltips` namespace. The g
 | `callbacks` | `Object` | | See the [callbacks section](#tooltip-callbacks)
 | `itemSort` | `Function` | | Sort tooltip items. [more...](#sort-callback)
 | `filter` | `Function` | | Filter tooltip items. [more...](#filter-callback)
-| `backgroundColor` | Color | `'rgba(0,0,0,0.8)'` | Background color of the tooltip.
+| `backgroundColor` | `Color` | `'rgba(0,0,0,0.8)'` | Background color of the tooltip.
 | `titleFontFamily` | `String` | `"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"` | title font
 | `titleFontSize` | `Number` | `12` | Title font size
 | `titleFontStyle` | `String` | `'bold'` | Title font style
-| `titleFontColor` | Color | `'#fff'` | Title font color
+| `titleFontColor` | `Color` | `'#fff'` | Title font color
 | `titleSpacing` | `Number` | `2` | Spacing to add to top and bottom of each title line.
 | `titleMarginBottom` | `Number` | `6` | Margin to add on bottom of title section.
 | `bodyFontFamily` | `String` | `"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"` | body line font
 | `bodyFontSize` | `Number` | `12` | Body font size
 | `bodyFontStyle` | `String` | `'normal'` | Body font style
-| `bodyFontColor` | Color | `'#fff'` | Body font color
+| `bodyFontColor` | `Color` | `'#fff'` | Body font color
 | `bodySpacing` | `Number` | `2` | Spacing to add to top and bottom of each tooltip item.
 | `footerFontFamily` | `String` | `"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"` | footer font
 | `footerFontSize` | `Number` | `12` | Footer font size
 | `footerFontStyle` | `String` | `'bold'` | Footer font style
-| `footerFontColor` | Color | `'#fff'` | Footer font color
+| `footerFontColor` | `Color` | `'#fff'` | Footer font color
 | `footerSpacing` | `Number` | `2` | Spacing to add to top and bottom of each fotter line.
 | `footerMarginTop` | `Number` | `6` | Margin to add before drawing the footer.
 | `xPadding` | `Number` | `6` | Padding to add on left and right of tooltip.
@@ -37,9 +37,9 @@ The tooltip configuration is passed into the `options.tooltips` namespace. The g
 | `caretPadding` | `Number` | `2` | Extra distance to move the end of the tooltip arrow away from the tooltip point.
 | `caretSize` | `Number` | `5` | Size, in px, of the tooltip arrow.
 | `cornerRadius` | `Number` | `6` | Radius of tooltip corner curves.
-| `multiKeyBackground` | Color | `'#fff'` | Color to draw behind the colored boxes when multiple items are in the tooltip
+| `multiKeyBackground` | `Color` | `'#fff'` | Color to draw behind the colored boxes when multiple items are in the tooltip
 | `displayColors` | `Boolean` | `true` | if true, color boxes are shown in the tooltip
-| `borderColor` | Color | `'rgba(0,0,0,0)'` | Color of the border
+| `borderColor` | `Color` | `'rgba(0,0,0,0)'` | Color of the border
 | `borderWidth` | `Number` | `0` | Size of the border
 
 ### Position Modes