优化api

Author: yaoxiaoni1

src/mapboxgl/overlay/GraphThemeLayer.js

@@ -122,7 +122,7 @@ export class Graph extends Theme {
     /**
      * @function mapboxgl.supermap.GraphThemeLayer.prototype.createThematicFeature
      * @description  向专题图图层中添加数据, 支持的 feature 类型为:iServer 返回的 feature json 对象。
-     * @param {Object} feature - 待填加得要素。
+     * @param {Object} feature - 待添加的要素。
      *
      */
     createThematicFeature(feature) {

src/mapboxgl/overlay/LabelThemeLayer.js

@@ -57,8 +57,8 @@ export class Label extends GeoFeature {
          * @description 分组样式。使用此属性需要设置 themeField 属性。</br>
          *              1.没有同时设置 themeField 和 styleGroups，则所有专题要素都使用本图层的 style 进行渲染；</br>
          *              2.同时设置 themeField 和 styleGroups，则按照 themeField 指定的字段名称获取用户数据（feature）attributes 中对应的属性值；</br>
-         *                  a.如果属性值等于 styleGroups 数组里某个元素定义的 value 值，则此专题要素取 styleGroups 数组中该元素定义的 style 进行渲染。</br>
-         *                  b.如果属性值不等于 styleGroups 数组里任何元素定义的 value 值，则此专题要素按照本图层的 style 进行渲染。</br>
+         *               &nbsp;&nbsp;a.如果属性值等于 styleGroups 数组里某个元素定义的 value 值，则此专题要素取 styleGroups 数组中该元素定义的 style 进行渲染。</br>
+         *               &nbsp;&nbsp;b.如果属性值不等于 styleGroups 数组里任何元素定义的 value 值，则此专题要素按照本图层的 style 进行渲染。</br>
          *              此数组每个元素对象必须有两个属性：value : 与字段 themeField 相对应的属性值；style：专题要素 style。
          */
         this.styleGroups = null;

src/mapboxgl/overlay/RangeTheme3DLayer.js

@@ -58,7 +58,7 @@ export class RangeTheme3DLayer extends Theme3DLayer {
     /**
      * @function  mapboxgl.supermap.RangeTheme3DLayer.prototype.getLayerStyleOptions
      * @description 获取图层样式。
-     * @returns {Object} mapboxgl 样式对象。
+     * @returns {Object} Mapbox GL 样式对象。
      */
     getLayerStyleOptions() {
         var opacity = this.opacity == null ? 1 : this.opacity;

src/mapboxgl/overlay/RankSymbolThemeLayer.js

@@ -17,7 +17,7 @@ import {FeatureTheme} from '@supermap/iclient-common';
  * @param {string} opt_options.themeFields - 指定创建专题图字段。
  * @param {boolean} [opt_options.isOverLay=true] - 是否进行压盖处理，如果设为 true，图表绘制过程中将隐藏对已在图层中绘制的图表产生压盖的图表。
  * @param {string} [opt_options.chartsType] - 图表类型。目前可用："Bar", "Line", "Pie"。
- * @param {Object} [opt_options.symbolSetting] - 各类型图表的 symbolSetting 对象可设属性请参考具体图表模型类的注释中对 symbolSetting 对象可设属性的描述。symbolSetting 对象通常都具有以下 5 个基础可设属性:</br>
+ * @param {Object} [opt_options.symbolSetting] - 各类型图表的 symbolSetting 对象可设属性请参考具体图表模型类的注释中对 symbolSetting 对象可设属性的描述。symbolSetting 对象通常都具有以下 5 个基础可设属性:
  * @param {number} [opt_options.symbolSetting.width] - 专题要素（图表）宽度。
  * @param {number} [opt_options.symbolSetting.height] - 专题要素（图表）高度。
  * @param {Array.<number>} opt_options.symbolSetting.codomain - 值域，长度为 2 的一维数组，第一个元素表示值域下限，第二个元素表示值域上限。

src/mapboxgl/overlay/ThreeLayer.js

@@ -21,9 +21,9 @@ const {
 /**
  * @class mapboxgl.supermap.ThreeLayer
  * @category  Visualization Three
- * @classdesc Three图层。
+ * @classdesc Three 图层。
  * @param {string} id - 图层 ID。
- * @param {string} [renderer="gl"] - 图层渲染方式(canvas或WebGL)。取值："gl","canvas"。
+ * @param {string} [renderer="gl"] - 图层渲染方式( canvas 或 WebGL )。取值："gl","canvas"。
  * @param {object} options - 初始化参数。
  * @param {object} options.threeOptions - threejs 渲染器初始化参数对象。参数内容详见:
  *          [WebGLRenderer]{@link https://threejs.org/docs/index.html#api/renderers/WebGLRenderer}
@@ -49,8 +49,8 @@ const {
  * }
  *
  * 叠加模型可以通过两种方式：</br>
- *     1.调用 threeLayer.toThreeMesh 直接将地理坐标转换成threejs 3D 模型（适用于挤压模型，如城市建筑），然后添加到3D场景
- *     2.使用 ThreeJS 的接口创建好 Mesh,然后调用 threeLayer.setPosition 设置地理位置，然后添加到3D场景
+ *     1.调用 threeLayer.toThreeMesh 直接将地理坐标转换成 threejs 3D 模型（适用于挤压模型，如城市建筑），然后添加到 3D 场景
+ *     2.使用 ThreeJS 的接口创建好 Mesh,然后调用 threeLayer.setPosition 设置地理位置，然后添加到 3D 场景
  *
  */
 export class ThreeLayer extends mapboxgl.Evented {
@@ -66,7 +66,7 @@ export class ThreeLayer extends mapboxgl.Evented {
 
     /**
      * @function mapboxgl.supermap.ThreeLayer.prototype.toThreeShape
-     * @description  创建threejs shape 对象。
+     * @description  创建 threejs shape 对象。
      * @param {Array} coordinates - 坐标点数组。
      * @returns THREE.Shape{@link https://threejs.org/docs/index.html#api/extras/core/Shape} threejs shape 对象。
      */
@@ -86,7 +86,7 @@ export class ThreeLayer extends mapboxgl.Evented {
 
     /**
      * @function mapboxgl.supermap.ThreeLayer.prototype.toThreeMesh
-     * @description 创建threejs Mesh 对象。将地理坐标转换成 threejs 3D 模型（适用于挤压模型，如城市建筑）。
+     * @description 创建 threejs Mesh 对象。将地理坐标转换成 threejs 3D 模型（适用于挤压模型，如城市建筑）。
      * @param {Array.<Object>} coordinates - 坐标点数组。
      * @param {number} amount - 高度。
      * @param {THREE.Material} material - Threejs 材质对象。参考：[THREE.Material]{@link https://threejs.org/docs/index.html#api/extras/core/Material}
@@ -117,7 +117,7 @@ export class ThreeLayer extends mapboxgl.Evented {
 
     /**
      * @function mapboxgl.supermap.ThreeLayer.prototype.addObject
-     * @description 设置threejs 3D对象的坐标（经纬度）。
+     * @description 设置threejs 3D 对象的坐标（经纬度）。
      * @param {THREE.Object3D} object3D - threejs 3D 对象。参考：[THREE.Object3D]{@link https://threejs.org/docs/index.html#api/core/Object3D}及子类对象。
      * @param {(Array.<number>|Object)} coordinate - 添加的 three 对象坐标（经纬度）。
      * @returns {this} this
@@ -149,7 +149,7 @@ export class ThreeLayer extends mapboxgl.Evented {
 
     /**
      * @function mapboxgl.supermap.ThreeLayer.prototype.getThreeRenderer
-     * @description 获取threejs renderer。
+     * @description 获取 threejs renderer。
      * @returns {THREE.WebGLRenderer|THREE.CanvasRenderer} threejs renderer。参考：
      *                      [THREE.WebGLRenderer]{@link https://threejs.org/docs/index.html#api/renderers/WebGLRenderer}/
      *                      [THREE.CanvasRenderer]{@link https://threejs.org/docs/index.html#examples/renderers/CanvasRenderer}
@@ -197,7 +197,7 @@ export class ThreeLayer extends mapboxgl.Evented {
 
     /**
      * @function mapboxgl.supermap.ThreeLayer.prototype.clearAll
-     * @description 清除所有threejs 对象。
+     * @description 清除所有 threejs 对象。
      * @param {boolean} clearCamera - 是否同时清除相机。
      * @returns {this} this 对象。
      */
@@ -220,7 +220,7 @@ export class ThreeLayer extends mapboxgl.Evented {
      * @description 设置 threejs 3D 对象的坐标（经纬度）。
      * @param {THREE.Object3D} object3D - threejs 3D 对象，参考：[THREE.Object3D]{@link https://threejs.org/docs/index.html#api/core/Object3D}及子类对象。
      * @param {(Array.<number>|Object)} coordinate - 添加的 three 对象坐标（经纬度）。
-     * @returns {this} this对象。
+     * @returns {this} this 对象。
      */
     setPosition(object3D, coordinate) {
         if (!object3D || !coordinate) {
@@ -235,7 +235,7 @@ export class ThreeLayer extends mapboxgl.Evented {
 
     /**
      * @function mapboxgl.supermap.ThreeLayer.prototype.lngLatToPosition
-     * @description 经纬度转threejs 3D失量对象。
+     * @description 经纬度转threejs 3D 失量对象。
      * @param {(Array.<number>|Object)} lngLat - 经纬度坐标。
      * @returns {THREE.Vector3} threejs 3D 失量对象。参考：[THREE.Vector3]{@link https://threejs.org/docs/index.html#api/math/Vector3}
      */
@@ -318,7 +318,7 @@ export class ThreeLayer extends mapboxgl.Evented {
      * @function mapboxgl.supermap.ThreeLayer.prototype.addTo
      * @description 添加图层到地图。
      * @param {Object} map - 地图对象。
-     * @returns {this} this对象。
+     * @returns {this} this 对象。
      */
     addTo(map) {
         var me = this;
@@ -339,7 +339,7 @@ export class ThreeLayer extends mapboxgl.Evented {
     /**
      * @function mapboxgl.supermap.ThreeLayer.prototype.getCanvasContainer
      * @description 获取 three 图层容器。
-     * @returns {HTMLElement} three图层的容器。
+     * @returns {HTMLElement} three 图层的容器。
      */
     getCanvasContainer() {
         return this.renderer.getCanvasContainer();
@@ -412,7 +412,7 @@ export class ThreeLayer extends mapboxgl.Evented {
 
     _update() {
         /**
-         * render事件，地图渲染时(地图状态改变时)触发。
+         * render 事件，地图渲染时(地图状态改变时)触发。
          * @event mapboxgl.supermap.ThreeLayer#render
          * @type {Object}
          * @property {string} type  - render

src/mapboxgl/overlay/UniqueTheme3DLayer.js

@@ -62,7 +62,7 @@ export class UniqueTheme3DLayer extends Theme3DLayer {
     /**
      * @function mapboxgl.supermap.UniqueTheme3DLayer.prototype.getHighlightStyleOptions
      * @description 获取高亮样式。
-     * @returns {Object} mapboxgl 样式对象。
+     * @returns {Object} Mapbox GL 样式对象。
      */
     getHighlightStyleOptions() {
         var color = (this.highlight && this.highlight.color != null) ? this.highlight.color : '#ADA91E';