@bitblit/ratchet-echarts 6.0.146-alpha → 6.0.148-alpha

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@bitblit/ratchet-echarts",
-  "version": "6.0.146-alpha",
+  "version": "6.0.148-alpha",
   "description": "Library for using echarts on Node",
   "type": "module",
   "files": [
+    "src/**",
     "lib/**",
     "bin/**"
   ],
@@ -34,12 +35,12 @@
   "config": {},
   "license": "Apache-2.0",
   "dependencies": {
-    "@bitblit/ratchet-common": "6.0.146-alpha",
+    "@bitblit/ratchet-common": "6.0.148-alpha",
     "canvas": "3.2.0",
     "echarts": "6.0.0"
   },
   "peerDependencies": {
-    "@bitblit/ratchet-common": "6.0.146-alpha",
+    "@bitblit/ratchet-common": "6.0.148-alpha",
     "canvas": "^3.2.0 ",
     "echarts": "^6.0.0"
   }

package/src/build/ratchet-echarts-info.ts

@@ -0,0 +1,19 @@
+import { BuildInformation } from '@bitblit/ratchet-common/build/build-information';
+
+export class RatchetEchartsInfo {
+  // Empty constructor prevents instantiation
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  private constructor() {}
+
+  public static buildInformation(): BuildInformation {
+    const val: BuildInformation = {
+      version: 'LOCAL-SNAPSHOT',
+      hash: 'LOCAL-HASH',
+      branch: 'LOCAL-BRANCH',
+      tag: 'LOCAL-TAG',
+      timeBuiltISO: 'LOCAL-TIME-ISO',
+      notes: 'LOCAL-NOTES',
+    };
+    return val;
+  }
+}

package/src/common/echart-canvas-config.ts

@@ -0,0 +1,4 @@
+export interface EChartCanvasConfig {
+  width: number; // Image width, type is number.
+  height: number; // Image height, type is number.
+}

package/src/common/echart-ratchet.ts

@@ -0,0 +1,58 @@
+import * as echarts from 'echarts';
+import { ECharts, EChartsOption } from 'echarts';
+import { Canvas } from 'canvas';
+import { EChartCanvasConfig } from './echart-canvas-config.js';
+import fs from 'fs';
+
+export class EChartRatchet {
+  public static async renderChartUsingProvidedCanvas(opt: EChartsOption, canvas: Canvas): Promise<Buffer> {
+    if (!opt) {
+      throw new Error('You must supply an opts parameter');
+    }
+    if (!canvas) {
+      throw new Error('You must supply an canvas parameter');
+    }
+    let rval: Buffer = null;
+
+    opt.animation = false; // Always do not animate given its is a static image
+    const canvasHtml: HTMLElement = canvas as unknown as HTMLElement;
+    // This is deprecated, and unneeded so far as I can tell
+    //echarts.setCanvasCreator(()=>{return canvasHtml;});
+    const chart: ECharts = echarts.init(canvasHtml);
+    chart.setOption(opt);
+    rval = canvas.toBuffer();
+    return rval;
+  }
+
+  public static async renderChart(opts: EChartsOption, config: EChartCanvasConfig): Promise<Buffer> {
+    if (!opts) {
+      throw new Error('You must supply an opts parameter');
+    }
+    if (!config) {
+      throw new Error('You must supply an config parameter');
+    }
+    const canvas: Canvas = new Canvas(config.width, config.height);
+    const rval: Buffer = await this.renderChartUsingProvidedCanvas(opts, canvas);
+
+    return rval;
+  }
+
+  public static async renderChartToPngFile(filename: string, opts: EChartsOption, config: EChartCanvasConfig): Promise<Buffer> {
+    if (!opts) {
+      throw new Error('You must supply an opts parameter');
+    }
+    if (!config) {
+      throw new Error('You must supply an config parameter');
+    }
+    if (!filename || filename.trim().length === 0) {
+      throw new Error('You must supply a non-empty filename parameter');
+    }
+    if (!filename.toLowerCase().endsWith('.png')) {
+      throw new Error('Your filename should end with .png - this generates a png file');
+    }
+    const rval: Buffer = await this.renderChart(opts, config);
+    fs.writeFileSync(filename, rval);
+
+    return rval;
+  }
+}

package/src/examples/area.spec.ts

