【fix】补充API的介绍说明 review by jinny

Author: Wenxinyu1998

src/classic/overlay/MapVLayer.js

@@ -7,7 +7,10 @@ import { MapVRenderer } from './mapv/MapVRenderer';
 /**
  * @class SuperMap.Layer.MapVLayer
  * @category  Visualization MapV
- * @classdesc MapV 图层类。
+ * @classdesc MapV 图层类。MapV 是一款地理信息可视化开源库，MapV 图层可以用来展示大量地理信息数据，点、线、面的数据，每种数据也有不同的展示类型，如直接打点、热力图、网格、聚合等方式展示数据。<br>
+ * 展示大量的点数据：如热力图、网格、蜂窝状、点聚合、按颜色区间、按半径大小等方式。<br>
+ * 展示大量的线数据：如普通画线、高亮叠加、热力线数据展示等方式，适合展示大量轨迹的场景。<br>
+ * 展示大量的自定义面数据：按颜色区间来展示，如展示行政区划数据。
  * @modulecategory Overlay
  * @extends {SuperMap.Layer}
  * @param {string} name - 图层名。

src/classic/services/AddressMatchService.js

@@ -8,7 +8,7 @@ import { AddressMatchService as CommonAddressMatchService } from '@supermap/icli
 /**
  * @class SuperMap.REST.AddressMatchService
  * @category  iServer AddressMatch
- * @classdesc 地址匹配服务类。包括正向匹配和反向匹配。
+ * @classdesc 地址匹配服务类。此类提供了地址的正向匹配和反向匹配功能，正向匹配即通过地点名称关键词查找地址位置坐标，反向匹配即根据位置坐标查询地点。
  * @modulecategory Services
  * @extends {CommonServiceBase}
  * @param {string} url - 服务地址。
@@ -25,7 +25,7 @@ export class AddressMatchService extends CommonServiceBase {
 
     /**
      * @function SuperMap.REST.AddressMatchService.prototype.code
-     * @description 正向匹配。
+     * @description 正向匹配，即通过地点名称关键词查找地址位置坐标。
      * @param {GeoCodingParameter} params - 正向匹配参数。
      * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @returns {Promise} Promise 对象。
@@ -43,7 +43,7 @@ export class AddressMatchService extends CommonServiceBase {
 
     /**
      * @function SuperMap.REST.AddressMatchService.prototype.decode
-     * @description 反向匹配。
+     * @description 反向匹配，即根据地址位置坐标查询地点。
      * @param {GeoDecodingParameter} params - 反向匹配参数。
      * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @returns {Promise} Promise 对象。

src/classic/services/DatasetService.js

@@ -10,7 +10,7 @@ import { UpdateDatasetParameters } from '@supermap/iclient-common/iServer/Update
 /**
  * @class SuperMap.REST.DatasetService
  * @category  iServer Data Dataset
- * @classdesc 数据集信息服务。
+ * @classdesc 数据集信息服务类。提供方法：查询数据集集合、查询指定数据集信息，在指定数据源下新增、修改、删除数据集等。
  * @extends {CommonServiceBase}
  * @param {string} url - 服务地址。
  * @param {Object} options - 参数。
@@ -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

@@ -9,7 +9,8 @@ import { SetDatasourceParameters } from '@supermap/iclient-common/iServer/SetDat
 /**
  * @class SuperMap.REST.DatasourceService
  * @category  iServer Data Datasource
- * @classdesc 数据源服务类。
+ * @classdesc 数据源服务类。提供方法：查询数据源集合、查询指定数据源信息、设置指定数据源信息。
+ * 可以获取的数据源信息包括数据源名称、数据源描述、引擎类型、距离单位、坐标单位、投影信息等。
  * @extends {CommonServiceBase}
  * @param {string} url - 服务地址。
  * @param {Object} options - 参数。
@@ -32,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

src/classic/services/ProcessingService.js

@@ -7,7 +7,9 @@ import { ProcessingService as CommonProcessingService } from '@supermap/iclient-
 /**
  * @class SuperMap.REST.ProcessingService
  * @category  iServer ProcessingService
- * @classdesc 分布式分析相关服务类。
+ * @classdesc 分布式分析相关服务类。分布式分析服务采用了分布式计算技术，可对超大体量空间数据集进行分布式空间分析和数据处理。
+ * 提供方法：缓冲区分析任务、核密度分析任务、叠加分析任务、单对象空间查询任务、点聚合分析任务、区域汇总分析任务、
+ * 拓扑检查分析任务、矢量裁剪分析任务等。
  * @modulecategory Services
  * @augments CommonServiceBase
  * @example
@@ -38,7 +40,7 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.getKernelDensityJob
-     * @description 获取某一个密度分析。
+     * @description 获取指定 ID 的密度分析。
      * @param {string} id - 空间分析的 ID。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
@@ -50,8 +52,13 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.addKernelDensityJob
-     * @description 密度分析。
-     * @param {KernelDensityJobParameter} params - 核密度分析服务参数类。
+     * @description 新建密度分析。目前提供 1 种密度分析方法：核密度分析。<br>
+     * 核密度分析是指使用核函数来计算点或线邻域范围内的每单位面积量值。
+     * 其结果是中间值大周边值小的光滑曲面，在邻域边界处降为0。
+     * 对于点对象，其核密度曲面与下方的平面所围成的空间的体积近似于此点的测量值；
+     * 对于线对象，其核密度曲面与下方的平面所围成的空间的体积近似于此线的测量值与线长度的乘积。
+     * 点或线的邻域叠加处，其密度值也相加。每个输出栅格的密度均为叠加在栅格上的所有核曲面值之和。 
+     * @param {KernelDensityJobParameter} params - 核密度分析任务参数类。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {number} [seconds=1000] - 获取创建成功结果的时间间隔。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
@@ -85,7 +92,7 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.getSummaryMeshJob
-     * @description 获取点聚合分析。
+     * @description 获取指定 ID 的点聚合分析。
      * @param {string} id - 点聚合分析的 ID。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
@@ -97,7 +104,11 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.addSummaryMeshJob
-     * @description 点聚合分析。
+     * @description 新建点聚合分析。<br>
+     * 点聚合分析是指针对点数据集制作聚合图的一种空间分析作业。通过网格面或多边形对地图点要素进行划分，
+     * 然后，计算每个面对象内点要素的数量，并作为面对象的统计值，也可以引入点的权重信息，
+     * 考虑面对象内点的加权值作为面对象的统计值；最后基于面对象的统计值，按照统计值大小排序的结果，
+     * 通过色带对面对象进行色彩填充。
      * @param {SummaryMeshJobParameter} params - 点聚合分析任务参数类。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {number} [seconds=1000] - 获取创建成功结果的时间间隔。
@@ -121,7 +132,7 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.getQueryJobs
-     * @description 获取单对象查询分析的列表。
+     * @description 获取单对象空间查询分析的列表。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
      * @returns {Promise} Promise 对象。
@@ -132,8 +143,8 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.getQueryJob
-     * @description 获取单对象查询分析。
-     * @param {string} id - 单对象查询分析的 ID。
+     * @description 获取指定 ID 的单对象空间查询分析。
+     * @param {string} id - 单对象空间查询分析的 ID。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
      * @returns {Promise} Promise 对象。
@@ -144,7 +155,9 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.addQueryJob
-     * @description 单对象查询分析。
+     * @description 新建单对象空间查询分析。<br>
+     * 单对象空间查询，指的是只支持查询对象数据集中有一个对象对被查询数据集做空间查询。
+     * 如果查询对象数据集中有多个对象，则默认用 SmID 最小的对象对被查询数据集做空间查询。
      * @param {SingleObjectQueryJobsParameter} params - 单对象空间查询分析任务参数类。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {number} [seconds=1000] - 获取创建成功结果的时间间隔。
@@ -158,9 +171,9 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.getQueryJobState
-     * @description 获取单对象查询分析的状态。
-     * @param {string} id - 单对象查询分析的 ID。
-     * @returns {Object} 单对象查询分析的状态。
+     * @description 获取单对象空间查询分析的状态。
+     * @param {string} id - 单对象空间查询分析的 ID。
+     * @returns {Object} 单对象空间查询分析的状态。
      */
     getQueryJobState(id) {
       return this._processingService.getQueryJobState(id)
@@ -179,7 +192,7 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.getSummaryRegionJob
-     * @description 获取某一个区域汇总分析。
+     * @description 获取指定 ID 的区域汇总分析。
      * @param {string} id - 区域汇总分析的 ID。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
@@ -191,7 +204,10 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.addSummaryRegionJob
-     * @description 新建一个区域汇总分析。
+     * @description 新建区域汇总分析。<br>
+     * 区域汇总分析是指针对线数据集和面数据集制作聚合图的一种空间分析作业。
+     * 通过网格面或多边形对地图线或面要素进行划分，然后，以标准属性字段或权重字段对每个网格单元内线或面要素进行统计，
+     * 将统计结果作为该网格单元的统计值。最后按照网格单元统计值的大小进行排序，通过色带对网格单元进行色彩填充。
      * @param {SummaryRegionJobParameter} params -创建一个区域汇总分析的请求参数。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {number} [seconds=1000] - 开始创建后，获取创建成功结果的时间间隔。
@@ -226,7 +242,7 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.getVectorClipJob
-     * @description 获取矢量裁剪分析。
+     * @description 获取指定 ID 的矢量裁剪分析。
      * @param {string} id - 矢量裁剪分析的 ID。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
@@ -238,7 +254,10 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.addVectorClipJob
-     * @description 矢量裁剪分析。
+     * @description 新建矢量裁剪分析。<br>
+     * 矢量裁剪是指对矢量数据集进行裁剪，包括内部裁剪和外部裁剪。
+     * 内部裁剪，则被裁剪的矢量数据集在裁剪区范围内的部分被保留到结果数据集中；
+     * 外部裁剪，则保留不在裁剪区范围内的那部分数据到结果数据集中。
      * @param {VectorClipJobsParameter} params - 矢量裁剪分析任务参数类。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {number} [seconds=1000] - 获取创建成功结果的时间间隔。
@@ -273,7 +292,7 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.getOverlayGeoJob
-     * @description 获取叠加分析。
+     * @description 获取指定 ID 的叠加分析。
      * @param {string} id - 叠加分析的 ID。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
@@ -285,7 +304,10 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.addOverlayGeoJob
-     * @description 叠加分析。
+     * @description 新建叠加分析。<br>
+     * 叠加分析是在统一空间参考系统下，通过对两个数据集进行的一系列集合运算，产生新数据集的过程。
+     * 在叠加分析中至少涉及到三个数据集，其中一个数据集的类型可以是点、线、面等，被称作源数据集；
+     * 另一个数据集是面数据集，被称作叠加对象数据集；还有一个数据集就是叠加结果数据集，包含叠加后数据的几何信息和属性信息。
      * @param {OverlayGeoJobParameter} params - 叠加分析任务参数类。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {number} [seconds=1000] - 获取创建成功结果的时间间隔。
@@ -320,7 +342,7 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.getBuffersJob
-     * @description 获取缓冲区分析。
+     * @description 获取指定 ID 的缓冲区分析。
      * @param {string} id - 缓冲区分析的 ID。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
@@ -332,7 +354,9 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.addBuffersJob
-     * @description 缓冲区分析。
+     * @description 新建缓冲区分析。<br>
+     * 缓冲区分析是围绕空间对象，使用与空间对象的距离值（称为缓冲半径）作为半径，生成该对象的缓冲区域的过程，
+     * 其中缓冲半径可以是固定数值也可以是空间对象各自的属性值。缓冲区也可以理解为空间对象的影响或服务范围。
      * @param {BuffersAnalystJobsParameter} params - 创建一个缓冲区分析的请求参数。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {number} [seconds=1000] - 获取创建成功结果的时间间隔。
@@ -367,7 +391,7 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.getTopologyValidatorJob
-     * @description 获取拓扑检查分析。
+     * @description 获取指定 ID 的拓扑检查分析。
      * @param {string} id - 拓扑检查分析的 ID。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
@@ -379,7 +403,10 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.addTopologyValidatorJob
-     * @description 拓扑检查分析。
+     * @description 新建拓扑检查分析。<br>
+     * 拓扑检查是指根据相应的拓扑规则对点、线和面数据进行检查，返回不符合规则的对象的一种操作作业。
+     * 支持以下种拓扑规则:面数据集内部无交叠、面数据集和面数据集无交叠、面数据集被面数据集包含、
+     * 面数据集被面数据集覆盖、线数据集内部无交叠、线数据集与线数据集无交叠、点数据集内部无重复点。
      * @param {TopologyValidatorJobsParameter} params - 拓扑检查分析任务参数类。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {number} [seconds=1000] - 获取创建成功结果的时间间隔。
@@ -414,7 +441,7 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.getSummaryAttributesJob
-     * @description 获取属性汇总分析。
+     * @description 获取指定 ID 的属性汇总分析。
      * @param {string} id - 属性汇总分析的 ID。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回结果类型。
@@ -426,7 +453,9 @@ export class ProcessingService {
 
     /**
      * @function SuperMap.REST.ProcessingService.prototype.addSummaryAttributesJob
-     * @description 属性汇总分析。
+     * @description 新建属性汇总分析。<br>
+     * 属性汇总分析是指对输入的数据集中所选择的属性进行汇总统计。
+     * 通过对输入的数据集设定分组字段、属性字段以及对属性字段需进行的统计模式，从而得到汇总统计的结果。
      * @param {SummaryAttributesJobsParameter} params - 属性汇总分析任务参数类。
      * @param {function} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
      * @param {number} [seconds=1000] - 获取创建成功结果的时间间隔。