[fix]文档注释修改 src：component control iportal review by jinny

Author: Wenxinyu1998

src/common/components/chart/ChartViewModel.js

@@ -8,7 +8,7 @@ import { Events } from '../../commontypes/Events';
  * @class ChartViewModel
  * @aliasclass Components.ChartViewModel
  * @deprecatedclass SuperMap.Components.ChartViewModel
- * @classdesc 图表组件功能类
+ * @classdesc 图表组件功能类。
  * @category Components Chart
  * @version 10.0.0
  * @param {Object} options - 可选参数。

src/common/components/util/FileReaderUtil.js

@@ -36,13 +36,13 @@ export let FileReaderUtil = {
     rAT: typeof FileReader !== 'undefined' && FileReader.prototype && FileReader.prototype.readAsText,
     /**
      * @function FileReaderUtil.prototype.readFile
-     * @description 读取文件
-     * @param {string} fileType - 当前读取的文件类型
+     * @description 读取文件。
+     * @param {string} fileType - 当前读取的文件类型。
      *
-     * @param {Object} file - 读取回来的文件内容对象
-     * @param {function} success - 读取文件成功回调函数
-     * @param {function} failed - 读取文件失败回调函数
-     * @param {Object} context - 回调重定向对象
+     * @param {Object} file - 读取回来的文件内容对象。
+     * @param {function} success - 读取文件成功回调函数。
+     * @param {function} failed - 读取文件失败回调函数。
+     * @param {Object} context - 回调重定向对象。
      */
     readFile(fileType, file, success, failed, context) {
         if (FileTypes.JSON === fileType || FileTypes.GEOJSON === fileType) {
@@ -53,11 +53,11 @@ export let FileReaderUtil = {
     },
 
     /**
-     * @description 读取文本文件
-     * @param {Object} file 文件内容对象
-     * @param {function} success 读取文件成功回调函数
-     * @param {function} failed 读取文件失败回调函数
-     * @param {Object} context - 回调重定向对象
+     * @description 读取文本文件。
+     * @param {Object} file 文件内容对象。
+     * @param {function} success 读取文件成功回调函数。
+     * @param {function} failed 读取文件失败回调函数。
+     * @param {Object} context - 回调重定向对象。
      */
     readTextFile(file, success, failed, context) {
         let reader = new FileReader();
@@ -71,11 +71,11 @@ export let FileReaderUtil = {
     },
 
     /**
-     * @description 读取excel或csv文件
-     * @param {Object} file 文件内容对象
-     * @param {function} success 读取文件成功回调函数
-     * @param {function} failed 读取文件失败回调函数
-     * @param {Object} context - 回调重定向对象
+     * @description 读取excel或csv文件。
+     * @param {Object} file 文件内容对象。
+     * @param {function} success 读取文件成功回调函数。
+     * @param {function} failed 读取文件失败回调函数。
+     * @param {Object} context - 回调重定向对象。
      */
     readXLSXFile(file, success, failed, context) {
         let reader = new FileReader();
@@ -101,13 +101,13 @@ export let FileReaderUtil = {
 
     /**
      * @function FileReaderUtil.prototype.processDataToGeoJson
-     * @description 将读取回来得数据统一处理为 GeoJSON 格式
-     * @param {string} type - 文件类型
-     * @param {Object} data - 读取返回的数据对象
-     * @param {function} success - 数据处理成功的回调
-     * @param {function} failed - 数据处理失败的回调
-     * @param {Object} context - 回调重定向对象
-     * @returns {GeoJSONObject} 返回标准 GeoJSON 规范格式数据
+     * @description 将读取回来得数据统一处理为 GeoJSON 格式。
+     * @param {string} type - 文件类型。
+     * @param {Object} data - 读取返回的数据对象。
+     * @param {function} success - 数据处理成功的回调。
+     * @param {function} failed - 数据处理失败的回调。
+     * @param {Object} context - 回调重定向对象。
+     * @returns {GeoJSONObject} 返回标准 GeoJSON 规范格式数据。
      * @private
      */
     processDataToGeoJson(type, data, success, failed, context) {
@@ -137,9 +137,9 @@ export let FileReaderUtil = {
     },
     /**
      * @function FileReaderUtil.prototype.processExcelDataToGeoJson
-     * @description 表格文件数据处理
-     * @param {Object} data - 读取的表格文件数据
-     * @returns {GeoJSONObject} 返回标准 GeoJSON 规范格式数据
+     * @description 表格文件数据处理。
+     * @param {Object} data - 读取的表格文件数据。
+     * @returns {GeoJSONObject} 返回标准 GeoJSON 规范格式数据。
      * @private
      */
     processExcelDataToGeoJson(data) {
@@ -187,8 +187,8 @@ export let FileReaderUtil = {
         return features;
     },
     /**
-     * @description 判断是否地理X坐标
-     * @param {string} data 字段名
+     * @description 判断是否地理X坐标。
+     * @param {string} data 字段名。
      */
     isXField(data) {
         var lowerdata = data.toLowerCase();
@@ -198,8 +198,8 @@ export let FileReaderUtil = {
     },
 
     /**
-     * @description 判断是否地理Y坐标
-     * @param {string} data 字段名
+     * @description 判断是否地理Y坐标。
+     * @param {string} data 字段名。
      */
     isYField(data) {
         var lowerdata = data.toLowerCase();
@@ -208,9 +208,9 @@ export let FileReaderUtil = {
             lowerdata === "latitude" || lowerdata === "lat" || lowerdata === "y坐标");
     },
     /**
-     * @description 字符串转为dataEditor 支持的csv格式数据
-     * @param {string} string 待转化的字符串
-     * @param {boolean} withoutTitle 是否需要列标题
+     * @description 字符串转为dataEditor 支持的csv格式数据。
+     * @param {string} string 待转化的字符串。
+     * @param {boolean} withoutTitle 是否需要列标题。
      */
     string2Csv(string, withoutTitle) {
         // let rows = string.split('\r\n');

src/common/control/TimeControlBase.js

@@ -6,7 +6,7 @@ import {Events} from '../commontypes/Events';
 /**
  * @class TimeControlBase
  * @deprecatedclass SuperMap.TimeControlBase
- * @classdesc 时间控制基类类。
+ * @classdesc 时间控制基类。
  * @category  Control
  * @param {Object} options - 可选参数。
  * @param {number} [options.speed=1] - 速度。不能小于 0，（每帧渲染的数据之间的间隔为1），设置越大速度越快。
@@ -28,7 +28,7 @@ export class TimeControlBase {
 
         /**
          * @member {number} [TimeControlBase.prototype.speed=1]
-         * @description 步长，必须为非负数，默认为1（表示前后两次渲染的数据之间的间隔为1）
+         * @description 步长，必须为非负数，默认为1（表示前后两次渲染的数据之间的间隔为1）。
          */
         this.speed = (options.speed && options.speed >= 0) ? options.speed : 1;
 
@@ -41,14 +41,14 @@ export class TimeControlBase {
         /**
          * @member {number} [TimeControlBase.prototype.startTime=0]
          * @description 记录的起始时间，必须为数字，
-         *              如果不设置，初始化时为0，建议设置
+         *              如果不设置，初始化时为0，建议设置。
          */
         this.startTime = (options.startTime && options.startTime != null) ? options.startTime : 0;
 
         /**
          * @member {number} TimeControlBase.prototype.endTime
          * @description 记录的结束时间，必须为数字，
-         *              如果不设置，初始化时以当前时间进行设置，建议设置
+         *              如果不设置，初始化时以当前时间进行设置，建议设置。
          */
         this.endTime = (options.endTime && options.endTime != null && options.endTime >= me.startTime) ? options.endTime : +new Date();
 
@@ -116,7 +116,7 @@ export class TimeControlBase {
     /**
      * @function TimeControlBase.prototype.updateOptions
      * @description 更新参数。
-     * @param {Object} options - 设置参数得可选参数。设置步长，刷新频率、开始结束时间、是否循环、是否反向。
+     * @param {Object} options - 设置参数的可选参数。设置步长，刷新频率、开始结束时间、是否循环、是否反向。
      */
     updateOptions(options) {
         //设置步长，刷新频率、开始结束时间、是否循环、是否反向
@@ -228,7 +228,7 @@ export class TimeControlBase {
     /**
      * @function TimeControlBase.prototype.getSpeed
      * @description 获取步长。
-     * @returns {number} 返回当前的步长
+     * @returns {number} 返回当前的步长。
      */
     getSpeed() {
         return this.speed;

src/common/control/TimeFlowControl.js

@@ -9,7 +9,7 @@ import {TimeControlBase} from './TimeControlBase';
  * @category  Control
  * @classdesc 时间管理类。此类只负责时间上的控制，具体执行的操作需要用户在初始化时的回调函数内部进行实现。
  * 如设置起始时间为 1000，结束时间是 2000，步长设置为 1，
- * 那么表示按照每次1年（可以通过 setSpeed 进行修改）的变化从公元 1000 年开始到公元 2000 年为止，默认每 1 秒会 1 次（通过 setFrequency 修改）
+ * 那么表示按照每次1年（可以通过 setSpeed 进行修改）的变化从公元 1000 年开始到公元 2000 年为止，默认每 1 秒会变化 1 次（通过 setFrequency 修改）
  * @extends {TimeControlBase}
  * @param {function} callback - 每次刷新回调函数。具体的效果需要用户在此回调函数里面实现。
  * @param {Object} options - 可选参数。

src/common/format/WKT.js

@@ -280,7 +280,7 @@ export class WKT extends Format {
 
     /**
      * @function WKTFormat.prototype.read
-     * @description 反序列化 WKT 字符串并返回向量特征或向量特征数组。 支持 POINT、MULTIPOINT、LINESTRING、MULTILINESTRING、POLYGON、MULTIPOLYGON 和 GEOMETRYCOLLECTION 的 WKT。
+     * @description 反序列化 WKT 字符串并返回向量特征或向量特征数组。支持 POINT、MULTIPOINT、LINESTRING、MULTILINESTRING、POLYGON、MULTIPOLYGON 和 GEOMETRYCOLLECTION 的 WKT。
      * @param {string} wkt - WKT 字符串。
      * @returns {FeatureVector|Array} GEOMETRYCOLLECTION WKT 的矢量要素或者矢量要素数组。
      */

src/common/iPortal/iPortalAddDataParam.js

@@ -11,10 +11,10 @@
   * @version 10.0.1
   * @category iPortal/Online Resources Data
   * @param {Object} params - 参数。
-  * @param {string} params.fileName - 文件名称
+  * @param {string} params.fileName - 文件名称。
   * @param {DataItemType} params.type - 数据类型。
-  * @param {Array} [params.tags] - 数据的标签
-  * @param {IPortalDataMetaInfoParam} [params.dataMetaInfo] - 数据元信息
+  * @param {Array} [params.tags] - 数据的标签。
+  * @param {IPortalDataMetaInfoParam} [params.dataMetaInfo] - 数据元信息。
   * @usage
   */
  export class IPortalAddDataParam {

src/common/iPortal/iPortalAddResourceParam.js

@@ -13,7 +13,7 @@
   * @param {Object} params - 可选参数。
   * @param {string} [params.rootUrl] - 服务地址。
   * @param {Array} [params.tags] - 标签。
-  * @param {IPortalShareEntity} [params.entities] - 资源的实体共享参数
+  * @param {IPortalShareEntity} [params.entities] - 资源的实体共享参数。
   * @usage
   */
  export class IPortalAddResourceParam {

src/common/iPortal/iPortalDataMetaInfoParam.js

@@ -11,15 +11,15 @@
   * @version 10.0.1
   * @category iPortal/Online Resources Data
   * @param {Object} params - 参数。
-  * @param {string} params.xField - X 坐标字段
-  * @param {string} params.yField - Y 坐标字段
-  * @param {number} params.xIndex - x所在列（关系型存储下CSV或EXCEL数据时必填）
-  * @param {number} params.yIndex - y所在列（关系型存储下CSV或EXCEL数据时必填）
+  * @param {string} params.xField - X 坐标字段。
+  * @param {string} params.yField - Y 坐标字段。
+  * @param {number} params.xIndex - x所在列（关系型存储下CSV或EXCEL数据时必填）。
+  * @param {number} params.yIndex - y所在列（关系型存储下CSV或EXCEL数据时必填）。
   * @param {Array.<string>} [params.fieldTypes] - 设置字段类型（关系型存储下CSV或EXCEL数据时可选填）。默认类型为：WTEXT。该参数按照CSV文件字段顺序从左到右依次设置，其中默认字段类型可省略不设置。例如，CSV文件中有10个字段，如果只需设定第1，2，4个字段，可设置为['a','b',,'c']。
-  * @param {string} params.separator - 分隔符（关系型存储下CSV数据时必填）
-  * @param {boolean} params.firstRowIsHead - 是否带表头（关系型存储下CSV数据时必填）
-  * @param {boolean} params.url - HDFS注册目录地址
-  * @param {IPortalDataStoreInfoParam} params.dataStoreInfo - 注册数据时的数据存储信息
+  * @param {string} params.separator - 分隔符（关系型存储下CSV数据时必填）。
+  * @param {boolean} params.firstRowIsHead - 是否带表头（关系型存储下CSV数据时必填）。
+  * @param {boolean} params.url - HDFS注册目录地址。
+  * @param {IPortalDataStoreInfoParam} params.dataStoreInfo - 注册数据时的数据存储信息。
   * @usage
   */
  export class IPortalDataMetaInfoParam {

src/common/iPortal/iPortalDataStoreInfoParam.js

@@ -11,9 +11,9 @@
   * @version 10.0.1
   * @category iPortal/Online Resources Data
   * @param {Object} params - 参数。
-  * @param {string} params.type - 大数据文件共享类型和空间数据库类型，包括大数据文件共享HDFS 目录(HDFS)和空间数据库HBASE
-  * @param {string} params.url - HDFS数据存储目录地址
-  * @param {IPortalDataConnectionInfoParam} [params.connectionInfo] - HBASE空间数据库服务的连接信息
+  * @param {string} params.type - 大数据文件共享类型和空间数据库类型，包括大数据文件共享HDFS 目录(HDFS)和空间数据库HBASE。
+  * @param {string} params.url - HDFS数据存储目录地址。
+  * @param {IPortalDataConnectionInfoParam} [params.connectionInfo] - HBASE空间数据库服务的连接信息。
   * @usage
   */
  export class IPortalDataStoreInfoParam {

src/common/iPortal/iPortalQueryParam.js

@@ -11,14 +11,14 @@ import {Util} from '../commontypes/Util';
  * @version 10.0.1
  * @category iPortal/Online Resources ResourcesQuery
  * @param {Object} params - 可选参数。
- * @param {ResourceType} [params.resourceType] - 资源类型
+ * @param {ResourceType} [params.resourceType] - 资源类型。
  * @param {number} [params.pageSize] - 分页中每页大小。
  * @param {number} [params.currentPage] - 分页页码。
  * @param {OrderBy} [params.orderBy] - 排序字段。
  * @param {OrderType} [params.orderType] - 根据升序还是降序过滤。
  * @param {SearchType} [params.searchType] - 根据查询的范围进行过滤。
  * @param {Array} [params.tags] - 标签。
- * @param {Array} [params.dirIds] - 目录 id
+ * @param {Array} [params.dirIds] - 目录 ID。
  * @param {Array} [params.resourceSubTypes] - 根据资源的子类型进行过滤。
  * @param {AggregationTypes} [params.aggregationTypes] - 聚合查询的类型。
  * @param {string} [params.text] - 	搜索的关键词。