Merge pull request #19 from sgratzl/release/v3.7.1

Release v3.7.1

Author: sgratzl

.github/workflows/ci.yml

@@ -25,6 +25,7 @@ jobs:
       - run: yarn build
       - run: yarn lint
       - run: yarn test
+      - run: yarn samples
       - uses: actions/upload-artifact@v2
         if: failure()
         with:

.gitignore

@@ -21,4 +21,6 @@ npm-debug.log*
 /.vscode/extensions.json
 /docs
 *.tsbuildinfo
-__diff_output__
+__diff_output__
+
+/samples/type_test.js

.prettierignore

@@ -12,4 +12,5 @@
 /.vscode
 *.png
 *.tgz
-*.tsbuildinfo
+*.tsbuildinfo
+/samples/type_test.js

README.md

@@ -83,15 +83,15 @@ The ESM build of the library supports tree shaking thus having no side effects.
 Variant A:
 
 ```js
-import Chart, { LinearScale, CategoryScale } from 'chart.js';
+import { Chart, LinearScale, CategoryScale } from 'chart.js';
 import { BoxPlotController, BoxAndWiskers } from '@sgratzl/chartjs-chart-boxplot';
 
 // register controller in chart.js and ensure the defaults are set
 Chart.register(BoxPlotController, BoxAndWiskers, LinearScale, CategoryScale);
 ...
 
 new Chart(ctx, {
-  type: BoxPlotController.id,
+  type: 'boxplot',
   data: [...],
 });
 ```

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sgratzl/chartjs-chart-boxplot",
   "description": "Chart.js module for charting boxplots and violin charts",
-  "version": "3.7.0",
+  "version": "3.7.1",
   "publishConfig": {
     "access": "public"
   },
@@ -106,6 +106,7 @@
     "test": "jest --passWithNoTests",
     "test:watch": "jest --passWithNoTests --watch",
     "test:coverage": "jest --passWithNoTests --coverage",
+    "samples": "yarn tsc samples/type_test.ts",
     "lint": "yarn run eslint && yarn run prettier",
     "fix": "yarn run eslint:fix && yarn run prettier:write",
     "prettier:write": "prettier \"*\" \"*/**\" --write",

samples/type_test.ts

@@ -0,0 +1,67 @@
+import { Chart, LinearScale, CategoryScale } from 'chart.js';
+import { BoxPlotController, BoxAndWiskers, Violin, ViolinController } from '../build';
+
+// register controller in chart.js and ensure the defaults are set
+Chart.register(BoxPlotController, BoxAndWiskers, Violin, ViolinController, LinearScale, CategoryScale);
+
+const ctx = document.querySelector('canvas').getContext('2d');
+
+const myBar = new Chart(ctx, {
+  type: 'boxplot',
+  data: {
+    labels: ['vs'],
+    datasets: [
+      {
+        label: 'Dataset 1',
+        outlierRadius: 10,
+        data: [
+          [1, 2, 3, 4, 5],
+          {
+            min: 1,
+            q1: 2,
+            median: 3,
+            q3: 4,
+            max: 5,
+          },
+        ],
+      },
+    ],
+  },
+  options: {
+    elements: {
+      boxplot: {
+        outlierRadius: 10,
+      },
+    },
+  },
+});
+
+const myViolin = new Chart(ctx, {
+  type: 'violin',
+  data: {
+    labels: ['vs'],
+    datasets: [
+      {
+        label: 'Dataset 1',
+        outlierRadius: 10,
+        data: [
+          [1, 2, 3, 4, 5],
+          {
+            min: 1,
+            q1: 2,
+            median: 3,
+            q3: 4,
+            max: 5,
+          },
+        ],
+      },
+    ],
+  },
+  options: {
+    elements: {
+      violin: {
+        outlierRadius: 10,
+      },
+    },
+  },
+});

src/controllers/BoxPlotController.ts

@@ -8,6 +8,7 @@
   ChartConfiguration,
   LinearScale,
   CategoryScale,
+  AnimationOptions,
 } from 'chart.js';
 import { merge } from 'chart.js/helpers';
 import { asBoxPlotStats, IBaseStats, IBoxPlot, IBoxplotOptions } from '../data';
@@ -57,7 +58,8 @@ export interface BoxPlotControllerDatasetOptions
   extends ControllerDatasetOptions,
     IBoxplotOptions,
     ScriptableAndArrayOptions<IBoxAndWhiskersOptions, 'boxplot'>,
-    ScriptableAndArrayOptions<CommonHoverOptions, 'boxplot'> {}
+    ScriptableAndArrayOptions<CommonHoverOptions, 'boxplot'>,
+    AnimationOptions<'boxplot'> {}
 
 export type BoxPlotDataPoint = number[] | (Partial<IBoxPlot> & IBaseStats);
 

src/controllers/ViolinController.ts

@@ -8,6 +8,7 @@
   ChartConfiguration,
   LinearScale,
   CategoryScale,
+  AnimationOptions,
 } from 'chart.js';
 import { merge } from 'chart.js/helpers';
 import { asViolinStats, IBaseStats, IViolin, IViolinOptions } from '../data';
@@ -66,7 +67,8 @@ export interface ViolinControllerDatasetOptions
   extends ControllerDatasetOptions,
     IViolinOptions,
     ScriptableAndArrayOptions<IViolinElementOptions, 'violin'>,
-    ScriptableAndArrayOptions<CommonHoverOptions, 'violin'> {}
+    ScriptableAndArrayOptions<CommonHoverOptions, 'violin'>,
+    AnimationOptions<'violin'> {}
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface IViolinChartOptions {}

src/elements/BoxAndWiskers.ts

@@ -226,3 +226,9 @@ export class BoxAndWiskers extends StatsBase<IBoxAndWhiskerProps, IBoxAndWhisker
 
   static defaultRoutes = /* #__PURE__ */ { ...BarElement.defaultRoutes, ...baseRoutes };
 }
+
+declare module 'chart.js' {
+  export interface ElementOptionsByType<TType extends ChartType> {
+    boxplot: ScriptableAndArrayOptions<IBoxAndWhiskersOptions & CommonHoverOptions, ScriptableContext<TType>>;
+  }
+}

src/elements/Violin.ts

@@ -108,3 +108,9 @@ export class Violin extends StatsBase<IViolinElementProps, IViolinElementOptions
 
   static defaultRoutes = /* #__PURE__ */ { ...BarElement.defaultRoutes, ...baseRoutes };
 }
+
+declare module 'chart.js' {
+  export interface ElementOptionsByType<TType extends ChartType> {
+    violin: ScriptableAndArrayOptions<IViolinElementOptions & CommonHoverOptions, ScriptableContext<TType>>;
+  }
+}