Merge pull request #18 from sgratzl/release/v3.7.0

sgratzl · web-flow · commit 7f3757252f70 · 2022-02-18T08:39:18.000-05:00
Release v3.7.0
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -4,11 +4,14 @@
 const pkg = require('./package.json');
 
 module.exports = {
-  plugins: ['@typescript-eslint', 'prettier'],
+  plugins: [
+    // '@typescript-eslint',
+    'prettier',
+  ],
   extends: [
-    'airbnb-typescript',
+    // 'airbnb-typescript',
     'react-app',
-    'plugin:@typescript-eslint/recommended',
+    // 'plugin:@typescript-eslint/recommended',
     'plugin:prettier/recommended',
     'prettier',
   ],
diff --git a/.yarn/releases/yarn-3.1.1.cjs b/.yarn/releases/yarn-3.1.1.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -3,4 +3,4 @@ packageExtensions:
     dependencies:
       eslint-import-resolver-node: "*"
 
-yarnPath: .yarn/releases/yarn-3.1.0.cjs
+yarnPath: .yarn/releases/yarn-3.1.1.cjs
diff --git a/README.md b/README.md
@@ -83,11 +83,11 @@ The ESM build of the library supports tree shaking thus having no side effects.
 Variant A:
 
 ```js
-import Chart from 'chart.js';
-import { BoxPlotController } from '@sgratzl/chartjs-chart-boxplot';
+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);
+Chart.register(BoxPlotController, BoxAndWiskers, LinearScale, CategoryScale);
 ...
 
 new Chart(ctx, {
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@sgratzl/chartjs-chart-boxplot",
   "description": "Chart.js module for charting boxplots and violin charts",
-  "version": "3.6.0",
+  "version": "3.7.0",
   "publishConfig": {
     "access": "public"
   },
@@ -50,52 +50,52 @@
     "src/**/*.tsx"
   ],
   "peerDependencies": {
-    "chart.js": "^3.6.0"
+    "chart.js": "^3.7.0"
   },
   "browserslist": [
     "Firefox ESR",
     "last 2 Chrome versions",
     "last 2 Firefox versions"
   ],
   "dependencies": {
-    "@sgratzl/boxplots": "^1.2.2"
+    "@sgratzl/boxplots": "^1.3.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^21.0.1",
-    "@rollup/plugin-node-resolve": "^13.0.6",
-    "@rollup/plugin-replace": "^3.0.0",
+    "@rollup/plugin-node-resolve": "^13.1.3",
+    "@rollup/plugin-replace": "^3.0.1",
     "@rollup/plugin-typescript": "^8.3.0",
-    "@types/jest": "^27.0.2",
+    "@types/jest": "^27.4.0",
     "@types/jest-image-snapshot": "^4.3.1",
-    "@types/node": "^16.11.6",
-    "@typescript-eslint/eslint-plugin": "^5.3.0",
-    "@typescript-eslint/parser": "^5.3.0",
+    "@types/node": "^17.0.16",
+    "@typescript-eslint/eslint-plugin": "^5.11.0",
+    "@typescript-eslint/parser": "^5.11.0",
     "@yarnpkg/sdks": "^2.5.0",
-    "canvas": "^2.8.0",
+    "canvas": "^2.9.0",
     "canvas-5-polyfill": "^0.1.5",
-    "chart.js": "^3.6.0",
-    "eslint": "^8.1.0",
-    "eslint-config-airbnb-typescript": "^14.0.1",
+    "chart.js": "^3.7.0",
+    "eslint": "^8.8.0",
+    "eslint-config-airbnb-typescript": "^16.1.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-config-react-app": "^6.0.0",
+    "eslint-config-react-app": "^7.0.0",
     "eslint-plugin-flowtype": "^8.0.3",
-    "eslint-plugin-import": "^2.25.2",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jsx-a11y": "^6.5.1",
     "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-react": "^7.26.1",
-    "eslint-plugin-react-hooks": "^4.2.0",
-    "jest": "^27.3.1",
+    "eslint-plugin-react": "^7.28.0",
+    "eslint-plugin-react-hooks": "^4.3.0",
+    "jest": "^27.5.1",
     "jest-image-snapshot": "^4.5.1",
-    "prettier": "^2.4.1",
+    "prettier": "^2.5.1",
     "rimraf": "^3.0.2",
-    "rollup": "^2.59.0",
+    "rollup": "^2.67.1",
     "rollup-plugin-cleanup": "^3.2.1",
-    "rollup-plugin-dts": "^4.0.0",
+    "rollup-plugin-dts": "^4.1.0",
     "rollup-plugin-terser": "^7.0.2",
-    "ts-jest": "^27.0.7",
+    "ts-jest": "^27.1.3",
     "tslib": "^2.3.1",
-    "typedoc": "^0.22.7",
-    "typescript": "^4.4.4"
+    "typedoc": "^0.22.11",
+    "typescript": "^4.5.5"
   },
   "scripts": {
     "clean": "rimraf build docs node_modules \"*.tgz\" \"*.tsbuildinfo\"",
@@ -116,9 +116,9 @@
     "prepare": "yarn run build"
   },
   "dependenciesMeta": {
-    "chart.js@3.6.0": {
+    "chart.js@3.7.0": {
       "unplugged": true
     }
   },
-  "packageManager": "yarn@3.1.0"
+  "packageManager": "yarn@3.1.1"
 }
diff --git a/samples/animation.html b/samples/animation.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Box Plot Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
   </head>
 
diff --git a/samples/datalimits.html b/samples/datalimits.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Box Plot Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
     <script src="https://unpkg.com/d3-random@latest/dist/d3-random.min.js"></script>
     <script src="./utils.js"></script>
diff --git a/samples/datastructures.html b/samples/datastructures.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Box Plot Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
     <script src="https://unpkg.com/d3-random@latest/dist/d3-random.min.js"></script>
     <script src="./utils.js"></script>
diff --git a/samples/default.html b/samples/default.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Box Plot Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
     <script src="https://unpkg.com/d3-random@latest/dist/d3-random.min.js"></script>
     <script src="./utils.js"></script>
diff --git a/samples/default_esm.html b/samples/default_esm.html
@@ -11,8 +11,8 @@
     <script type="importmap-shim">
       {
         "imports": {
-          "chart.js": "https://unpkg.com/chart.js@3.6.0?module",
-          "chart.js/helpers": "https://unpkg.com/chart.js@3.6.0/helpers/helpers.esm.js?module",
+          "chart.js": "https://unpkg.com/chart.js@3.7.0?module",
+          "chart.js/helpers": "https://unpkg.com/chart.js@3.7.0/helpers/helpers.esm.js?module",
           "@sgratzl/boxplots": "https://unpkg.com/@sgratzl/boxplots?module",
           "@sgratzl/chartjs-chart-boxplot": "../build/index.js"
         }
diff --git a/samples/empty.html b/samples/empty.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Box Plot Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
   </head>
 
diff --git a/samples/fivenum.html b/samples/fivenum.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Box Plot Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
   </head>
 
diff --git a/samples/horizontalBoxplot.html b/samples/horizontalBoxplot.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Horizontal Bar Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
     <script src="https://unpkg.com/d3-random@latest/dist/d3-random.min.js"></script>
     <script src="./utils.js"></script>
diff --git a/samples/horizontalViolin.html b/samples/horizontalViolin.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Violin Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
     <script src="https://unpkg.com/d3-random@latest/dist/d3-random.min.js"></script>
     <script src="./utils.js"></script>
diff --git a/samples/hybrid.html b/samples/hybrid.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Box Plot Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
     <script src="./utils.js"></script>
   </head>
diff --git a/samples/items.html b/samples/items.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Box Plot Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
     <script src="https://unpkg.com/d3-random@latest/dist/d3-random.min.js"></script>
     <script src="./utils.js"></script>
diff --git a/samples/large_numbers.html b/samples/large_numbers.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Box Plot Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
     <script src="https://unpkg.com/d3-random@latest/dist/d3-random.min.js"></script>
     <script src="./utils.js"></script>
diff --git a/samples/logarithm.html b/samples/logarithm.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Box Plot Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
     <script src="https://unpkg.com/d3-random@latest/dist/d3-random.min.js"></script>
     <script src="./utils.js"></script>
diff --git a/samples/mediancolor.html b/samples/mediancolor.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Box Plot Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
   </head>
 
diff --git a/samples/minmax.html b/samples/minmax.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Box Plot Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
     <script src="https://unpkg.com/d3-random@latest/dist/d3-random.min.js"></script>
     <script src="./utils.js"></script>
diff --git a/samples/utils.js b/samples/utils.js
@@ -104,7 +104,7 @@ window.chartColors = {
       const count = (config || {}).count || 8;
       const data = [];
       for (let i = 0; i < count; ++i) {
-        data.push(this.numbers({ ...config, count: 50 }));
+        data.push(this.numbers({ ...config, count: config.points || 50 }));
       }
       return data;
     },
diff --git a/samples/violin.html b/samples/violin.html
@@ -2,7 +2,7 @@
 <html>
   <head>
     <title>Violin Chart</title>
-    <script src="https://unpkg.com/chart.js@3.6.0/dist/chart.js"></script>
+    <script src="https://unpkg.com/chart.js@3.7.0/dist/chart.js"></script>
     <script src="../build/index.umd.js"></script>
     <script src="https://unpkg.com/d3-random@latest/dist/d3-random.min.js"></script>
     <script src="./utils.js"></script>
@@ -25,14 +25,14 @@
             backgroundColor: color(window.chartColors.red).alpha(0.5).rgbString(),
             borderColor: window.chartColors.red,
             borderWidth: 1,
-            data: samples.boxplotsArray({ count: 7, random: random }),
+            data: samples.boxplotsArray({ count: 7, random: random, points: 200 }),
           },
           {
             label: 'Dataset 2',
             backgroundColor: color(window.chartColors.blue).alpha(0.5).rgbString(),
             borderColor: window.chartColors.blue,
             borderWidth: 1,
-            data: samples.boxplotsArray({ count: 7, random: random }),
+            data: samples.boxplotsArray({ count: 7, random: random, points: 1000 }),
           },
         ],
       };
diff --git a/src/controllers/StatsBase.ts b/src/controllers/StatsBase.ts
@@ -46,7 +46,7 @@ export /* #__PURE__ */ function baseDefaults(keys: string[]): Record<string, unk
 export function defaultOverrides(): Record<string, unknown> {
   return {
     plugins: {
-      tooltips: {
+      tooltip: {
         position: outlierPositioner.register().id,
         callbacks: {
           beforeLabel: patchInHoveredOutlier,
diff --git a/src/controllers/__image_snapshots__/violin-controller-spec-ts-violin-default-1-snap.png b/src/controllers/__image_snapshots__/violin-controller-spec-ts-violin-default-1-snap.png
diff --git a/src/data.ts b/src/data.ts
@@ -8,7 +8,6 @@ import boxplots, {
   quantilesNearest,
   quantilesType7,
 } from '@sgratzl/boxplots';
-import kde from './kde';
 
 export {
   quantilesFivenum,
@@ -196,40 +195,40 @@ export function boxplotStats(arr: readonly number[] | Float32Array | Float64Arra
   };
 }
 
-export function violinStats(arr: readonly number[], options: IViolinOptions): IViolin | undefined {
-  // console.assert(Array.isArray(arr));
-  if (arr.length === 0) {
-    return undefined;
-  }
-  const items = arr.filter((v) => typeof v === 'number' && !Number.isNaN(v)).sort((a, b) => a - b);
-
-  const mean = items.reduce((acc, v) => acc + v, 0) / items.length;
-
-  const { quantiles } = determineStatsOptions(options);
-
-  const stats = quantiles(items);
-  const min = items[0];
-  const max = items[items.length - 1];
-
+function computeSamples(min: number, max: number, points: number) {
   // generate coordinates
   const range = max - min;
-  const samples = [];
-  const inc = range / options.points;
+  const samples: number[] = [];
+  const inc = range / points;
   for (let v = min; v <= max && inc > 0; v += inc) {
     samples.push(v);
   }
   if (samples[samples.length - 1] !== max) {
     samples.push(max);
   }
-  const coords = kde(items, samples, quantiles);
+  return samples;
+}
+
+export function violinStats(arr: readonly number[], options: IViolinOptions): IViolin | undefined {
+  // console.assert(Array.isArray(arr));
+  if (arr.length === 0) {
+    return undefined;
+  }
+  const stats = boxplots(arr, determineStatsOptions(options));
+
+  // generate coordinates
+  const samples = computeSamples(stats.min, stats.max, options.points);
+  const coords = samples.map((v) => ({ v, estimate: stats.kde(v) }));
   const maxEstimate = coords.reduce((a, d) => Math.max(a, d.estimate), Number.NEGATIVE_INFINITY);
 
   return {
-    ...stats,
-    min,
-    items,
-    mean,
-    max,
+    max: stats.max,
+    min: stats.min,
+    mean: stats.mean,
+    median: stats.median,
+    q1: stats.q1,
+    q3: stats.q3,
+    items: Array.from(stats.items),
     coords,
     outliers: [], // items.filter((d) => d < stats.q1 || d > stats.q3),
     maxEstimate,
diff --git a/src/kde.ts b/src/kde.ts
diff --git a/src/tooltip.ts b/src/tooltip.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,8 @@`
`11`	`11`	`<script type="importmap-shim">`
`12`	`12`	`{`
`13`	`13`	`"imports": {`
`14`		`- "chart.js": "https://unpkg.com/chart.js@3.6.0?module",`
`15`		`- "chart.js/helpers": "https://unpkg.com/chart.js@3.6.0/helpers/helpers.esm.js?module",`
	`14`	`+ "chart.js": "https://unpkg.com/chart.js@3.7.0?module",`
	`15`	`+ "chart.js/helpers": "https://unpkg.com/chart.js@3.7.0/helpers/helpers.esm.js?module",`
`16`	`16`	`"@sgratzl/boxplots": "https://unpkg.com/@sgratzl/boxplots?module",`
`17`	`17`	`"@sgratzl/chartjs-chart-boxplot": "../build/index.js"`
`18`	`18`	`}`