]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
Adds backgroundColor and borderColor options to the documentation (#8257)
authorstockiNail <stocki.nail@gmail.com>
Thu, 31 Dec 2020 15:19:58 +0000 (16:19 +0100)
committerGitHub <noreply@github.com>
Thu, 31 Dec 2020 15:19:58 +0000 (10:19 -0500)
docs/docs/general/colors.md

index 1dc5083332b123701e14b79eea0d4426e1ca1ea6..828d223ca799b23087c8ec9e95dac3180d2c721e 100644 (file)
@@ -2,7 +2,13 @@
 title: Colors
 ---
 
-When supplying colors to Chart options, you can use a number of formats. You can specify the color as a string in hexadecimal, RGB, or HSL notations. If a color is needed, but not specified, Chart.js will use the global default color. This color is stored at `Chart.defaults.color`. It is initially set to `'rgba(0, 0, 0, 0.1)'`.
+When supplying colors to Chart options, you can use a number of formats. You can specify the color as a string in hexadecimal, RGB, or HSL notations. If a color is needed, but not specified, Chart.js will use the global default color. There are 3 color options, stored at `Chart.defaults`, to set:
+
+| Name | Type | Default | Description
+| ---- | ---- | ------- | -----------
+| `backgroundColor` | `Color` | `rgba(0, 0, 0, 0.1)` | Background color.
+| `borderColor` | `Color` | `rgba(0, 0, 0, 0.1)` | Border color.
+| `color` | `Color` | `#666` | Font color.
 
 You can also pass a [CanvasGradient](https://developer.mozilla.org/en-US/docs/Web/API/CanvasGradient) object. You will need to create this before passing to the chart, but using it you can achieve some interesting effects.