@@ -0,0 +1,113 @@
+import { EChartsOption } from 'echarts';
+import { EChartRatchet } from '../common/echart-ratchet.js';
+import { describe, expect, test } from 'vitest';
+
+const options: EChartsOption = {
+  title: {
+    text: 'Stacked Area Chart',
+  },
+  tooltip: {
+    trigger: 'axis',
+    axisPointer: {
+      type: 'cross',
+      label: {
+        backgroundColor: '#6a7985',
+      },
+    },
+  },
+  legend: {
+    data: ['Email', 'Union Ads', 'Video Ads', 'Direct', 'Search Engine'],
+  },
+  toolbox: {
+    feature: {
+      saveAsImage: {},
+    },
+  },
+  grid: {
+    left: '3%',
+    right: '4%',
+    bottom: '3%',
+    containLabel: true,
+  },
+  xAxis: [
+    {
+      type: 'category',
+      boundaryGap: false,
+      data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'],
+    },
+  ],
+  yAxis: [
+    {
+      type: 'value',
+    },
+  ],
+  series: [
+    {
+      name: 'Email',
+      type: 'line',
+      stack: 'Total',
+      areaStyle: {},
+      emphasis: {
+        focus: 'series',
+      },
+      data: [120, 132, 101, 134, 90, 230, 210],
+    },
+    {
+      name: 'Union Ads',
+      type: 'line',
+      stack: 'Total',
+      areaStyle: {},
+      emphasis: {
+        focus: 'series',
+      },
+      data: [220, 182, 191, 234, 290, 330, 310],
+    },
+    {
+      name: 'Video Ads',
+      type: 'line',
+      stack: 'Total',
+      areaStyle: {},
+      emphasis: {
+        focus: 'series',
+      },
+      data: [150, 232, 201, 154, 190, 330, 410],
+    },
+    {
+      name: 'Direct',
+      type: 'line',
+      stack: 'Total',
+      areaStyle: {},
+      emphasis: {
+        focus: 'series',
+      },
+      data: [320, 332, 301, 334, 390, 330, 320],
+    },
+    {
+      name: 'Search Engine',
+      type: 'line',
+      stack: 'Total',
+      label: {
+        show: true,
+        position: 'top',
+      },
+      areaStyle: {},
+      emphasis: {
+        focus: 'series',
+      },
+      data: [820, 932, 901, 934, 1290, 1330, 1320],
+    },
+  ],
+};
+
+describe('#areaChart', function () {
+  test('should generate the chart', {timeout: 10_000},async () => {
+    const data: Buffer = await EChartRatchet.renderChart(options, {
+      width: 1000,
+      height: 500,
+    });
+
+    // As of 2025-08-24 this is 60589... there must be a better test than this...
+    expect(data.length).toBeGreaterThan(55_000);
+    expect(data.length).toBeLessThan(65_000);
+  });
+});

package/src/examples/bar.spec.ts

@@ -0,0 +1,77 @@
+import { EChartsOption } from 'echarts';
+import { EChartRatchet } from '../common/echart-ratchet.js';
+import { LabelOption } from 'echarts/types/src/util/types.js';
+import { describe, expect, test } from 'vitest';
+
+const labelRight: LabelOption = {
+  position: 'right',
+};
+
+const options: EChartsOption = {
+  title: {
+    text: 'Bar Chart with Negative Value',
+  },
+  tooltip: {
+    trigger: 'axis',
+    axisPointer: {
+      type: 'shadow',
+    },
+  },
+  grid: {
+    top: 80,
+    bottom: 30,
+  },
+  xAxis: {
+    type: 'value',
+    position: 'top',
+    splitLine: {
+      lineStyle: {
+        type: 'dashed',
+      },
+    },
+  },
+  yAxis: {
+    type: 'category',
+    axisLine: { show: false },
+    axisLabel: { show: false },
+    axisTick: { show: false },
+    splitLine: { show: false },
+    data: ['ten', 'nine', 'eight', 'seven', 'six', 'five', 'four', 'three', 'two', 'one'],
+  },
+  series: [
+    {
+      name: 'Cost',
+      type: 'bar',
+      stack: 'Total',
+      label: {
+        show: true,
+        formatter: '{b}',
+      },
+      data: [
+        { value: -0.07, label: labelRight },
+        { value: -0.09, label: labelRight },
+        0.2,
+        0.44,
+        { value: -0.23, label: labelRight },
+        0.08,
+        { value: -0.17, label: labelRight },
+        0.47,
+        { value: -0.36, label: labelRight },
+        0.18,
+      ],
+    },
+  ],
+};
+
+describe('#simpleBarChart', function () {
+  test('should generate the chart', {timeout: 10_000}, async () => {
+    const data: Buffer = await EChartRatchet.renderChartToPngFile('test.png', options, {
+      width: 1000,
+      height: 500,
+    });
+
+    // As of 2022-08-06 this is 15569... there must be a better test than this..
+    expect(data.length).toBeGreaterThan(15_000);
+    expect(data.length).toBeLessThan(20_000);
+  } );
+});

package/src/examples/bubble.spec.ts

