77 * @namespace
88 * @category Visualization WebSymbol
99 * @description
10- * **SuperMap iClient for MapboxGL 支持 Web 符号库，扩展了 [Map ](https://docs.mapbox.com/mapbox-gl-js/api/map /) 的 API。**
10+ * **SuperMap iClient for MapboxGL 支持 Web 符号库，扩展了 [Mapbox ](https://docs.mapbox.com/mapbox-gl-js/api/) 的 API。**
1111 *
1212 * ## 新增 API
13- * ## Map.loadSymbol
13+ * ## mapboxgl. Map.prototype .loadSymbol
1414 * 加载预定义符号。
1515 *
1616 * 参数名称 |类型 |描述
1717 * :---- |:--- |:---
1818 * id |string |[预定义符号ID]()
19- * callback |function |在符号加载完成后调用，如果有错误，则带错误参数
19+ * callback |function |在符号加载完成后调用，返回符号信息； 如果有错误，则返回错误参数。
2020 *
21+ * **Example**
2122 * ```
2223 * map.loadSymbol('point-1', (error, symbol) => {
2324 * if (error) throw error;
2728 * ```
2829 *
2930 *
30- * ## Map.addSymbol
31- * 在样式中添加一个符号 。该符号可以显示在地图上。符号 ID 用于 layer.symbol 。
31+ * ## mapboxgl. Map.prototype .addSymbol
32+ * 添加一个符号 。该符号可以显示在地图上。Mapbox layers 的 symbol属性可以使用该符号ID 。
3233 *
33- * 参数名称 |类型 |描述
34- * :---- |:--- |:---
35- * id |string |符号ID
36- * symbol |object |由[Mapbox Layers](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/)中的paint、layout组成的符号对象
34+ * |参数名称 |类型 |描述 | ||
35+ * |---- |--- |--- |---|---|
36+ * |id |string |符号ID |||
37+ * |symbol |object |由Mapbox Layers中的[paint](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#paint-property)、[layout](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#layout-property)组成的符号对象|||
38+ * | | |参数名称 |类型 |描述 |
39+ * | | |paint |object |Mapbox Layers [paint](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#paint-property)|
40+ * | | |layout |object |Mapbox Layers [layout](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#layout-property)|
3741 *
42+ * **Example**
3843 * ```
3944 * map.addSymbol('point-1', symbol);
4045 * ```
4146 *
4247 *
43- * ## Map.setSymbol
48+ * ## mapboxgl. Map.prototype .setSymbol
4449 * 给指定图层设置符号。
4550 *
4651 * 参数名称 |类型 |描述
4752 * :---- |:--- |:---
4853 * layerId |string |图层ID
49- * symbolId |string |已经添加的符号ID
54+ * symbolId |string |已经添加的符号ID（addSymbol中的符号ID)
5055 *
56+ * **Example**
5157 * ```
5258 * map.setSymbol("symbol", 'point-1');
5359 * ```
5460 *
5561 *
56- * ## Map.hasSymbol
57- * 检查样式中是否存在具有特定 ID 的符号.
62+ * ## mapboxgl. Map.prototype .hasSymbol
63+ * 检查是否存在特定 ID 的符号。
5864 *
5965 * 参数名称 |类型 |描述
6066 * :---- |:--- |:---
6167 * symbolId |string |符号ID
6268 *
69+ * **Example**
6370 * ```
6471 * const pointExists = map.hasSymbol('point-1');
6572 * ```
6673 *
6774 *
68- * ## Map.removeSymbol
69- * 从样式中删除符号 。
75+ * ## mapboxgl. Map.prototype .removeSymbol
76+ * 删除符号 。
7077 *
7178 * 参数名称 |类型 |描述
7279 * :---- |:--- |:---
7380 * symbolId |string |已经添加的符号ID
7481 *
82+ * **Example**
7583 * ```
7684 * map.removeSymbol('point-1');
7785 * ```
7886 *
7987 *
80- * ## 扩展 API
81- *
82- * ## [Map.addLayer](https://docs.mapbox.com/mapbox-gl-js/api/map/#map#addlayer)
83- * 添加图层。
84- *
85- * 扩展参数名称 |类型 |描述
86- * :---- |:--- |:---
87- * layer |[Mapbox Layers](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/) |layer 图层, 新增了symbol属性
88+ * ## 扩展 [Mapbox Layers](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/)
89+ * 在[Mapbox Layers](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/) 属性的基础上新增了symbol 属性， 指定符号ID。
8890 *
91+ * **Example**
8992 * ```
9093 * map.addLayer({
9194 * id: "symbol",
92- * source: "xx ",
95+ * source: "sourceId ",
9396 * type: "symbol",
9497 * symbol: 'point-1'
9598 * });
9699 * ```
97- *
98- *
99- * ## [Map.setStyle](https://docs.mapbox.com/mapbox-gl-js/api/map/#map#setstyle)
100- * 用新值更新地图的 Mapbox 样式对象。
101- *
102- * 扩展参数名称 |类型 |描述
103- * :---- |:--- |:---
104- * style | [Mapbox Style](https://docs.mapbox.com/mapbox-gl-js/style-spec/) |样式， 其中layer 图层, 新增了symbol属性
105- *
106100 * ```
107101 * map.setStyle({
108102 * version: 8,
109103 * sources: {},
110104 * layers: [{
111105 * id: "symbol",
112- * source: "xx ",
106+ * source: "sourceId ",
113107 * type: "symbol",
114108 * symbol: 'point-1'
115109 * }]
116110 * })
117111 * ```
118- *
119112 */
0 commit comments