Skip to content

Commit c36de38

Browse files
committed
[update] WebSymbol符号库的相关接口文档新增版本信息
review by zhaoq
1 parent 15e765a commit c36de38

File tree

2 files changed

+72
-0
lines changed

2 files changed

+72
-0
lines changed

src/mapboxgl/overlay/symbol/WebSymbol.js

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ import MapExtendSymbol from './MapExtendSymbol';
2424
* id |string |[Web符号ID](../../../../../examples/mapboxgl/websymbol_gallery.html)
2525
* callback |function |在符号加载完成后调用,返回符号信息;如果有错误,则返回错误参数。
2626
*
27+
* **Version:**
28+
*
29+
* 11.1.0
30+
*
2731
* **Example**
2832
* ```
2933
* map.loadSymbol('point-1', (error, symbol) => {
@@ -45,6 +49,10 @@ import MapExtendSymbol from './MapExtendSymbol';
4549
* | | |paint |object |可选,Mapbox Layers [paint](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#paint-property)|
4650
* | | |layout |object |可选,Mapbox Layers [layout](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#layout-property)(visibility 属性除外)|
4751
*
52+
* **Version:**
53+
*
54+
* 11.1.0
55+
*
4856
* **Example**
4957
* ```
5058
* map.addSymbol('point-1', symbol);
@@ -59,6 +67,10 @@ import MapExtendSymbol from './MapExtendSymbol';
5967
* layerId |string |图层ID
6068
* symbol |string、array |已经添加的符号ID(addSymbol中的符号ID), 或者[符号表达式](#expression)
6169
*
70+
* **Version:**
71+
*
72+
* 11.1.0
73+
*
6274
* **Example**
6375
* ```
6476
* map.setSymbol("layerId", 'point-1');
@@ -81,6 +93,9 @@ import MapExtendSymbol from './MapExtendSymbol';
8193
* :---- |:--- |:---
8294
* id |string |符号ID
8395
*
96+
* **Version:**
97+
*
98+
* 11.1.0
8499
*
85100
* **Returns**
86101
* 类型 |描述
@@ -100,6 +115,10 @@ import MapExtendSymbol from './MapExtendSymbol';
100115
* :---- |:--- |:---
101116
* id |string |已经添加的符号ID
102117
*
118+
* **Version:**
119+
*
120+
* 11.1.0
121+
*
103122
* **Example**
104123
* ```
105124
* map.removeSymbol('point-1');
@@ -117,6 +136,10 @@ import MapExtendSymbol from './MapExtendSymbol';
117136
* | | |paint |object |可选,Mapbox Layers [paint](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#paint-property)|
118137
* | | |layout |object |可选,Mapbox Layers [layout](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#layout-property)(visibility 属性除外)|
119138
*
139+
* **Version:**
140+
*
141+
* 11.1.0
142+
*
120143
* **Example**
121144
* ```
122145
* map.updateSymbol('point-1', symbol);
@@ -130,6 +153,10 @@ import MapExtendSymbol from './MapExtendSymbol';
130153
* :---- |:--- |:---
131154
* id |string |符号ID
132155
*
156+
* **Version:**
157+
*
158+
* 11.1.0
159+
*
133160
* **Returns**
134161
* 类型 |描述
135162
* :--- |:---
@@ -152,6 +179,10 @@ import MapExtendSymbol from './MapExtendSymbol';
152179
* name |string |属性名称
153180
* value |any |可选,属性值
154181
*
182+
* **Version:**
183+
*
184+
* 11.1.0
185+
*
155186
* **Example**
156187
* ```
157188
* map.setSymbolProperty('point-1', null, "icon-color", "black");
@@ -168,6 +199,10 @@ import MapExtendSymbol from './MapExtendSymbol';
168199
* index |number、null |符号数组的index, 符号不是数组的设置为null
169200
* name |string |属性名称
170201
*
202+
* **Version:**
203+
*
204+
* 11.1.0
205+
*
171206
* **Returns**
172207
* 类型 |描述
173208
* :--- |:---
@@ -265,6 +300,7 @@ export class WebSymbol {
265300
/**
266301
* @function WebSymbol.prototype.init
267302
* @description 初始化Web符号配置。
303+
* @version 11.1.0
268304
* @param {object} config - 配置信息
269305
* @param {string} [config.basePath] - 指定符号资源路径
270306
*/

src/maplibregl/overlay/symbol/WebSymbol.js

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ import MapExtendSymbol from './MapExtendSymbol';
2424
* id |string |[Web符号ID](../../../../../examples/maplibregl/websymbol_gallery.html)
2525
* callback |function |在符号加载完成后调用,返回符号信息;如果有错误,则返回错误参数。
2626
*
27+
* **Version:**
28+
*
29+
* 11.1.1
30+
*
2731
* **Example**
2832
* ```
2933
* map.loadSymbol('point-1', (error, symbol) => {
@@ -45,6 +49,10 @@ import MapExtendSymbol from './MapExtendSymbol';
4549
* | | |paint |object |可选,Maplibre Layers [paint](https://maplibre.org/maplibre-style-spec/layers/#paint-property)|
4650
* | | |layout |object |可选,Maplibre Layers [layout](https://maplibre.org/maplibre-style-spec/layers/#layout-property)(visibility 属性除外)|
4751
*
52+
* **Version:**
53+
*
54+
* 11.1.1
55+
*
4856
* **Example**
4957
* ```
5058
* map.addSymbol('point-1', symbol);
@@ -59,6 +67,10 @@ import MapExtendSymbol from './MapExtendSymbol';
5967
* layerId |string |图层ID
6068
* symbol |string、array |已经添加的符号ID(addSymbol中的符号ID), 或者[符号表达式](#expression)
6169
*
70+
* **Version:**
71+
*
72+
* 11.1.1
73+
*
6274
* **Example**
6375
* ```
6476
* map.setSymbol("layerId", 'point-1');
@@ -81,6 +93,9 @@ import MapExtendSymbol from './MapExtendSymbol';
8193
* :---- |:--- |:---
8294
* id |string |符号ID
8395
*
96+
* **Version:**
97+
*
98+
* 11.1.1
8499
*
85100
* **Returns**
86101
* 类型 |描述
@@ -100,6 +115,10 @@ import MapExtendSymbol from './MapExtendSymbol';
100115
* :---- |:--- |:---
101116
* id |string |已经添加的符号ID
102117
*
118+
* **Version:**
119+
*
120+
* 11.1.1
121+
*
103122
* **Example**
104123
* ```
105124
* map.removeSymbol('point-1');
@@ -117,6 +136,10 @@ import MapExtendSymbol from './MapExtendSymbol';
117136
* | | |paint |object |可选,Maplibre Layers [paint](https://maplibre.org/maplibre-style-spec/layers/#paint-property)|
118137
* | | |layout |object |可选,Maplibre Layers [layout](https://maplibre.org/maplibre-style-spec/layers/#layout-property)(visibility 属性除外)|
119138
*
139+
* **Version:**
140+
*
141+
* 11.1.1
142+
*
120143
* **Example**
121144
* ```
122145
* map.updateSymbol('point-1', symbol);
@@ -130,6 +153,10 @@ import MapExtendSymbol from './MapExtendSymbol';
130153
* :---- |:--- |:---
131154
* id |string |符号ID
132155
*
156+
* **Version:**
157+
*
158+
* 11.1.1
159+
*
133160
* **Returns**
134161
* 类型 |描述
135162
* :--- |:---
@@ -152,6 +179,10 @@ import MapExtendSymbol from './MapExtendSymbol';
152179
* name |string |属性名称
153180
* value |any |可选,属性值
154181
*
182+
* **Version:**
183+
*
184+
* 11.1.1
185+
*
155186
* **Example**
156187
* ```
157188
* map.setSymbolProperty('point-1', null, "icon-color", "black");
@@ -168,6 +199,10 @@ import MapExtendSymbol from './MapExtendSymbol';
168199
* index |number、null |符号数组的index, 符号不是数组的设置为null
169200
* name |string |属性名称
170201
*
202+
* **Version:**
203+
*
204+
* 11.1.1
205+
*
171206
* **Returns**
172207
* 类型 |描述
173208
* :--- |:---
@@ -265,6 +300,7 @@ export class WebSymbol {
265300
/**
266301
* @function WebSymbol.prototype.init
267302
* @description 初始化Web符号配置。
303+
* @version 11.1.1
268304
* @param {object} config - 配置信息
269305
* @param {string} [config.basePath] - 指定符号资源路径
270306
*/

0 commit comments

Comments
 (0)