npm - @naivemap/mapbox-gl-echarts-layer - Versions diffs - 0.3.2 → 0.4.0-alpha.0 - Mend

@naivemap/mapbox-gl-echarts-layer 0.3.2 → 0.4.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

package/LICENSE +21 -21
package/README.md +11 -52
package/dist/index.cjs +1 -0
package/dist/index.d.ts +6 -0
package/dist/index.js +51 -0
package/dist/mapbox-gl-echarts-layer/src/EChartsLayer.d.ts +38 -0
package/dist/mapbox-gl-echarts-layer/src/index.d.ts +3 -0
package/package.json +28 -35
package/dist/es/index.js +0 -104
package/dist/js/index.d.ts +0 -22
package/dist/js/index.js +0 -106

package/LICENSE CHANGED Viewed

@@ -1,21 +1,21 @@
-MIT License
-Copyright (c) 2022 Naive Map
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+Copyright (c) 2022 Naive Map
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md CHANGED Viewed

@@ -1,52 +1,11 @@
-## EChartsLayer class
-```bash
-npm i @naivemap/mapbox-gl-echarts-layer echarts
-```
-<b>Signature:</b>
-```typescript
-export default class EChartsLayer implements mapboxgl.CustomLayerInterface
-```
-<b>Implements:</b> mapboxgl.CustomLayerInterface
-## Constructors
-| Constructor | Description |
-| --- | --- |
-| (constructor)(`id`: `string`, `option`: `ECOption`) | Constructs a new instance of the <code>EChartsLayer</code> class |
-### Parameters
-**id** `(string)` The ID of the layer.
-**option** `(ECOption)` The option of the [Lines graph](https://echarts.apache.org/zh/option.html#series-lines) and [Scatter (bubble) chart](https://echarts.apache.org/zh/option.html#series-scatter).
-```ts
-export type ECOption = echarts.ComposeOption<
-  | TitleComponentOption
-  | TooltipComponentOption
-  | LegendComponentOption
-  | LinesSeriesOption
-  | ScatterSeriesOption
-  | EffectScatterSeriesOption
->
-```
-### Methods
-| Method                             | Description                                             |
-| ---------------------------------- | ------------------------------------------------------- |
-| **setOption** `(option: ECOption)` | Call `echartsInstance.setOption()` to update the chart. |
-## Example
-```ts
-// echart option
-const option = {...}
-const layer = new EChartsLayer('layer-id', option)
-map.addLayer(layer)
-```
+# @naivemap/mapbox-gl-echarts-layer
+EChartsLayer ([@naivemap/maplibre-gl-echarts-layer](https://www.npmjs.com/package/@naivemap/maplibre-gl-echarts-layer)): Integrates Apache ECharts with MapLibre GL JS, specifically enabling the use of **Lines graphs** and **Scatter (bubble)** charts as a map layer. This allows for visualizing connections, paths, and point-based data with the rich styling capabilities of ECharts.
+[API References](https://www.naivemap.com/maplibre-gl-layers/api/mapbox-gl-echarts-layer/)
+## Install
+```bash
+pnpm add @naivemap/mapbox-gl-echarts-layer echarts
+```

package/dist/index.cjs ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";const t=require("@naivemap/echarts-layer-core"),o=require("@naivemap/map-gl-layer-adaptor");class s{id;type;renderingMode;_core;_adaptor;constructor(e,r){this.id=e,this.type="custom",this.renderingMode="2d",this._core=new t(r),this._adaptor=o.createMapboxLayerAdaptor(this._core,{id:e,renderingMode:this.renderingMode})}onAdd(e,r){this._adaptor.onAdd(e,r)}onRemove(e,r){this._adaptor.onRemove(e,r)}setOption(e,r){this._core.setOption(e,r)}render(e,r){this._adaptor.render(e,r)}}module.exports=s;

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,6 @@
+export * from './mapbox-gl-echarts-layer/src/index'
+export {}
+import MapboxEChartsLayer from './mapbox-gl-echarts-layer/src/index'
+export default MapboxEChartsLayer
+export * from './mapbox-gl-echarts-layer/src/index'
+export {}

package/dist/index.js ADDED Viewed

@@ -0,0 +1,51 @@
+import t from "@naivemap/echarts-layer-core";
+import { createMapboxLayerAdaptor as o } from "@naivemap/map-gl-layer-adaptor";
+class s {
+  id;
+  /**
+   * @ignore
+   */
+  type;
+  /**
+   * @ignore
+   */
+  renderingMode;
+  _core;
+  _adaptor;
+  /**
+   * @param id - A unique layer id
+   * @param ecOption - The ECharts option object used to configure the visualization.
+   * @see https://echarts.apache.org/en/option.html
+   */
+  constructor(e, r) {
+    this.id = e, this.type = "custom", this.renderingMode = "2d", this._core = new t(r), this._adaptor = o(this._core, {
+      id: e,
+      renderingMode: this.renderingMode
+    });
+  }
+  onAdd(e, r) {
+    this._adaptor.onAdd(e, r);
+  }
+  onRemove(e, r) {
+    this._adaptor.onRemove(e, r);
+  }
+  /**
+   * Updates the ECharts visualization with a new configuration.
+   * This is the primary method for dynamically changing the displayed data or styles.
+   *
+   * @param option - The new ECharts option object to apply.
+   * @param notMerge - If true, the new options will completely replace the existing ones.
+   *                   If false or undefined, the new options will be merged with the old ones.
+   *                   Defaults to `false`.
+   * @see https://echarts.apache.org/en/api.html#echartsInstance.setOption
+   */
+  setOption(e, r) {
+    this._core.setOption(e, r);
+  }
+  render(e, r) {
+    this._adaptor.render(e, r);
+  }
+}
+export {
+  s as default
+};

package/dist/mapbox-gl-echarts-layer/src/EChartsLayer.d.ts ADDED Viewed

@@ -0,0 +1,38 @@
+import { ECOption } from '../../echarts-layer-core/src/index.ts';
+import { CustomLayerInterface, Map } from 'mapbox-gl';
+/**
+ * A custom Mapbox GL JS layer that renders Apache ECharts visualizations.
+ */
+export default class EChartsLayer implements CustomLayerInterface {
+    id: string;
+    /**
+     * @ignore
+     */
+    type: 'custom';
+    /**
+     * @ignore
+     */
+    renderingMode?: '2d' | '3d' | undefined;
+    private _core;
+    private _adaptor;
+    /**
+     * @param id - A unique layer id
+     * @param ecOption - The ECharts option object used to configure the visualization.
+     * @see https://echarts.apache.org/en/option.html
+     */
+    constructor(id: string, ecOption: ECOption);
+    onAdd(map: Map, gl: WebGLRenderingContext): void;
+    onRemove(map: Map, gl: WebGLRenderingContext): void;
+    /**
+     * Updates the ECharts visualization with a new configuration.
+     * This is the primary method for dynamically changing the displayed data or styles.
+     *
+     * @param option - The new ECharts option object to apply.
+     * @param notMerge - If true, the new options will completely replace the existing ones.
+     *                   If false or undefined, the new options will be merged with the old ones.
+     *                   Defaults to `false`.
+     * @see https://echarts.apache.org/en/api.html#echartsInstance.setOption
+     */
+    setOption(option: ECOption, notMerge?: boolean): void;
+    render(gl: WebGLRenderingContext, args: unknown): void;
+}

package/dist/mapbox-gl-echarts-layer/src/index.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { default as EChartsLayer } from './EChartsLayer';
+export type { ECOption } from '../../echarts-layer-core/src/index.ts';
+export default EChartsLayer;

package/package.json CHANGED Viewed

@@ -1,55 +1,48 @@
 {
   "name": "@naivemap/mapbox-gl-echarts-layer",
-  "version": "0.3.2",
-  "description": "Integrate the Lines graph and Scatter (bubble) chart of Apache ECharts.",
-  "author": "huanglii <li.huangli@qq.com>",
-  "homepage": "https://github.com/naivemap/mapbox-gl-layers#readme",
-  "license": "MIT",
-  "main": "dist/js/index.js",
-  "module": "dist/es/index.js",
+  "version": "0.4.0-alpha.0",
+  "description": "A Mapbox GL JS layer to integrate Apache ECharts' Lines and Scatter charts.",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "type": "module",
   "exports": {
-    "./package.json": "./package.json",
     ".": {
-      "import": "./dist/es/index.js",
-      "require": "./dist/js/index.js"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   },
-  "types": "dist/js/index.d.ts",
-  "sideEffects": false,
   "files": [
     "dist"
   ],
   "keywords": [
-    "mapbox-gl",
+    "mapbox",
     "echarts",
-    "scatter",
-    "lines"
+    "layer",
+    "custom"
   ],
+  "author": "naivemap",
+  "license": "MIT",
+  "types": "./dist/index.d.ts",
+  "repository": "https://github.com/naivemap/maplibre-gl-layers",
   "publishConfig": {
     "access": "public"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/naivemap/mapbox-gl-layers.git"
-  },
-  "scripts": {
-    "test": "echo \"Error: run tests from root\" && exit 1",
-    "build": "npm-run-all build:*",
-    "build:es": "tsc --outDir dist/es --module esnext --declaration false",
-    "build:js": "tsc",
-    "prepublishOnly": "npm-run-all build:*"
-  },
-  "bugs": {
-    "url": "https://github.com/naivemap/mapbox-gl-layers/issues"
+  "sideEffects": false,
+  "dependencies": {
+    "@naivemap/echarts-layer-core": "0.1.0",
+    "@naivemap/map-gl-layer-adaptor": "0.1.0"
   },
   "peerDependencies": {
-    "echarts": "^5.3.0"
+    "echarts": "^5.0.0",
+    "mapbox-gl": "^2.0.0 || ^3.0.0"
   },
   "devDependencies": {
-    "@types/mapbox-gl": "^2.7.2",
-    "@types/node": "^17.0.36",
-    "echarts": "^5.3.2",
-    "npm-run-all": "^4.1.5"
+    "echarts": "^5.6.0",
+    "mapbox-gl": "^3.10.0"
   },
-  "gitHead": "0d34a954e38a0366112328e2cceaafebece75e3e"
-}
+  "scripts": {
+    "build": "vite build",
+    "typedocs": "pnpm typedoc"
+  }
+}

package/dist/es/index.js DELETED Viewed

@@ -1,104 +0,0 @@
-import { init, registerCoordinateSystem, } from 'echarts';
-var COORDINATE_SYSTEM_NAME = 'mapboxgl-echarts';
-var CoordinateSystem = /** @class */ (function () {
-    function CoordinateSystem(map) {
-        this.dimensions = ['x', 'y'];
-        this._mapOffset = [0, 0];
-        this.map = map;
-    }
-    CoordinateSystem.prototype.create = function (ecModel) {
-        var _this = this;
-        ecModel.eachSeries(function (seriesModel) {
-            if (seriesModel.get('coordinateSystem') === COORDINATE_SYSTEM_NAME) {
-                seriesModel.coordinateSystem = new CoordinateSystem(_this.map);
-            }
-        });
-    };
-    CoordinateSystem.prototype.dataToPoint = function (data) {
-        var px = this.map.project(data);
-        var mapOffset = this._mapOffset;
-        return [px.x - mapOffset[0], px.y - mapOffset[1]];
-    };
-    CoordinateSystem.prototype.pointToData = function (pt) {
-        var mapOffset = this._mapOffset;
-        var data = this.map.unproject([pt[0] + mapOffset[0], pt[1] + mapOffset[1]]);
-        return [data.lng, data.lat];
-    };
-    return CoordinateSystem;
-}());
-var EChartsLayer = /** @class */ (function () {
-    function EChartsLayer(id, ecOption) {
-        this._registered = false;
-        this.id = id;
-        this.type = 'custom';
-        this.renderingMode = '2d';
-        this._coordSystemName = COORDINATE_SYSTEM_NAME;
-        this._ecOption = ecOption;
-    }
-    EChartsLayer.prototype.onAdd = function (map) {
-        this._map = map;
-        this._createLayerContainer();
-    };
-    EChartsLayer.prototype.onRemove = function () {
-        var _a;
-        (_a = this._ec) === null || _a === void 0 ? void 0 : _a.dispose();
-        this._removeLayerContainer();
-    };
-    EChartsLayer.prototype.setOption = function (option) {
-        var _a;
-        (_a = this._ec) === null || _a === void 0 ? void 0 : _a.setOption(option);
-    };
-    EChartsLayer.prototype.render = function () {
-        if (!this._container) {
-            this._createLayerContainer();
-        }
-        if (!this._ec) {
-            this._ec = init(this._container);
-            this._prepareECharts();
-            this._ec.setOption(this._ecOption);
-        }
-        else {
-            if (this._map.isMoving()) {
-                this._ec.clear();
-            }
-            else {
-                this._ec.resize({
-                    width: this._map.getCanvas().width,
-                    height: this._map.getCanvas().height,
-                });
-                this._ec.setOption(this._ecOption);
-            }
-        }
-    };
-    EChartsLayer.prototype._prepareECharts = function () {
-        if (!this._registered) {
-            var coordinateSystem = new CoordinateSystem(this._map);
-            registerCoordinateSystem(this._coordSystemName, coordinateSystem);
-            this._registered = true;
-        }
-        var series = this._ecOption.series;
-        if (series) {
-            for (var i = series.length - 1; i >= 0; i--) {
-                // change coordinateSystem to mapboxgl-echarts
-                series[i]['coordinateSystem'] = this._coordSystemName;
-                // disable update animations
-                // series[i]['animation'] = false
-            }
-        }
-    };
-    EChartsLayer.prototype._createLayerContainer = function () {
-        var mapContainer = this._map.getCanvasContainer();
-        this._container = document.createElement('div');
-        this._container.style.width = this._map.getCanvas().style.width;
-        this._container.style.height = this._map.getCanvas().style.height;
-        mapContainer.appendChild(this._container);
-    };
-    EChartsLayer.prototype._removeLayerContainer = function () {
-        var _a;
-        if (this._container) {
-            (_a = this._container.parentNode) === null || _a === void 0 ? void 0 : _a.removeChild(this._container);
-        }
-    };
-    return EChartsLayer;
-}());
-export default EChartsLayer;

package/dist/js/index.d.ts DELETED Viewed

@@ -1,22 +0,0 @@
-/// <reference types="mapbox-gl" />
-import { ComposeOption, EffectScatterSeriesOption, LegendComponentOption, LinesSeriesOption, ScatterSeriesOption, TitleComponentOption, TooltipComponentOption } from 'echarts';
-export declare type ECOption = ComposeOption<TitleComponentOption | TooltipComponentOption | LegendComponentOption | LinesSeriesOption | ScatterSeriesOption | EffectScatterSeriesOption>;
-export default class EChartsLayer implements mapboxgl.CustomLayerInterface {
-    id: string;
-    type: 'custom';
-    renderingMode?: '2d' | '3d' | undefined;
-    private _container;
-    private _map;
-    private _ec;
-    private _coordSystemName;
-    private _registered;
-    private _ecOption;
-    constructor(id: string, ecOption: ECOption);
-    onAdd(map: mapboxgl.Map): void;
-    onRemove(): void;
-    setOption(option: ECOption): void;
-    render(): void;
-    private _prepareECharts;
-    private _createLayerContainer;
-    private _removeLayerContainer;
-}

package/dist/js/index.js DELETED Viewed

@@ -1,106 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var echarts_1 = require("echarts");
-var COORDINATE_SYSTEM_NAME = 'mapboxgl-echarts';
-var CoordinateSystem = /** @class */ (function () {
-    function CoordinateSystem(map) {
-        this.dimensions = ['x', 'y'];
-        this._mapOffset = [0, 0];
-        this.map = map;
-    }
-    CoordinateSystem.prototype.create = function (ecModel) {
-        var _this = this;
-        ecModel.eachSeries(function (seriesModel) {
-            if (seriesModel.get('coordinateSystem') === COORDINATE_SYSTEM_NAME) {
-                seriesModel.coordinateSystem = new CoordinateSystem(_this.map);
-            }
-        });
-    };
-    CoordinateSystem.prototype.dataToPoint = function (data) {
-        var px = this.map.project(data);
-        var mapOffset = this._mapOffset;
-        return [px.x - mapOffset[0], px.y - mapOffset[1]];
-    };
-    CoordinateSystem.prototype.pointToData = function (pt) {
-        var mapOffset = this._mapOffset;
-        var data = this.map.unproject([pt[0] + mapOffset[0], pt[1] + mapOffset[1]]);
-        return [data.lng, data.lat];
-    };
-    return CoordinateSystem;
-}());
-var EChartsLayer = /** @class */ (function () {
-    function EChartsLayer(id, ecOption) {
-        this._registered = false;
-        this.id = id;
-        this.type = 'custom';
-        this.renderingMode = '2d';
-        this._coordSystemName = COORDINATE_SYSTEM_NAME;
-        this._ecOption = ecOption;
-    }
-    EChartsLayer.prototype.onAdd = function (map) {
-        this._map = map;
-        this._createLayerContainer();
-    };
-    EChartsLayer.prototype.onRemove = function () {
-        var _a;
-        (_a = this._ec) === null || _a === void 0 ? void 0 : _a.dispose();
-        this._removeLayerContainer();
-    };
-    EChartsLayer.prototype.setOption = function (option) {
-        var _a;
-        (_a = this._ec) === null || _a === void 0 ? void 0 : _a.setOption(option);
-    };
-    EChartsLayer.prototype.render = function () {
-        if (!this._container) {
-            this._createLayerContainer();
-        }
-        if (!this._ec) {
-            this._ec = (0, echarts_1.init)(this._container);
-            this._prepareECharts();
-            this._ec.setOption(this._ecOption);
-        }
-        else {
-            if (this._map.isMoving()) {
-                this._ec.clear();
-            }
-            else {
-                this._ec.resize({
-                    width: this._map.getCanvas().width,
-                    height: this._map.getCanvas().height,
-                });
-                this._ec.setOption(this._ecOption);
-            }
-        }
-    };
-    EChartsLayer.prototype._prepareECharts = function () {
-        if (!this._registered) {
-            var coordinateSystem = new CoordinateSystem(this._map);
-            (0, echarts_1.registerCoordinateSystem)(this._coordSystemName, coordinateSystem);
-            this._registered = true;
-        }
-        var series = this._ecOption.series;
-        if (series) {
-            for (var i = series.length - 1; i >= 0; i--) {
-                // change coordinateSystem to mapboxgl-echarts
-                series[i]['coordinateSystem'] = this._coordSystemName;
-                // disable update animations
-                // series[i]['animation'] = false
-            }
-        }
-    };
-    EChartsLayer.prototype._createLayerContainer = function () {
-        var mapContainer = this._map.getCanvasContainer();
-        this._container = document.createElement('div');
-        this._container.style.width = this._map.getCanvas().style.width;
-        this._container.style.height = this._map.getCanvas().style.height;
-        mapContainer.appendChild(this._container);
-    };
-    EChartsLayer.prototype._removeLayerContainer = function () {
-        var _a;
-        if (this._container) {
-            (_a = this._container.parentNode) === null || _a === void 0 ? void 0 : _a.removeChild(this._container);
-        }
-    };
-    return EChartsLayer;
-}());
-exports.default = EChartsLayer;