leaflet & openlayers api 可选参数优化 review by songym

Author: liqian7

src/leaflet/core/Transform.js

@@ -4,11 +4,11 @@ import {CommonUtil} from '@supermap/iclient-common';
 /**
  * @function L.Util.transform
  * @description 将要素转换为指定坐标。
- * @param {(L.marker|L.circleMarker|L.polyline|L.polygon|L.rectangle|L.latLngBounds|L.bounds|Object)} feature - 待转要素包括 Leaflet Vector Layers
- *              的 L.marker|L.circleMarker|L.polyline|L.polygon|L.rectangle|L.latLngBounds|L.bounds 类型和 GeoJOSN 规范数据类型
- * @param {L.Proj.CRS} [sourceCRS=L.CRS.EPSG4326] - 要素转换目标坐标系，默认为 L.CRS.EPSG4326
- * @param {L.Proj.CRS} targetCRS - 要素转换目标坐标系
- * @return {Object} 返回GeoJOSN 规范数据类型
+ * @param {(L.Marker|L.CircleMarker|L.Polyline|L.Polygon|L.Rectangle|L.LatLngBounds|L.Bounds|Object)} feature - 待转要素包括 Leaflet Vector Layers
+ *              的 {@link L.Marker}|{@link L.CircleMarker}|{@link L.Polyline}|{@link L.Polygon}|{@link L.Rectangle}|{@link L.LatLngBounds}|{@link L.Bounds} 类型和 GeoJOSN 规范数据类型。
+ * @param {L.Proj.CRS} [sourceCRS=L.CRS.EPSG4326] - 要素转换源坐标系。
+ * @param {L.Proj.CRS} targetCRS - 要素转换目标坐标系。
+ * @return {Object} 返回 GeoJOSN 规范数据类型。
  */
 export var transform = function (feature, sourceCRS = L.CRS.EPSG4326, targetCRS) {
     let selfFeatures = null;

src/leaflet/mapping/TileLayer.WMTS.js

@@ -13,7 +13,7 @@ import "../core/Base";
  * @param {string} [options.tileProxy] - 启用托管地址。
  * @param {Object} [options.style] - 图层样式。
  * @param {string} [options.format='image/png'] - wmts 图像格式（'image/png'用于具有透明度的图层）。
- * @param {string} [options.tileSize='256'] - 瓦片大小。
+ * @param {(number|L.Point)} [options.tileSize='256'] - 瓦片大小。
  * @param {string} [options.requestEncoding='KVP'] - KVP 或者 REST 的请求方式。
  * @param {Object} [options.tilematrixSet] - 瓦片矩阵集。
  * @param {string} [options.attribution] - 版权信息。

src/leaflet/mapping/TiledMapLayer.js

@@ -35,7 +35,7 @@ import Attributions from '../core/Attributions'
  * @param {string} [options.attribution='Map Data <span>© <a href='http://support.supermap.com.cn/product/iServer.aspx' title='SuperMap iServer' target='_blank'>SuperMap iServer</a></span>'] - 版权信息。
  * @param {string} [options.tileProxy] - 启用托管地址。
  * @param {string} [options.format='png'] - 瓦片表述类型，支持 "png" 、"bmp" 、"jpg" 和 "gif" 四种表述类型。
- * @param {string} [options.tileSize] - 瓦片大小。
+ * @param {(number|L.Point)} [options.tileSize=256] - 瓦片大小。
  */
 export var TiledMapLayer = L.TileLayer.extend({
 

src/leaflet/mapping/WebMap.js

@@ -437,6 +437,8 @@ export var WebMap = L.LayerGroup.extend({
      * @function L.supermap.webmap.prototype.createWmsLayer
      * @description 创建 Wms 图层。
      * @param {Object} layerInfo - 图层信息。
+     * @returns {L.Layer} 返回 Wms 图层对象。
+
      */
     createWmsLayer: function (layerInfo) {
         var url = layerInfo.url,

src/leaflet/overlay/DataFlowLayer.js

@@ -12,10 +12,10 @@ import {
 
 /**
  * @class L.supermap.dataFlowLayer
- * @classdesc 实时数据图层源。
+ * @classdesc 数据流图层源。
  * @category  iServer DataFlow
  * @extends {L.LayerGroup}
- * @param {string} url - 实时数据图层服务地址。
+ * @param {string} url - 数据流图层服务地址。
  * @param {Object} options - 设置图层参数。
  * @param {Object} [options.render='normal'] - 绘制方式。可选值为'normal'，'mapv'。</br>
                                                'normal' 表示以 {( {@link L.LatLng}|{@link L.Polyline}|{@link L.Polygon}|{@link L.Marker} )} 方式绘制实时数据。'mapv' 表示以 {@link L.supermap.mapVLayer} 方式绘制实时数据。 
@@ -71,16 +71,16 @@ export var DataFlowLayer = L.LayerGroup.extend({
             excludeField: this.options.excludeField
         }).initSubscribe();
         /**
-         * @description 初始化成功后触发。
          * @event L.supermap.dataFlowLayer#subscribesuccessed
+         * @description 初始化成功后触发。
          * @property {Object} e  - 事件对象。
          * 
          */
         this.dataService.on('subscribeSocketConnected', (e) => this.fire("subscribesuccessed", e));
         this.dataService.on('messageSuccessed', (msg) => this._onMessageSuccessed(msg));
         /**
-         * @description 过滤参数设置成功后触发。
          * @event L.supermap.dataFlowLayer#setfilterparamsuccessed
+         * @description 过滤参数设置成功后触发。
          * @property {Object} e  - 事件对象。
          */
         this.dataService.on('setFilterParamSuccessed', (msg) => this.fire("setfilterparamsuccessed", msg));
@@ -115,7 +115,7 @@ export var DataFlowLayer = L.LayerGroup.extend({
     /**
      * @function L.supermap.dataFlowLayer.prototype.setGeometry
      * @description 设置集合要素。
-     * @param {Object} geometry - 待设置的GeoJSON几何要素对象。
+     * @param {Object} geometry - 待设置的 GeoJSON 几何要素对象。
      */
     setGeometry: function (geometry) {
         this.dataService.setGeometry(geometry);

src/leaflet/overlay/GraphicLayer.js

@@ -46,7 +46,7 @@ const CSS_TRANSFORM = (function () {
  * @extends {L.Path}
  * @param {Array.<L.supermap.graphic>} graphics - 要素对象。
  * @param {Object} options - 图层参数。
- * @param {string}   [options.render='canvas']  -  指定使用的渲染器。可选值："webgl","canvas"(webgl渲染目前只支持散点)。
+ * @param {string}   [options.render='canvas']  -  指定使用的渲染器。可选值："webgl","canvas"（webgl渲染目前只支持散点）。
  * @param {Array.<number>} [options.color=[0, 0, 0, 255]] - 要素颜色。
  * @param {Array.<number>} [options.highlightColor] - webgl 渲染时要素高亮颜色。
  * @param {number} [options.opacity=0.8] - 要素透明度。
@@ -143,7 +143,7 @@ export var GraphicLayer = L.Path.extend({
      * @param {Array.<number>} [styleOptions.color=[0, 0, 0, 255]] - 点颜色。
      * @param {number} [styleOptions.radius=10] - 点半径。
      * @param {number} [styleOptions.opacity=0.8] - 不透明度。
-     * @param {Array}  [styleOptions.highlightColor] - 高亮颜色，目前只支持rgba数组。
+     * @param {Array}  [styleOptions.highlightColor] - 高亮颜色，目前只支持 rgba 数组。
      * @param {number} [styleOptions.radiusScale=1] - 点放大倍数。
      * @param {number} [styleOptions.radiusMinPixels=0] - 半径最小值(像素)。
      * @param {number} [styleOptions.radiusMaxPixels=Number.MAX_SAFE_INTEGER] - 半径最大值(像素)。

src/leaflet/overlay/HeatMapLayer.js

@@ -17,7 +17,7 @@ import Attributions from '../core/Attributions'
  * @category Visualization HeatMap
  * @param {string} name - 图层名称。
  * @param {boolean} [loadWhileAnimating=true] - 是否实时重绘。（当绘制大数据量要素的情况下会出现卡顿，建议把该参数设为 false）。
- * @param {Array.<string>} [colors=['blue', 'cyan', 'lime', 'yellow', 'red']] - 颜色线性渐变数组,颜色值必须为 canvas 所支持的。
+ * @param {Array.<string>} [colors=['blue', 'cyan', 'lime', 'yellow', 'red']] - 颜色线性渐变数组，颜色值必须为 canvas 所支持的。
  * @param {Object} options - 构造参数。
  * @param {L.Map} options.map - leaflet 的 map 对象。
  * @param {string} [options.id] - 专题图层 ID，默认使用 CommonUtil.createUniqueID("heatMapLayer_") 创建专题图层 ID。
@@ -121,7 +121,7 @@ export var HeatMapLayer = L.Layer.extend({
     /**
      * @function L.supermap.heatMapLayer.prototype.addFeatures
      * @description 添加热点信息。
-     * @param {(Object|HeatMapFeature)} features - 待添加的要素数组,支持 GeoJOSN 规范数据类型和 HeatMapFeature 格式。
+     * @param {(Object|HeatMapFeature)} features - 待添加的要素数组，支持 GeoJOSN 规范数据类型和 HeatMapFeature 格式。
      *
      * @example
      * var geojson = {

src/leaflet/overlay/LabelThemeLayer.js

@@ -679,7 +679,7 @@ export var LabelThemeLayer = GeoFeatureThemeLayer.extend({
      * @function L.supermap.LabelThemeLayer.prototype.rotationBounds
      * @description 旋转 bounds。
      *
-     * @param {SuperMap.Bounds} bounds - 要旋转的bounds。
+     * @param {SuperMap.Bounds} bounds - 要旋转的 bounds。
      * @param {Object} rotationCenterPoi - 旋转中心点对象，此对象含有属性x(横坐标)，属性y(纵坐标)。
      * @param {number}  angle - 旋转角度（顺时针）。
      *
@@ -717,7 +717,7 @@ export var LabelThemeLayer = GeoFeatureThemeLayer.extend({
      * @param {number} ry - 旋转中心点纵坐标。
      * @param {number} angle - 旋转角度。
      *
-     * @return {Object} 旋转后的坐标位置对象，该对象含有属性x(横坐标)，属性y(纵坐标)。
+     * @return {Object} 旋转后的坐标位置对象，该对象含有属性 x（横坐标），属性 y（纵坐标）。
      */
     getRotatedLocation: function (x, y, rx, ry, angle) {
         var loc = {}, x0, y0;
@@ -882,7 +882,7 @@ export var LabelThemeLayer = GeoFeatureThemeLayer.extend({
      * @function L.supermap.LabelThemeLayer.prototype.isPointInPoly
      * @description 判断一个点是否在多边形里面。(射线法)。
      *
-     * @param {Object} pt - 需要判定的点对象，该对象含有属性x(横坐标)，属性y(纵坐标)。
+     * @param {Object} pt - 需要判定的点对象，该对象含有属性 x（横坐标），属性 y（纵坐标）。
      * @param {Array.<Object>} poly - 多边形节点数组。例如一个四边形：[{"x":1,"y":1},{"x":3,"y":1},{"x":6,"y":4},{"x":2,"y":10},{"x":1,"y":1}]。
      * @return {boolean} 点是否在多边形内。
      */

src/leaflet/overlay/RankSymbolThemeLayer.js

@@ -33,7 +33,7 @@ export var RankSymbolThemeLayer = GraphThemeLayer.extend({
      * @property {number} [minR] - 圆形的最小半径。 
      * @property {String} [fillColor] - 圆形的填充色，如：fillColor: "#FFB980"。 
      * @property {Object} [circleStyle] - 圆形的基础 style，此参数控制圆形基础样式，优先级低于 circleStyleByFields 和 circleStyleByCodomain。 
-     * @property {number} [odecimalNumber] - 数据值数组 dataValues 元素值小数位数，数据的小数位处理参数，取值范围：[0, 16]。如果不设置此参数，在取数据值时不对数据做小数位处理。 
+     * @property {number} [decimalNumber] - 数据值数组 dataValues 元素值小数位数，数据的小数位处理参数，取值范围：[0, 16]。如果不设置此参数，在取数据值时不对数据做小数位处理。 
      * @property {Object} [circleHoverStyle] - 圆形 hover 状态时的样式，circleHoverAble 为 true 时有效。 
      * @property {boolean} [circleHoverAble=true] - 是否允许圆形使用 hover 状态。同时设置 circleHoverAble 和 circleClickAble 为 false，可以直接屏蔽图形对专题图层事件的响应。 
      * @property {boolean} [circleClickAble=true] - 是否允许圆形被点击。同时设置 circleHoverAble 和 circleClickAble 为 false，可以直接屏蔽图形对专题图层事件的响应。

src/leaflet/overlay/TileVectorLayer.js

@@ -33,7 +33,7 @@ import Attributions from '../core/Attributions'
  * @param {boolean} [option.returnAttributes=false] - 是否返回 attributes。
  * @param {string} [option.expands] - expands。
  * @param {boolean} [options.cacheEnabled=true] - 是否使用服务器缓存出图。
- * @param {Object} [options.tileTemplate] - /瓦片模板，如果设置了此参数，则按此模板出图，URL 无效（对接第三方瓦片）。
+ * @param {Object} [options.tileTemplate] - 瓦片模板，如果设置了此参数，则按此模板出图，URL 无效（对接第三方瓦片）。
  * @param {string} [options.subdomains] - 子域名。
  * @param {num} [options.timeout=10000] - timeout。
  * @param {string} [options.attribution='Map Data <span>© <a href='http://support.supermap.com.cn/product/iServer.aspx' title='SuperMap iServer' target='_blank'>SuperMap iServer</a></span>`] - 版权信息。