Chart.js/docs/samples/scale-options/grid.md
Jacco van den Berg 3eb947719e
Put the border opts in own object (#10571)
* put borderOpts in own object

* document z option

* remove todo and change scaleId to id

* update some tests

* clean bit, remove console log

* fix failing test

* lint

* Remove comment
2022-08-18 15:07:46 +02:00

107 lines
2.6 KiB
Markdown

# Grid Configuration
This sample shows how to use scriptable grid options for an axis to control styling. In this case, the Y axis grid lines are colored based on their value. In addition, booleans are provided to toggle different parts of the X axis grid visibility.
```js chart-editor
// <block:actions:2>
const actions = [
{
name: 'Randomize',
handler(chart) {
chart.data.datasets.forEach(dataset => {
dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});
});
chart.update();
}
},
];
// </block:actions>
// <block:setup:1>
const DATA_COUNT = 7;
const data = {
labels: Utils.months({count: DATA_COUNT}),
datasets: [
{
label: 'Dataset 1',
data: [10, 30, 39, 20, 25, 34, -10],
fill: false,
borderColor: Utils.CHART_COLORS.red,
backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),
},
{
label: 'Dataset 2',
data: [18, 33, 22, 19, 11, -39, 30],
fill: false,
borderColor: Utils.CHART_COLORS.blue,
backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),
}
]
};
// </block:setup>
// <block:config:0>
// Change these settings to change the display for different parts of the X axis
// grid configuiration
const DISPLAY = true;
const BORDER = true;
const CHART_AREA = true;
const TICKS = true;
const config = {
type: 'line',
data: data,
options: {
responsive: true,
plugins: {
title: {
display: true,
text: 'Grid Line Settings'
}
},
scales: {
x: {
border: {
display: BORDER
},
grid: {
display: DISPLAY,
drawOnChartArea: CHART_AREA,
drawTicks: TICKS,
}
},
y: {
border: {
display: false
},
grid: {
color: function(context) {
if (context.tick.value > 0) {
return Utils.CHART_COLORS.green;
} else if (context.tick.value < 0) {
return Utils.CHART_COLORS.red;
}
return '#000000';
},
},
}
}
},
};
// </block:config>
module.exports = {
actions: actions,
config: config,
};
```
## Docs
* [Line](../../charts/line.html)
* [Options](../../general/options.html)
* [Scriptable Options](../../general/options.html#scriptable-options)
* [Tick Context](../../general/options.html#tick)
* [Data structures (`labels`)](../../general/data-structures.html)
* [Axes Styling](../../axes/styling.html)
* [Grid Line Configuration](../../axes/styling.html#grid-line-configuration)