Add example plugins for border and quadrants (#8942)

chartjs · Apr 18, 2021 · 019cb9f · 019cb9f
1 parent 3e319f7
commit 019cb9f
Show file tree

Hide file tree

Showing 3 changed files with 149 additions and 0 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -257,6 +257,13 @@ module.exports = {
             'advanced/derived-chart-type',
           ]
         },
+        {
+          title: 'Plugins',
+          children: [
+            'plugins/chart-area-border',
+            'plugins/quadrants',
+          ]
+        },
       ],
       '/': [
         '',

diff --git a/docs/samples/plugins/chart-area-border.md b/docs/samples/plugins/chart-area-border.md
@@ -0,0 +1,63 @@
+# Chart Area Border
+
+```js chart-editor
+// <block:data:2>
+const DATA_COUNT = 7;
+const NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};
+const labels = Utils.months({count: 7});
+const data = {
+  labels: labels,
+  datasets: [
+    {
+      label: 'Dataset 1',
+      data: Utils.numbers(NUMBER_CFG),
+      borderColor: Utils.CHART_COLORS.red,
+      backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),
+    },
+    {
+      label: 'Dataset 2',
+      data: Utils.numbers(NUMBER_CFG),
+      borderColor: Utils.CHART_COLORS.blue,
+      backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),
+    }
+  ]
+};
+// </block:data>
+
+// <block:plugin:1>
+const chartAreaBorder = {
+  id: 'chartAreaBorder',
+  beforeDraw(chart, args, options) {
+    const {ctx, chartArea: {left, top, width, height}} = chart;
+    ctx.save();
+    ctx.strokeStyle = options.borderColor;
+    ctx.lineWidth = options.borderWidth;
+    ctx.setLineDash(options.borderDash || []);
+    ctx.lineDashOffset = options.borderDashOffset;
+    ctx.strokeRect(left, top, width, height);
+    ctx.restore();
+  }
+};
+// </block:plugin>
+
+// <block:config:0>
+const config = {
+  type: 'line',
+  data: data,
+  options: {
+    plugins: {
+      chartAreaBorder: {
+        borderColor: 'red',
+        borderWidth: 2,
+        borderDash: [5, 5],
+        borderDashOffset: 2,
+      }
+    }
+  },
+  plugins: [chartAreaBorder]
+};
+// </block:config>
+
+module.exports = {
+  config: config,
+};
diff --git a/docs/samples/plugins/quadrants.md b/docs/samples/plugins/quadrants.md
@@ -0,0 +1,79 @@
+# Quadrants
+
+```js chart-editor
+// <block:data:2>
+const DATA_COUNT = 7;
+const NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};
+const data = {
+  datasets: [
+    {
+      label: 'Dataset 1',
+      data: Utils.points(NUMBER_CFG),
+      borderColor: Utils.CHART_COLORS.red,
+      backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),
+    },
+    {
+      label: 'Dataset 2',
+      data: Utils.points(NUMBER_CFG),
+      borderColor: Utils.CHART_COLORS.blue,
+      backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),
+    }
+  ]
+};
+// </block:data>
+
+// <block:plugin:1>
+const quadrants = {
+  id: 'quadrants',
+  beforeDraw(chart, args, options) {
+    const {ctx, chartArea: {left, top, right, bottom}, scales: {x, y}} = chart;
+    const midX = x.getPixelForValue(0);
+    const midY = y.getPixelForValue(0);
+    ctx.save();
+    ctx.fillStyle = options.topLeft;
+    ctx.fillRect(left, top, midX - left, midY - top);
+    ctx.fillStyle = options.topRight;
+    ctx.fillRect(midX, top, right - midX, midY - top);
+    ctx.fillStyle = options.bottomRight;
+    ctx.fillRect(midX, midY, right - midX, bottom - midY);
+    ctx.fillStyle = options.bottomLeft;
+    ctx.fillRect(left, midY, midX - left, bottom - midY);
+    ctx.restore();
+  }
+};
+// </block:plugin>
+
+// <block:config:0>
+const config = {
+  type: 'scatter',
+  data: data,
+  options: {
+    plugins: {
+      quadrants: {
+        topLeft: Utils.CHART_COLORS.red,
+        topRight: Utils.CHART_COLORS.blue,
+        bottomRight: Utils.CHART_COLORS.green,
+        bottomLeft: Utils.CHART_COLORS.yellow,
+      }
+    }
+  },
+  plugins: [quadrants]
+};
+// </block:config>
+
+const actions = [
+  {
+    name: 'Randomize',
+    handler(chart) {
+      chart.data.datasets.forEach(dataset => {
+        dataset.data = Utils.points(NUMBER_CFG);
+      });
+      chart.update();
+    }
+  },
+];
+
+module.exports = {
+  actions,
+  config,
+};