【doc】优化doc

Author: songyumeng

src/classic/services/DatasetService.js

@@ -33,7 +33,7 @@ export class DatasetService extends CommonServiceBase {
 
     /**
      * @function SuperMap.REST.DatasetService.prototype.getDatasets
-     * @description 数据集集合查询服务。
+     * @description 根据数据源名称查询该数据源下所有数据集的信息。
      * @example
      *   new SuperMap.REST.DatasetService(url).getDatasets(datasourceName,function(result){
      *     //doSomething
@@ -51,7 +51,7 @@ export class DatasetService extends CommonServiceBase {
 
     /**
      * @function SuperMap.REST.DatasetService.prototype.getDataset
-     * @description 数据集信息查询服务。
+     * @description 根据数据源名称、数据集名称查询该数据集的信息。
      * @example
      *   new SuperMap.REST.DatasetService(url).getDataset(datasourceName, datasetName, function(result){
      *     //doSomething

src/classic/services/DatasourceService.js

@@ -33,7 +33,7 @@ export class DatasourceService extends CommonServiceBase {
 
     /**
      * @function SuperMap.REST.DatasourceService.prototype.getDatasources
-     * @description 数据源集合查询服务。
+     * @description 获取当前服务下所有数据源信息。
      * @example
      *   new SuperMap.REST.DatasourceService(url).getDatasources(function(result){
      *     //doSomething
@@ -47,7 +47,7 @@ export class DatasourceService extends CommonServiceBase {
 
     /**
      * @function SuperMap.REST.DatasourceService.prototype.getDatasource
-     * @description 数据源信息查询服务。
+     * @description 根据数据源名称获取指定数据源的信息。
      * @example
      *   new SuperMap.REST.DatasourceService(url).getDatasource(datasourceName,function(result){
      *     //doSomething

src/common/iServer/DataFlowService.js

@@ -16,8 +16,8 @@ import {SecurityManager} from '../security/SecurityManager';
  * @param {Object} options - 参数。
  * @param {function} options.style - 设置数据加载样式。
  * @param {function} [options.onEachFeature] - 设置每个数据加载 popup 等。
- * @param {GeoJSONObject} [options.geometry] - 指定几何范围，只有在该范围内的要素才能被订阅。
- * @param {Object} [options.excludeField] - 排除字段。
+ * @param {GeoJSONObject} [options.geometry] - 空间范围，只有在该范围内的要素才能被接收。
+ * @param {Object} [options.excludeField] - 过滤字段。传入此参数，接收到的信息将不包含过滤掉的字段。
  * @param {boolean} [options.crossOrigin] - 是否允许跨域请求。
  * @param {Object} [options.headers] - 请求头。
  * @usage
@@ -37,7 +37,7 @@ export class DataFlowService extends CommonServiceBase {
 
         /**
          * @member {GeoJSONObject} DataFlowService.prototype.geometry
-         * @description 指定几何范围，只有在该范围内的要素才能被订阅。
+         * @description 空间范围，只有在该范围内的要素才能被接收。
          */
         this.geometry = null;
 
@@ -49,7 +49,7 @@ export class DataFlowService extends CommonServiceBase {
 
         /**
          * @member {Object} DataFlowService.prototype.excludeField
-         * @description 排除字段。
+         * @description 过滤字段。传入此参数，接收到的信息将不包含过滤掉的字段。
          */
         this.excludeField = null;
 
@@ -129,8 +129,8 @@ export class DataFlowService extends CommonServiceBase {
 
     /**
      * @function DataFlowService.prototype.setExcludeField
-     * @description 设置排除字段。
-     * @param {Object} excludeField - 排除字段。
+     * @description 设置过滤字段。传入此参数，接收到的信息将不包含过滤掉的字段。
+     * @param {Object} excludeField - 过滤字段。
      * @returns {DataFlowService} DataFlowService 的实例对象。
      */
     setExcludeField(excludeField) {
@@ -141,8 +141,8 @@ export class DataFlowService extends CommonServiceBase {
 
     /**
      * @function DataFlowService.prototype.setGeometry
-     * @description 设置添加的几何要素数据。
-     * @param {GeoJSONObject} geometry - 指定几何范围，只有在该范围内的要素才能被订阅。
+     * @description 设置空间范围，只有在该范围内的要素才能被接收。
+     * @param {GeoJSONObject} geometry - 空间范围。
      * @returns {DataFlowService} DataFlowService 的实例对象。
      */
     setGeometry(geometry) {

src/common/iServer/Route.js

@@ -19,7 +19,6 @@ import {Collection} from '../commontypes/geometry/Collection';
  * @param {number} options.length - 路由对象的长度。单位与数据集的单位相同。
  * @param {number} [options.maxM] - 最大线性度量值，即所有结点到起始点的量算距离中最大值。
  * @param {number} [options.minM] - 最小线性度量值，即所有结点到起始点的量算距离中最小值。
- * @param {string} [options.type] - 数据类型，如："LINEM"。
  * @extends GeometryCollection
  * @usage
  */
@@ -95,7 +94,7 @@ export class Route extends Collection {
          * @member {string} Route.prototype.type
          * @description 服务端几何对象类型。
          */
-        this.type = null;
+        this.type = "LINEM";
 
         /**
          * @member {Array.<string>} [Route.prototype.componentTypes=LineString]

src/leaflet/mapping/TiledMapLayer.js

@@ -37,7 +37,7 @@ import Attributions from '../core/Attributions';
  * @param {(number|L.Point)} [options.tileSize=256] - 瓦片大小。
  * @param {(NDVIParameter|HillshadeParameter)} [options.rasterfunction] - 栅格分析参数。
  * @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 {Array.<number>} [options.subdomains] - 子域名数组。
+ * @param {Array.<number>|Array.<string>} [options.subdomains] - 子域名数组。
  * @param {ChartSettingS57|ChartSettingS100} [options.chartSetting] - 海图显示参数设置类，用于管理海图显示环境，包括海图的显示模式、显示类型名称、颜色模式、安全水深线等各种显示风格。
  * @param {number} [options.overflowTiles = 0] - 绘制超出图层范围的瓦片圈数。常用于位于地图边缘的要素符号显示不全的场景。默认值为0，表示不绘制超出图层范围的瓦片。当 options.noWrap 为 true 时，overflowTiles有效。
  * @fires TiledMapLayer#tilesetsinfoloaded

src/leaflet/overlay/DataFlowLayer.js

@@ -23,15 +23,15 @@ import {
  * @param {Object} options - 参数。
  * @param {Object} [options.render='normal'] - 绘制方式。可选值为 'normal'，'mapv'。
  'normal' 表示以 {( {@link L.LatLng}|{@link L.Polyline}|{@link L.Polygon}|{@link L.Marker} )} 方式绘制数据流。'mapv' 表示以 {@link MapVLayer} 方式绘制实时数据。
- * @param {GeoJSONObject} [options.geometry] - 指定几何范围，只有在该范围内的要素才能被订阅。
+ * @param {GeoJSONObject} [options.geometry] - 空间范围，只有在该范围内的要素才能被接收。
  * @param {Object} [options.prjCoordSys] - 投影坐标对象。
- * @param {string} [options.excludeField] - 排除字段。
+ * @param {string} [options.excludeField] - 过滤字段。传入此参数，接收到的信息将不包含过滤掉的字段。
  * @param {string} [options.idField='id'] - 要素属性中表示唯一标识的字段。
- * @param {function} [options.pointToLayer] - 定义点要素如何绘制在地图上。
+ * @param {function} [options.pointToLayer] - 定义点要素如何绘制在地图上的函数。当接收到数据时，内部会调用此函数，并传递 GeoJSON 点要素及其经纬度坐标。
  `function(geoJsonPoint, latlng) {
                                                 return L.marker(latlng);
                                             }`
- * @param {function} [options.style] - 定义点、线、面要素样式。参数为{@link L.Path-option}。</br>
+ * @param {function} [options.style] - 定义点、线、面要素样式的函数。返回参数为{@link L.Path-option}。当接收到数据时，内部会调用此函数，并传递 GeoJSON 要素</br>
  `function (feature) {
                                                     return {
                                                         fillColor: "red",
@@ -121,8 +121,8 @@ export var DataFlowLayer = L.LayerGroup.extend({
   },
   /**
    * @function DataFlowLayer.prototype.setExcludeField
-   * @description 设置唯一字段。
-   * @param {string} excludeField - 唯一字段。
+   * @description 设置过滤字段。传入此参数，接收到的信息将不包含过滤掉的字段。
+   * @param {string} excludeField - 过滤字段。
    */
   setExcludeField: function (excludeField) {
     this.dataService.setExcludeField(excludeField);

src/leaflet/overlay/GraphThemeLayer.js

@@ -24,11 +24,8 @@
  * @param {boolean} [options.isOverLay=true] - 是否进行压盖处理，如果设为 true，图表绘制过程中将隐藏对已在图层中绘制的图表产生压盖的图表。
  * @param {string} options.themeFields - 指定创建专题图字段。
  * @param {boolean} [options.alwaysMapCRS=false] - 要素坐标是否和地图坐标系一致，要素默认是经纬度坐标。
- * @param {Object} [options.cache] - 缓存。
- * @param {Object} [options.charts] - 图表。
  * @param {string} [options.id] - 专题图层 ID。默认使用 CommonUtil.createUniqueID("themeLayer_") 创建专题图层 ID。
  * @param {number} [options.opacity=1] - 图层不透明度。
- * @param {Array} [options.TFEvents] - 专题要素事件临时存储。
  * @param {Object} options.chartsSetting - 各类型图表的 chartsSetting 对象可设属性请参考具体图表模型类的注释中对 chartsSetting 对象可设属性的描述。chartsSetting 对象通常都具有以下可设的基础属性:</br>
  * @param {number} options.chartsSetting.width - 专题要素（图表）宽度，单位为像素。
  * @param {number} options.chartsSetting.height - 专题要素（图表）高度，单位为像素。

src/leaflet/overlay/LabelThemeLayer.js

@@ -24,7 +24,6 @@
  * @param {boolean} [options.alwaysMapCRS=false] - 要素坐标是否和地图坐标系一致，要素默认是经纬度坐标。
  * @param {boolean} [options.isOverLay=true] - 是否进行压盖处理，如果设为 true，图表绘制过程中将隐藏对已在图层中绘制的图表产生压盖的图表。
  * @param {number} [options.opacity=1] - 图层不透明度。
- * @param {Array} [options.TFEvents] - 专题要素事件临时存储。
  * @param {number} [options.nodesClipPixel=2] - 节点抽稀像素距离。
  * @param {boolean} [options.isHoverAble=false] -  图形是否在 hover 时高亮。
  * @param {boolean} [options.isMultiHover=false] - 是否多图形同时高亮，用于高亮同一个数据对应的所有图形（如：多面）。

src/leaflet/overlay/RangeThemeLayer.js

@@ -19,7 +19,6 @@ import { Util as CommonUtil } from '@supermapgis/iclient-common/commontypes/Util
  * @param {number} [options.opacity=1] - 图层不透明度。
  * @param {boolean} [options.alwaysMapCRS=false] - 要素坐标是否和地图坐标系一致，要素默认是经纬度坐标。
  * @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 {Array} [options.TFEvents] - 专题要素事件临时存储。
  * @param {number} [options.nodesClipPixel=2] - 节点抽稀像素距离。
  * @param {boolean} [options.isHoverAble=false] - 图形是否在 hover 时高亮。
  * @param {boolean} [options.isMultiHover=false] - 是否多图形同时高亮，用于高亮同一个数据对应的所有图形（如：多面）。

src/leaflet/overlay/RankSymbolThemeLayer.js

@@ -25,7 +25,6 @@ import {
  * @param {boolean} [options.alwaysMapCRS=false] - 要素坐标是否和地图坐标系一致，要素默认是经纬度坐标。
  * @param {string} [options.id] - 专题图层 ID。默认使用 CommonUtil.createUniqueID("themeLayer_") 创建专题图层 ID。
  * @param {number} [options.opacity=1] - 图层不透明度。
- * @param {Array} [options.TFEvents] - 专题要素事件临时存储。
  * @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>'] - 版权描述信息。
  * @usage
  */