优化 fgb 文档描述

Author: xilanhuaweidapao

build/jsdocs/template/typeLinkExt.js

@@ -46,6 +46,7 @@ var typeLinks = {
     "ol.control.Control": olapi + "module-ol_control_Control-Control.html",
     "ol.tilegrid.TileGrid": olapi + "module-ol_tilegrid_TileGrid-TileGrid.html",
     "ol.tilegrid.WMTS": olapi + "module-ol_tilegrid_WMTS.html",
+    "ol.loadingstrategy": olapi + "module-ol_loadingstrategy.html",
 
     //leaflet
     "L.Marker": lfapi + '#marker',
@@ -104,6 +105,7 @@ var typeLinks = {
     "GeoJSONFeature": geometryapi + '#section-3.2',
     // WebMap 结构
     "WebMapSummaryObject": helpDocApi + '#iP/Appendix/WebMap/WebMapSummary.htm',
+    "FlatGeobuf": 'https://github.com/flatgeobuf/flatgeobuf',
 
     // Web API
     "Promise": webApi + 'JavaScript/Reference/Global_Objects/Promise',

src/leaflet/overlay/FGBLayer.js

@@ -11,19 +11,33 @@ import { deserialize } from 'flatgeobuf/lib/mjs/geojson';
 /**
  * @class FGBLayer
  * @deprecatedclassinstance L.supermap.FGBLayer
- * @classdesc Fgb 图层源。
+ * @classdesc FGB 图层，该图层把 {@link FlatGeobuf} 格式解析为点线面要素。
  * @version 11.1.0
  * @category Visualization FGB
  * @extends {L.LayerGroup}
  * @param {string} url - FGB 服务地址，例如：http://localhost:8090/iserver/services/xxx/rest/data/featureResults/newResourceId.fgb。
  * @param {Object} options - 参数。
  * @param {function} [options.pointToLayer] - 定义点要素如何绘制在地图上。
  * @param {function} [options.style] - 定义点、线、面要素样式。参数为{@link L.Path-option}。
- * @param {boolean} [options.strategy='bbox'] - 指定加载策略，可选值为 all，bbox。 all为全量加载， bbox为按需加载。
+ * @param {string} [options.strategy='bbox'] - 指定加载策略，可选值为 all，bbox。 all为全量加载， bbox为按需加载。
  * @param {Array} [options.extent] - 加载范围, 参数规范为: [minX, minY, maxX, maxY], 传递此参数后, 图层将使用局部加载。
  * @param {function} [options.featureLoader] - 要素自定义方法。
  * @param {function} [options.onEachFeature] - 要素创建时调用
  * @usage
+ * ```
+ * // 浏览器
+ * <script type="text/javascript" src="{cdn}"></script>
+ * <script>
+ *   new {namespace}.FGBLayer(url, options);
+ * 
+ * </script>
+ * 
+ * // ES6 Import
+ * import { FGBLayer } from '{npm}';
+ * 
+ * new FGBLayer(url, options);
+ * 
+ * ```
  */
 
 export var FGBLayer = L.LayerGroup.extend({

src/mapboxgl/overlay/FGBLayer.js

@@ -17,11 +17,11 @@ import { deserialize } from 'flatgeobuf/lib/mjs/geojson';
 /**
  * @class FGBLayer
  * @category Visualization FGB
- * @classdesc FGB。
+ * @classdesc FGB 图层，该图层把 {@link FlatGeobuf} 格式解析为点线面要素。
  * @version 11.1.0
  * @param {Object} options - 参数。
  * @param {string} [options.layerID] - 图层 ID。默认使用 CommonUtil.createUniqueID("FGBlayer_") 创建图层 ID。
- * @param {boolean} [options.strategy='bbox'] - 指定加载策略，可选值为 all，bbox。 all为全量加载， bbox为当前可见范围加载。
+ * @param {string} [options.strategy='bbox'] - 指定加载策略，可选值为 all，bbox。 all为全量加载， bbox为当前可见范围加载。
  * @param {Array} [options.extent] - 加载范围, 参数规范为: [minX, minY, maxX, maxY], 传递此参数后, 图层将使用局部加载。
  * @param {function} [options.featureLoader] - 要素自定义方法，接收要素作为参数，需返回要素。
  * @param {Object} [options.paint] - 参数内容详见: {@link https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#paint-property}
@@ -110,8 +110,8 @@ export class FGBLayer {
     this._handleFeatures(extent);
   }
 
-  moveLayer(id, beforeId) {
-    this.map.removeLayer(this.layerId, beforeId);
+  moveLayer(beforeId) {
+    this.map.moveLayer(this.layerId, beforeId);
   }
 
   removeLayer() {

src/openlayers/overlay/FGB.js

@@ -11,13 +11,13 @@ import GeoJSON from 'ol/format/GeoJSON';
  * @class FGB
  * @browsernamespace ol.source
  * @category Visualization FGB
- * @classdesc FGB 图层源。
+ * @classdesc FGB 图层源，该图层源把 {@link FlatGeobuf} 格式解析为点线面要素。
  * @version 11.1.0
  * @param {Object} opt_options - 参数。
  * @param {string} opt_options.url - FGB 服务地址，例如：http://localhost:8090/iserver/services/xxx/rest/data/featureResults/newResourceId.fgb。
- * @param {GeoJSONObject} [opt_options.strategy='bbox'] - 指定加载策略，可选值为 ol.loadingstrategy.all，ol/loadingstrategy.bbox。all为全部加载， bbox为当前可见范围加载
+ * @param {ol.loadingstrategy} [opt_options.strategy='bbox'] - 指定加载策略，可选值为 ol.loadingstrategy.all，ol/loadingstrategy.bbox。all为全部加载， bbox为当前可见范围加载
  * @param {Array} [opt_options.extent] - 加载范围, 参数规范为: [minX, minY, maxX, maxY], 传递此参数后, 图层将使用局部加载。
- * @param {Function} [opt_options.featureLoader] - 要素加载回调函数
+ * @param {function} [opt_options.featureLoader] - 要素加载回调函数
  * @param {boolean} [opt_options.overlaps] - 是否优化重叠要素的填充与描边操作
  * @param {boolean} [opt_options.useSpatialIndex] - 是否启用要素空间索引
  * @param {boolean} [opt_options.wrapX] - 是否平铺地图