@@ -0,0 +1,172 @@
+import * as echarts from 'echarts';
+import { EChartsOption } from 'echarts';
+import { EChartRatchet } from '../common/echart-ratchet.js';
+import { describe, expect, test } from 'vitest';
+
+const data = [
+  [
+    [28604, 77, 17096869, 'Australia', 1990],
+    [31163, 77.4, 27662440, 'Canada', 1990],
+    [1516, 68, 1154605773, 'China', 1990],
+    [13670, 74.7, 10582082, 'Cuba', 1990],
+    [28599, 75, 4986705, 'Finland', 1990],
+    [29476, 77.1, 56943299, 'France', 1990],
+    [31476, 75.4, 78958237, 'Germany', 1990],
+    [28666, 78.1, 254830, 'Iceland', 1990],
+    [1777, 57.7, 870601776, 'India', 1990],
+    [29550, 79.1, 122249285, 'Japan', 1990],
+    [2076, 67.9, 20194354, 'North Korea', 1990],
+    [12087, 72, 42972254, 'South Korea', 1990],
+    [24021, 75.4, 3397534, 'New Zealand', 1990],
+    [43296, 76.8, 4240375, 'Norway', 1990],
+    [10088, 70.8, 38195258, 'Poland', 1990],
+    [19349, 69.6, 147568552, 'Russia', 1990],
+    [10670, 67.3, 53994605, 'Turkey', 1990],
+    [26424, 75.7, 57110117, 'United Kingdom', 1990],
+    [37062, 75.4, 252847810, 'United States', 1990],
+  ],
+  [
+    [44056, 81.8, 23968973, 'Australia', 2015],
+    [43294, 81.7, 35939927, 'Canada', 2015],
+    [13334, 76.9, 1376048943, 'China', 2015],
+    [21291, 78.5, 11389562, 'Cuba', 2015],
+    [38923, 80.8, 5503457, 'Finland', 2015],
+    [37599, 81.9, 64395345, 'France', 2015],
+    [44053, 81.1, 80688545, 'Germany', 2015],
+    [42182, 82.8, 329425, 'Iceland', 2015],
+    [5903, 66.8, 1311050527, 'India', 2015],
+    [36162, 83.5, 126573481, 'Japan', 2015],
+    [1390, 71.4, 25155317, 'North Korea', 2015],
+    [34644, 80.7, 50293439, 'South Korea', 2015],
+    [34186, 80.6, 4528526, 'New Zealand', 2015],
+    [64304, 81.6, 5210967, 'Norway', 2015],
+    [24787, 77.3, 38611794, 'Poland', 2015],
+    [23038, 73.13, 143456918, 'Russia', 2015],
+    [19360, 76.5, 78665830, 'Turkey', 2015],
+    [38225, 81.4, 64715810, 'United Kingdom', 2015],
+    [53354, 79.1, 321773631, 'United States', 2015],
+  ],
+];
+
+const options: EChartsOption = {
+  backgroundColor: new echarts.graphic.RadialGradient(0.3, 0.3, 0.8, [
+    {
+      offset: 0,
+      color: '#f7f8fa',
+    },
+    {
+      offset: 1,
+      color: '#cdd0d5',
+    },
+  ]),
+  title: {
+    text: 'Life Expectancy and GDP by Country',
+    left: '5%',
+    top: '3%',
+  },
+  legend: {
+    right: '10%',
+    top: '3%',
+    data: ['1990', '2015'],
+  },
+  grid: {
+    left: '8%',
+    top: '10%',
+  },
+  xAxis: {
+    splitLine: {
+      lineStyle: {
+        type: 'dashed',
+      },
+    },
+  },
+  yAxis: {
+    splitLine: {
+      lineStyle: {
+        type: 'dashed',
+      },
+    },
+    scale: true,
+  },
+  series: [
+    {
+      name: '1990',
+      data: data[0],
+      type: 'scatter',
+      symbolSize: function (data) {
+        return Math.sqrt(data[2]) / 5e2;
+      },
+      emphasis: {
+        focus: 'series',
+        label: {
+          show: true,
+          formatter: function (param) {
+            return param.data[3];
+          },
+          position: 'top',
+        },
+      },
+      itemStyle: {
+        shadowBlur: 10,
+        shadowColor: 'rgba(120, 36, 50, 0.5)',
+        shadowOffsetY: 5,
+        color: new echarts.graphic.RadialGradient(0.4, 0.3, 1, [
+          {
+            offset: 0,
+            color: 'rgb(251, 118, 123)',
+          },
+          {
+            offset: 1,
+            color: 'rgb(204, 46, 72)',
+          },
+        ]),
+      },
+    },
+    {
+      name: '2015',
+      data: data[1],
+      type: 'scatter',
+      symbolSize: function (data) {
+        return Math.sqrt(data[2]) / 5e2;
+      },
+      emphasis: {
+        focus: 'series',
+        label: {
+          show: true,
+          formatter: function (param) {
+            return param.data[3];
+          },
+          position: 'top',
+        },
+      },
+      itemStyle: {
+        shadowBlur: 10,
+        shadowColor: 'rgba(25, 100, 150, 0.5)',
+        shadowOffsetY: 5,
+        color: new echarts.graphic.RadialGradient(0.4, 0.3, 1, [
+          {
+            offset: 0,
+            color: 'rgb(129, 227, 238)',
+          },
+          {
+            offset: 1,
+            color: 'rgb(25, 183, 207)',
+          },
+        ]),
+      },
+    },
+  ],
+};
+
+describe('#bubbleChart', function () {
+  test('should generate the chart', {timeout: 10_000},async () => {
+    const data: Buffer = await EChartRatchet.renderChart(options, {
+      width: 1000,
+      height: 500,
+    });
+
+    // As of 2022-08-06 this is 140641... there must be a better test than this..
+    expect(data.length).toBeGreaterThan(140_000);
+    expect(data.length).toBeLessThan(150_000);
+  });
+});

