[feature] map新增getSymbol接口

MyShallowTime · MyShallowTime · commit f5769df4b0a7 · 2023-07-11T14:57:30.000+08:00
review by zhaoq
diff --git a/src/mapboxgl/overlay/symbol/MapExtendSymbol.js b/src/mapboxgl/overlay/symbol/MapExtendSymbol.js
@@ -108,7 +108,7 @@ function MapExtendSymbol(){
    */
   mapboxgl.Map.prototype.loadSymbol = async function (id, callback) {
     if (typeof id === 'string') {
-      let symbolInfo = getSymbolHandler(this).getSymbolInfo(id);
+      let symbolInfo = this.getSymbol(id);
       if (!symbolInfo) {
         const symbolResult = await getSymbol(id, this);
         if (!symbolResult) {
@@ -138,6 +138,14 @@ function MapExtendSymbol(){
     getSymbolHandler(this).addSymbol(id, symbol);
   };
 
+  /**
+   * 获取符号信息
+   * @param {string} id
+   */
+  mapboxgl.Map.prototype.getSymbol = function (id) {
+    return getSymbolHandler(this).getSymbol(id);
+  };
+
   /**
    * 判断符号是否存在
    * @param {string} id
@@ -150,7 +158,7 @@ function MapExtendSymbol(){
       return false;
     }
 
-    return !!getSymbolHandler(this).getSymbolInfo(id);
+    return !!this.getSymbol(id);
   };
 
   /**
diff --git a/src/mapboxgl/overlay/symbol/SymbolHandler.js b/src/mapboxgl/overlay/symbol/SymbolHandler.js
@@ -36,7 +36,7 @@ class SymbolHandler {
         if (typeof layer.symbol === 'string') {
             const id = layer.symbol;
             if (id) {
-                const symbol = this.symbolManager.getSymbol(id);
+                const symbol = this.getSymbol(id);
                 if (!symbol) {
                     return this.map.fire('error', {
                         error: new Error(`Symbol "${id}" could not be loaded. Please make sure you have added the symbol with map.addSymbol().`)
@@ -190,7 +190,7 @@ class SymbolHandler {
      * @param {object} symbol
      */
     addSymbol(id, symbol) {
-        if (this.symbolManager.getSymbol(id)) {
+        if (this.getSymbol(id)) {
             return this.map.fire('error', {
                 error: new Error('An symbol with this name already exists.')
             });
@@ -218,7 +218,7 @@ class SymbolHandler {
      * @param {string} layerId
      * @return {string | array} symbol
      */
-    getSymbol(layerId) {
+    getLayerSymbol(layerId) {
         return this._layerSymbols[layerId];
     }
 
@@ -242,7 +242,7 @@ class SymbolHandler {
      * 通过symbolId获取symbol内容
      * @param {string} symbolId
      */
-    getSymbolInfo(symbolId) {
+    getSymbol(symbolId) {
         return this.symbolManager.getSymbol(symbolId);
     }
 
@@ -280,7 +280,7 @@ class SymbolHandler {
      */
     getLayer(layerId) {
         const layer = this.map.getLayerBySymbolBak(layerId);
-        const symbol = this.getSymbol(layerId);
+        const symbol = this.getLayerSymbol(layerId);
         if (layer) {
             return symbol ? { ...layer, symbol } : layer;
         } else {
@@ -316,9 +316,9 @@ class SymbolHandler {
             style.layers = style.layers.reduce((pre, layer) => {
                 const compositeId = this.getLayerId(layer.id);
                 if (compositeId) {
-                    !pre.find(l => l.id === compositeId) && pre.push({ ...layer, symbol: this.getSymbol(compositeId), id: compositeId })
-                } else if (this.getSymbol(layer.id)) {
-                    pre.push({ ...layer, symbol: this.getSymbol(layer.id) })
+                    !pre.find(l => l.id === compositeId) && pre.push({ ...layer, symbol: this.getLayerSymbol(compositeId), id: compositeId })
+                } else if (this.getLayerSymbol(layer.id)) {
+                    pre.push({ ...layer, symbol: this.getLayerSymbol(layer.id) })
                 } else {
                     pre.push(layer);
                 }
@@ -361,12 +361,12 @@ class SymbolHandler {
      * @param {object} options
      */
     setFilter(layerId, filter, options) {
-        const symbol = this.getSymbol(layerId);
+        const symbol = this.getLayerSymbol(layerId);
         if (isMapboxExpression(symbol)) {
             // 如果 symbol 是数据驱动，filter需要重新计算
             const realLayerId = this.getFirstLayerId(layerId);
             this.map.style.setFilter(realLayerId, filter, options);
-            const symbol = this.getSymbol(layerId);
+            const symbol = this.getLayerSymbol(layerId);
             this.setSymbol(layerId, symbol);
             return;
         }
@@ -479,7 +479,7 @@ class SymbolHandler {
      */
     updateSymbol(symbolId, symbol) {
         // symbol不存在
-        if (!this.symbolManager.getSymbol(symbolId)) {
+        if (!this.getSymbol(symbolId)) {
             return this.map.fire('error', {
                 error: new Error(`Symbol "${symbolId}" could not be loaded. Please make sure you have added the symbol with map.addSymbol().`)
             });
@@ -503,7 +503,7 @@ class SymbolHandler {
      * @param {any} value
      */
     setSymbolProperty(symbolId, symbolIndex, name, value) {
-        const symbol = this.symbolManager.getSymbol(symbolId);
+        const symbol = this.getSymbol(symbolId);
         // symbol不存在
         if (!symbol) {
             return this.map.fire('error', {
@@ -547,7 +547,7 @@ class SymbolHandler {
      * @returns {any}
      */
     getSymbolProperty(symbolId, symbolIndex, name) {
-        const symbol = this.symbolManager.getSymbol(symbolId);
+        const symbol = this.getSymbol(symbolId);
         // symbol不存在
         if (!symbol) {
             this.map.fire('error', {
diff --git a/src/mapboxgl/overlay/symbol/WebSymbol.js b/src/mapboxgl/overlay/symbol/WebSymbol.js
@@ -117,6 +117,19 @@ import MapExtendSymbol from './MapExtendSymbol';
 * ```
 * 
 * 
+* ## mapboxgl.Map.prototype.getSymbol
+* 获取指定 ID 的符号信息。
+* 
+* 参数名称			     |类型			 |描述  
+* :----			    |:---		    |:---	
+* id			    |string		    |符号ID
+* 
+* **Example**
+* ```
+* const point1 = map.getSymbol('point-1');
+* ```
+* 
+* 
 * ## mapboxgl.Map.prototype.setSymbolProperty
 * 设置指定ID符号的属性值。
 * 
diff --git a/test/mapboxgl/overlay/symbol/MapExtendSymbolSpec.js b/test/mapboxgl/overlay/symbol/MapExtendSymbolSpec.js
@@ -271,4 +271,14 @@ describe('MapExtendSymbol', () => {
         expect(map.symbolHandler.getSymbolProperty).toHaveBeenCalled();
         expect(value).toBe(5);
     });
+    it('map.getSymbol', () => {
+        spyOn(map.symbolHandler, 'getSymbol').and.returnValue({
+            paint: {
+                "icon-color": "red"
+            }
+        });
+        const value = map.getSymbol("point-1");
+        expect(map.symbolHandler.getSymbol).toHaveBeenCalled();
+        expect(value.paint["icon-color"]).toBe("red");
+    });
 });
diff --git a/test/mapboxgl/overlay/symbol/SymbolHandlerSpec.js b/test/mapboxgl/overlay/symbol/SymbolHandlerSpec.js
@@ -83,7 +83,7 @@ describe('mapboxgl_symbol_SymbolHandler', () => {
   //   spyOn(handler, 'setSymbolTolayer')
   //   spyOn(handler.singleSymbolRender, 'addLayer')
   //   handler.addLayer(layer);
-  //   const result = handler.getSymbol("Landuse_R@Jingjin#line");
+  //   const result = handler.getLayerSymbol("Landuse_R@Jingjin#line");
   //   expect(result).toEqual("line-962464");
   // });
   it('addLayer-symbolId-1', () => {
@@ -116,7 +116,7 @@ describe('mapboxgl_symbol_SymbolHandler', () => {
     spyOn(handler.symbolManager, 'getSymbol').and.returnValue(null);
     spyOn(handler.compositeSymbolRender, 'addLayerId');
     handler.addLayer(layer);
-    const result = handler.getSymbol("Landuse_R@Jingjin#line");
+    const result = handler.getLayerSymbol("Landuse_R@Jingjin#line");
     expect(result).toEqual(expression);
     expect(handler.compositeSymbolRender.addLayerId).toHaveBeenCalled();
   });
@@ -314,7 +314,7 @@ describe('mapboxgl_symbol_SymbolHandler', () => {
         id: 'testRemoveLayerId'
     });
     const symbol = {'paint': {'line-color': '#0fffff'}};
-    spyOn(handler, 'getSymbol').and.returnValue(symbol);
+    spyOn(handler, 'getLayerSymbol').and.returnValue(symbol);
     const result = handler.getLayer('testRemoveLayerId');
     expect(result.symbol).toEqual(symbol);
   });
@@ -323,7 +323,7 @@ describe('mapboxgl_symbol_SymbolHandler', () => {
     spyOn(handler.map, 'getLayerBySymbolBak').and.returnValue({
         id: 'testRemoveLayerId'
     });
-    spyOn(handler, 'getSymbol').and.returnValue(null);
+    spyOn(handler, 'getLayerSymbol').and.returnValue(null);
     const result = handler.getLayer('testRemoveLayerId');
     expect(result.symbol).toBeUndefined();
   });
@@ -338,7 +338,7 @@ describe('mapboxgl_symbol_SymbolHandler', () => {
             "line-color": "#000000"
         }
     };
-    spyOn(handler, 'getSymbol').and.returnValue(symbol);
+    spyOn(handler, 'getLayerSymbol').and.returnValue(symbol);
     spyOn(handler, 'getLayerIds').and.returnValue(['child1', 'child2']);
     const result = handler.getLayer('testRemoveLayerId');
     expect(result.id).toBe('testRemoveLayerId');
@@ -373,7 +373,7 @@ describe('mapboxgl_symbol_SymbolHandler', () => {
     });
     spyOn(handler, 'hasSymbol').and.returnValue(true);
     spyOn(handler, 'getLayerId').and.returnValue(["child1", "child2"]);
-    spyOn(handler, 'getSymbol').and.returnValue({
+    spyOn(handler, 'getLayerSymbol').and.returnValue({
         paint: {
             'line-color': '#ffffff'
         }
@@ -396,7 +396,7 @@ describe('mapboxgl_symbol_SymbolHandler', () => {
     });
     spyOn(handler, 'hasSymbol').and.returnValue(true);
     spyOn(handler, 'getLayerId').and.returnValue(undefined);
-    spyOn(handler, 'getSymbol').and.returnValue({
+    spyOn(handler, 'getLayerSymbol').and.returnValue({
         paint: {
             'line-color': '#ffffff'
         }
@@ -419,7 +419,7 @@ describe('mapboxgl_symbol_SymbolHandler', () => {
     });
     spyOn(handler, 'hasSymbol').and.returnValue(true);
     spyOn(handler, 'getLayerId').and.returnValue(undefined);
-    spyOn(handler, 'getSymbol').and.returnValue(undefined);
+    spyOn(handler, 'getLayerSymbol').and.returnValue(undefined);
     const result = handler.getStyle();
     expect(result.layers[0].symbol).toBeUndefined();
   });
