leaflet api参数优化 & fix 矢量瓦片pointSymbolizer例子 review by songym

Author: liqian7

src/leaflet/control/ChangeTileVersion.js

@@ -4,7 +4,7 @@ import {MapService} from "../services/MapService";
 
 /**
  * @class L.supermap.control.changeTileVersion
- * @classdesc 版本切换控件,支持IE10及以上
+ * @classdesc 版本切换控件，支持 IE10 及以上。
  * @category  Control
  * @extends {L.Control}
  * @example
@@ -13,17 +13,17 @@ import {MapService} from "../services/MapService";
  *      position: "topleft",
  *      orientation: "horizontal"
  *  }).addTo(map);
- * @param {Object} options - logo控件配置项。
+ * @param {Object} options - logo 控件配置项。
  * @param {L.Layer} options.layer - 绑定的底图图层。
- * @param {string} [options.position='topleft'] - 控件位置 继承自leaflet control。
- * @param {string} options.title - 鼠标滑过时提示。
- * @param {string} options.tooltip - tooltip提示显示位置 top | right | bottom | left。
- * @param {boolean} options.collapsed - 是否折叠。
- * @param {string} options.nextText - 下一个版本的按钮布局。
- * @param {string} options.lastText - 上一个版本的按钮布局。
- * @param {string} options.ico - 控件显示的logo。
- * @param {string} options.orientation - 方向horizontal|vertical。
- * @param {boolean} options.switch - 是否显示上/下一个版本切换控件。
+ * @param {string} [options.position='topleft'] - 控件位置继承自 leaflet control。
+ * @param {string} [options.title='switch tile version'] - 鼠标滑过时提示。
+ * @param {string} [options.tooltip='top'] - tooltip 提示显示位置 top | right | bottom | left。
+ * @param {boolean} [options.collapsed=true] - 是否折叠。
+ * @param {string} [options.nextText='+'] - 下一个版本的按钮布局。
+ * @param {string} [options.lastText='-'] - 上一个版本的按钮布局。
+ * @param {string} [options.ico='v'] - 控件显示的 logo。
+ * @param {string} [options.orientation='horizontal'] - 方向 horizontal|vertical。
+ * @param {boolean} [options.switch=true] - 是否显示上/下一个版本切换控件。
  */
 export var ChangeTileVersion = L.Control.extend({
 
@@ -53,7 +53,7 @@ export var ChangeTileVersion = L.Control.extend({
     /**
      * @private
      * @function L.supermap.control.changeTileVersion.prototype.onAdd
-     * @description 添加控件
+     * @description 添加控件。
      */
     onAdd: function () {
         if (this.options.orientation !== 'vertical') {
@@ -68,8 +68,8 @@ export var ChangeTileVersion = L.Control.extend({
 
     /**
      * @function L.supermap.control.changeTileVersion.prototype.setContent
-     * @description 设置版本相关信息
-     * @param {Object} version - 版本信息
+     * @description 设置版本相关信息。
+     * @param {Object} version - 版本信息。
      */
     setContent: function (version) {
         var content = L.Util.extend({}, version);
@@ -78,9 +78,9 @@ export var ChangeTileVersion = L.Control.extend({
 
     /**
      * @function L.supermap.control.changeTileVersion.prototype.setVersionName
-     * @description  设置版本号
-     * @param {string} content - 版本信息
-     * @return {this} this
+     * @description  设置版本号。
+     * @param {string} content - 版本信息。
+     * @returns {this} this
      */
     setVersionName: function (content) {
         var value = content;
@@ -93,9 +93,9 @@ export var ChangeTileVersion = L.Control.extend({
 
     /**
      * @function L.supermap.control.changeTileVersion.prototype.setToolTip
-     * @description 设置提示信息
-     * @param {(HTMLElement|String)} tooltip - 要需要设置的提示信息
-     * @return {this} this
+     * @description 设置提示信息。
+     * @param {(HTMLElement|String)} tooltip - 要需要设置的提示信息。
+     * @returns {this} this
      */
     setToolTip: function (tooltip) {
         this.tooltip.innerHTML = tooltip;
@@ -104,8 +104,8 @@ export var ChangeTileVersion = L.Control.extend({
 
     /**
      * @function L.supermap.control.changeTileVersion.prototype.updateLength
-     * @description 更新进度条长度
-     * @param {number} length - 进度长度参数
+     * @description 更新进度条长度。
+     * @param {number} length - 进度长度参数。
      */
     updateLength: function (length) {
         if (length > 0) {
@@ -117,8 +117,8 @@ export var ChangeTileVersion = L.Control.extend({
 
     /**
      * @function L.supermap.control.changeTileVersion.prototype.setLayer
-     * @description 绑定图层
-     * @param {L.supermap.tiledMapLayer} layer - 绑定的图层
+     * @description 绑定图层。
+     * @param {L.supermap.tiledMapLayer} layer - 绑定的图层。
      */
     setLayer: function (layer) {
         if (layer) {
@@ -139,8 +139,8 @@ export var ChangeTileVersion = L.Control.extend({
 
     /**
      * @function L.supermap.control.changeTileVersion.prototype.update
-     * @description 更新缓存切片集及进度条长度
-     * @param {number} tileVersions - 待更新的切片版本号
+     * @description 更新缓存切片集及进度条长度。
+     * @param {number} tileVersions - 待更新的切片版本号。
      */
     update: function (tileVersions) {
         this.tileVersions = tileVersions;
@@ -149,7 +149,7 @@ export var ChangeTileVersion = L.Control.extend({
 
     /**
      * @function L.supermap.control.changeTileVersion.prototype.getTileSetsInfo
-     * @description 请求获取切片集信息
+     * @description 请求获取切片集信息。
      */
     getTileSetsInfo: function () {
         var me = this;
@@ -162,15 +162,15 @@ export var ChangeTileVersion = L.Control.extend({
 
     /**
      * @function L.supermap.control.changeTileVersion.prototype.removeLayer
-     * @description 移除绑定的地图图层
+     * @description 移除绑定的地图图层。
      */
     removeLayer: function () {
         this.options.layer = null;
     },
 
     /**
      * @function L.supermap.control.changeTileVersion.prototype.nextTilesVersion
-     * @description 下一个版本,第一次不进行加减，是无版本的状态
+     * @description 下一个版本，第一次不进行加减，是无版本的状态。
      * @return {this} this
      */
     nextTilesVersion: function () {
@@ -189,7 +189,7 @@ export var ChangeTileVersion = L.Control.extend({
 
     /**
      * @function L.supermap.control.changeTileVersion.prototype.lastTilesVersion
-     * @description 上一个版本
+     * @description 上一个版本。
      */
     lastTilesVersion: function () {
         if (parseInt(this.slider.value) < this.min + 1) {
@@ -202,8 +202,8 @@ export var ChangeTileVersion = L.Control.extend({
 
     /**
      * @function L.supermap.control.changeTileVersion.prototype.tilesVersion
-     * @description 根据指定版本号请求版本
-     * @param {string} version - 版本号参数
+     * @description 根据指定版本号请求版本。
+     * @param {string} version - 版本号参数。
      */
     tilesVersion: function (version) {
         var layer = this.options.layer,
@@ -220,15 +220,15 @@ export var ChangeTileVersion = L.Control.extend({
 
     /**
      * @function L.supermap.control.changeTileVersion.prototype.getValue
-     * @description 获取进度条的值。注：(进度条的值并不是版本号)
+     * @description 获取进度条的值。注：(进度条的值并不是版本号)。
      */
     getValue: function () {
         return this.slider.value;
     },
 
     /**
      * @function L.supermap.control.changeTileVersion.prototype.getVersion
-     * @description 获取当前进度条值对应的版本号
+     * @description 获取当前进度条值对应的版本号。
      */
     getVersion: function () {
         var version = this.tileVersions[this.getValue()];

src/leaflet/control/Logo.js

@@ -6,21 +6,21 @@ import {
 
 /**
  * @class L.supermap.control.logo
- * @classdesc Logo控件。
+ * @classdesc Logo 控件。
  * @category  Control
- * @description map初始化的配置项为logoControl，如果为true，则显示控件；否则不显示该控件。目前默认显示。
+ * @description map 初始化的配置项为 logoControl，如果为 true，则显示控件；否则不显示该控件。目前默认显示。
  * @extends {L.Control}
  * @example
  *  L.supermap.control.Logo({
  *      imageUrl: xxx,//非必填项
  *  }).addTo(map);
- * @param {Object} options - logo控件配置项
- * @param {string} options.position - 控件位置 继承自leaflet control
- * @param {string} options.imageUrl - logo图片地址
- * @param {string} options.width - logo图片宽
- * @param {string} options.height - logo图片高
- * @param {string} options.link - 跳转链接
- * @param {string} options.alt - logo图片失效时显示文本
+ * @param {Object} options - logo 控件配置项。
+ * @param {string} [options.position='bottomright'] - 控件位置继承自 leaflet control。
+ * @param {string} [options.imageUrl] - logo 图片地址。
+ * @param {string} [options.width] - logo 图片宽。
+ * @param {string} [options.height] - logo 图片高。
+ * @param {string} [options.link] - 跳转链接。
+ * @param {string} [options.alt='SuperMap iClient'] - logo 图片失效时显示文本。
  */
 export var Logo = L.Control.extend({
 
@@ -42,8 +42,8 @@ export var Logo = L.Control.extend({
      * @private
      * @function L.supermap.control.logo.prototype.onAdd
      * @override
-     * @description 添加一个logo
-     * @return {div} 返回创建logo的div
+     * @description 添加一个 logo。
+     * @return {div} 返回创建 logo 的 div。
      */
     onAdd: function () {
         var div = L.DomUtil.create('div', 'iclient-leaflet-logo');

src/leaflet/core/CommontypesConversion.js

@@ -4,14 +4,14 @@ import {Bounds} from '@supermap/iclient-common';
 
 /**
  * @class L.supermap.CommontypesConversion
- * @classdesc Leaflet对象和SuperMap对象转换工具
+ * @classdesc Leaflet 对象和 SuperMap 对象转换工具。
  */
 export class CommontypesConversion {
     /**
      * @function L.supermap.CommontypesConversion.toSuperMapBounds
-     * @description 将Leaflet对象得bounds转成SuperMap 的bounds对象
-     * @param {(L.Bounds|L.LatLngBounds)} bounds - 图层显示范围
-     * @return {SuperMap.Bounds} SuperMap的bounds对象
+     * @description 将 Leaflet 对象的 bounds 转成 SuperMap 的 bounds对象。
+     * @param {(L.Bounds|L.LatLngBounds)} bounds - 图层显示范围。
+     * @return {SuperMap.Bounds} SuperMap 的 bounds 对象。
      */
     static toSuperMapBounds(bounds) {
         if (bounds && ["FeatureCollection", "Feature"].indexOf(bounds.type) !== -1) {
@@ -47,19 +47,19 @@ export class CommontypesConversion {
 
     /**
      * @function L.supermap.Util.isArray
-     * @description 判断是否为数组格式
-     * @param {Object} obj - 待判断对象
-     * @return {boolean} 是否是数组
+     * @description 判断是否为数组格式。
+     * @param {Object} obj - 待判断对象。
+     * @return {boolean} 是否是数组。
      */
     static isArray(obj) {
         return Object.prototype.toString.call(obj) == '[object Array]';
     }
 
     /**
      * @function L.supermap.CommontypesConversion.toProcessingParam
-     * @description 将Region节点数组转为Processing服务需要的分析参数
-     * @param {Array} points - Region各个节点数组
-     * @return processing服务裁剪、查询分析的分析参数
+     * @description 将 Region 节点数组转为 Processing 服务需要的分析参数。
+     * @param {Array} points - Region 各个节点数组。
+     * @return processing 服务裁剪、查询分析的分析参数。
      */
     static toProcessingParam(points) {
         var geometryParam = {};

src/leaflet/core/ExtendsCRS.js

@@ -2,7 +2,7 @@ import L from "leaflet";
 
 /**
  * @name L.CRS.BaiduCRS
- * @description 百度的坐标对象
+ * @description 百度的坐标对象。
  * @namespace
  * @category BaseTypes Projection
  */
@@ -26,7 +26,7 @@ for (let i = 1; i < 19; i++) {
 
 /**
  * @name L.CRS.TianDiTu_WGS84CRS
- * @description 天地图WGS84坐标对象
+ * @description 天地图 WGS84 坐标对象。
  * @namespace
  * @category BaseTypes Projection
  */
@@ -43,7 +43,7 @@ for (let i = 1; i < 19; i++) {
 
 /**
  * @name L.CRS.TianDiTu_MercatorCRS
- * @description 天地图墨卡托坐标对象
+ * @description 天地图墨卡托坐标对象。
  * @category BaseTypes Projection
  * @namespace
  */

src/leaflet/core/NonEarthCRS.js

@@ -5,7 +5,7 @@ L.Projection = {};
 /**
  * @private
  * @class L.Projection.NonProjection
- * @classdesc 平面无投影对象
+ * @classdesc 平面无投影对象。
  * @category BaseTypes Projection
  * @extends {L.Class}
  * @param {L.bounds} bounds - 坐标范围
@@ -31,19 +31,19 @@ export var nonProjection = function (bounds) {
 
 /**
  * @class L.CRS.NonEarthCRS
- * @classdesc 平面无投影坐标类
+ * @classdesc 平面无投影坐标类。
  * @category BaseTypes Projection
  * @extends {L.Class}
- * @param {Object} options - 构建平面无投影坐标对象参数
- * @param {Object} options.origin - 原点
- * @param {L.bounds} options.bounds - 范围
- * @param {Array.<number>} options.resolutions - 分辨率
+ * @param {Object} options - 构建平面无投影坐标对象参数。
+ * @param {Object} options.origin - 原点。
+ * @param {L.bounds} options.bounds - 范围。
+ * @param {Array.<number>} [options.resolutions] - 分辨率。
  */
 export var NonEarthCRS = L.Class.extend({
 
-    /*
-     * @member L.CRS.NonEarthCRS.prototype.includes -{Object}
-     * @description 包含的坐标对象，默认为：L.CRS。
+    /** 
+     * @member {Object} [L.CRS.NonEarthCRS.prototype.includes=L.CRS]
+     * @description 包含的坐标对象。
      */
     includes: L.CRS,
 
@@ -61,9 +61,9 @@ export var NonEarthCRS = L.Class.extend({
 
     /**
      * @function L.CRS.NonEarthCRS.prototype.scale
-     * @description 通过缩放级别计算比例尺
-     * @param {number} zoom - 缩放级别
-     * @return {number} 得到的比例尺
+     * @description 通过缩放级别计算比例尺。
+     * @param {number} zoom - 缩放级别。
+     * @return {number} 得到的比例尺。
      */
     scale: function (zoom) {
         if (!this.resolutions || this.resolutions.length === 0) {
@@ -76,9 +76,9 @@ export var NonEarthCRS = L.Class.extend({
 
     /**
      * @function L.CRS.NonEarthCRS.prototype.zoom
-     * @description 通过比例尺计算范围
-     * @param {number} scale - 比例尺
-     * @return {number} 返回空间范围值
+     * @description 通过比例尺计算范围。
+     * @param {number} scale - 比例尺。
+     * @return {number} 返回空间范围值。
      */
     zoom: function (scale) {
         if (!this.resolutions || this.resolutions.length === 0) {
@@ -96,10 +96,10 @@ export var NonEarthCRS = L.Class.extend({
 
     /**
      * @function L.CRS.NonEarthCRS.prototype.distance
-     * @description 通过两个坐标点计算之间的距离
-     * @param {L.latLng} latlng1 - 坐标点1
-     * @param {L.latLng} latlng2 - 坐标点2
-     * @return {number} 返回距离长度
+     * @description 通过两个坐标点计算之间的距离。
+     * @param {L.latLng} latlng1 - 坐标点1。
+     * @param {L.latLng} latlng2 - 坐标点2。
+     * @return {number} 返回距离长度。
      */
     distance: function (latlng1, latlng2) {
         var dx = latlng2.lng - latlng1.lng,