package/src/examples/pie.spec.ts

@@ -0,0 +1,78 @@
+import { EChartsOption } from 'echarts';
+import { EChartRatchet } from '../common/echart-ratchet.js';
+import { describe, expect, test } from 'vitest';
+
+const options: EChartsOption = {
+  backgroundColor: '#2c343c',
+  title: {
+    text: 'Customized Pie',
+    left: 'center',
+    top: 20,
+    textStyle: {
+      color: '#ccc',
+    },
+  },
+  tooltip: {
+    trigger: 'item',
+  },
+  visualMap: {
+    show: false,
+    min: 80,
+    max: 600,
+    inRange: {
+      colorLightness: [0, 1],
+    },
+  },
+  series: [
+    {
+      name: 'Access From',
+      type: 'pie',
+      radius: '55%',
+      center: ['50%', '50%'],
+      data: [
+        { value: 335, name: 'Direct' },
+        { value: 310, name: 'Email' },
+        { value: 274, name: 'Union Ads' },
+        { value: 235, name: 'Video Ads' },
+        { value: 400, name: 'Search Engine' },
+      ].sort(function (a, b) {
+        return a.value - b.value;
+      }),
+      roseType: 'radius',
+      label: {
+        color: 'rgba(255, 255, 255, 0.3)',
+      },
+      labelLine: {
+        lineStyle: {
+          color: 'rgba(255, 255, 255, 0.3)',
+        },
+        smooth: 0.2,
+        length: 10,
+        length2: 20,
+      },
+      itemStyle: {
+        color: '#c23531',
+        shadowBlur: 200,
+        shadowColor: 'rgba(0, 0, 0, 0.5)',
+      },
+      animationType: 'scale',
+      animationEasing: 'elasticOut',
+      animationDelay: function (_idx) {
+        return Math.random() * 200;
+      },
+    },
+  ],
+};
+
+describe('#pieChart', function () {
+  test('should generate the chart', {timeout: 10_000},async () => {
+    const data: Buffer = await EChartRatchet.renderChartToPngFile('test.png', options, {
+      width: 1000,
+      height: 500,
+    });
+
+    // As of 2022-08-06 this is 32175... there must be a better test than this..
+    expect(data.length).toBeGreaterThan(30_000);
+    expect(data.length).toBeLessThan(40_000);
+  });
+});

package/src/examples/simple-bar.spec.ts

@@ -0,0 +1,37 @@
+import { EChartRatchet } from '../common/echart-ratchet.js';
+import { EChartsOption } from 'echarts';
+import { describe, expect, test } from 'vitest';
+
+const options: EChartsOption = {
+  title: {
+    text: 'test',
+  },
+  tooltip: {},
+  legend: {
+    data: ['test'],
+  },
+  xAxis: {
+    data: ['a', 'b', 'c', 'd', 'f', 'g'],
+  },
+  yAxis: {},
+  series: [
+    {
+      name: 'test',
+      type: 'bar',
+      data: [5, 20, 36, 10, 10, 20],
+    },
+  ],
+};
+
+describe('#simpleBarChart', function () {
+  test('should generate the chart', {timeout: 10_000},async () => {
+    const data: Buffer = await EChartRatchet.renderChart(options, {
+      width: 1000,
+      height: 500,
+    });
+
+    // As of 2022-08-06 this is 7606... there must be a better test than this..
+    expect(data.length).toBeGreaterThan(5_000);
+    expect(data.length).toBeLessThan(10_000);
+  });
+});