【fix】优化部分API参数、方法描述 review by xiongjj

Author: Wenxinyu1998

skills/mapboxgl/modules/services/feature-service.md

@@ -1,6 +1,6 @@
 ---
 name: "FeatureService"
-description: "要素数据集服务（REST Data）— 提供ID查询、范围查询、SQL查询、几何查询、缓冲区查询、地物编辑"
+description: "要素数据集服务（REST Data）— 提供 ID 查询、范围查询、SQL查询、空间查询、缓冲区查询、地物编辑"
 ---
 
 # FeatureService - 要素数据集服务
@@ -35,7 +35,7 @@ new mapboxgl.supermap.FeatureService(url, options)
 |------|------|
 | `getFeaturesBySQL(params)` | SQL 查询 |
 | `getFeaturesByBounds(params)` | 范围查询 |
-| `getFeaturesByGeometry(params)` | 几何查询 |
+| `getFeaturesByGeometry(params)` | 空间查询 |
 | `getFeaturesByBuffer(params)` | 缓冲区查询 |
 | `getFeaturesByIDs(params)` | ID 查询 |
 | `getFeaturesCount(params)` | 获取要素数量（v11.2.0+） |
@@ -109,7 +109,7 @@ mapboxgl.supermap.initMap('http://host:8090/iserver/services/map-world/rest/maps
 });
 ```
 
-## 几何查询 - getFeaturesByGeometry
+## 空间查询 - getFeaturesByGeometry
 
 ### 使用场景
 - 查询与几何对象相交、包含或被包含的要素

skills/mapboxgl/modules/services/query-service.md

@@ -1,6 +1,6 @@
 ---
 name: "QueryService"
-description: "地图查询服务类（REST Map）— 提供范围查询、SQL查询、几何查询、距离查询"
+description: "地图查询服务类（REST Map）— 提供范围查询、SQL 查询、空间查询、距离查询"
 ---
 
 # QueryService - 地图查询服务
@@ -34,7 +34,7 @@ new mapboxgl.supermap.QueryService(url, options)
 |------|------|
 | `queryBySQL(params)` | SQL 查询 |
 | `queryByBounds(params)` | 范围查询 |
-| `queryByGeometry(params)` | 几何查询 |
+| `queryByGeometry(params)` | 空间查询 |
 | `queryByDistance(params)` | 距离查询 |
 
 ## 返回格式
@@ -129,7 +129,7 @@ new mapboxgl.supermap.QueryService(mapUrl)
     });
 ```
 
-## 几何查询 - queryByGeometry
+## 空间查询 - queryByGeometry
 
 ```javascript
 var geomParams = new mapboxgl.supermap.QueryByGeometryParameters({

src/common/REST.js

@@ -1650,9 +1650,9 @@ var ChartType = {
  * ```
  */
 var ClipAnalystMode = {
-    /** 裁剪分析操作。 */
+    /** 内部裁剪，保留落在裁剪区范围内的数据。 */
     CLIP: "clip",
-    /** 求交分析操作。 */
+    /** 外部裁剪，保留落在裁剪区范围外的数据。 */
     INTERSECT: "intersect"
 };
 

src/common/iServer/BuffersAnalystJobsParameter.js

@@ -14,7 +14,7 @@ import { MappingParameters } from './MappingParameters';
  * 还可以对分析结果的输出参数、可视化参数进行一系列设置。
  * @param {Object} options - 参数。
  * @param {string} options.datasetName - 数据集名称。
- * @param {ModuleBounds} [options.bounds] - 缓冲区分析范围（默认为全图范围）。
+ * @param {ModuleBounds} [options.bounds] - 缓冲区分析范围，默认为全图范围。
  * @param {string} [options.distance='15'] - 缓冲距离，或缓冲区半径。
  * @param {string} [options.distanceField='pickup_latitude'] - 缓冲区分析距离字段。
  * @param {AnalystSizeUnit} [options.distanceUnit=AnalystSizeUnit.METER] - 缓冲距离单位。

src/common/iServer/DatasetOverlayAnalystParameters.js

@@ -18,12 +18,12 @@ import {ServerGeometry} from './ServerGeometry';
  * @param {string} options.operateDataset - 操作数据集的名称，即叠加对象数据集的名称。该名称用形如 "数据集名称@数据源别名" 形式来表示，例如：Neighbor_R@Jingjin。
  * @param {string} options.sourceDataset - 源数据集名称。该名称用形如 "数据集名称@数据源别名" 形式来表示，例如：BaseMap_R@Jingjin。
  * @param {Array.<string>} [options.operateDatasetFields] - 叠加分析中操作数据集保留在结果数据集中的字段名列表。
- * @param {FilterParameter} [options.operateDatasetFilter] - 设置操作数据集中空间对象过滤条件。
+ * @param {FilterParameter} [options.operateDatasetFilter] - 操作数据集的过滤条件，可以为 null。
  * @param {Array.<ModulePolygon>} [options.operateRegions] - 操作面对象集合，表示与这些面对象进行叠加分析。与 operateDataset 参数互斥，冲突时以 operateDataset 为准。
  * @param {Array.<string>} [options.sourceDatasetFields] - 叠加分析中源数据集保留在结果数据集中的字段名列表。
  * @param {FilterParameter} [options.sourceDatasetFilter] - 设置源数据集中空间对象过滤条件。设置了过滤参数后，只有满足条件的对象参与叠加分析。
- * @param {number} [options.tolerance=0] - 容限。
- * @param {OverlayOperationType} options.operation - 叠加操作枚举值。
+ * @param {number} [options.tolerance=0] - 叠加分析的容限值。
+ * @param {OverlayOperationType} options.operation - 叠加方式，可选择 CLIP，ERASE，IDENTITY，INTERSECT，UNION，UPDATE，XOR 之一。
  * @param {DataReturnOption} [options.resultSetting] - 结果返回设置类。
  * @extends {GetFeaturesParametersBase}
  * @usage
@@ -47,7 +47,7 @@ export class DatasetOverlayAnalystParameters extends OverlayAnalystParameters {
 
         /**
          * @member {FilterParameter} DatasetOverlayAnalystParameters.prototype.operateDatasetFilter
-         * @description 设置操作数据集中空间对象过滤条件。
+         * @description 操作数据集的过滤条件，可以为 null。
          */
         this.operateDatasetFilter = new FilterParameter();
 
@@ -80,7 +80,7 @@ export class DatasetOverlayAnalystParameters extends OverlayAnalystParameters {
 
         /**
          * @member {number} [DatasetOverlayAnalystParameters.prototype.tolerance=0]
-         * @description 容限。
+         * @description 叠加分析的容限值。
          */
         this.tolerance = 0;
 

src/common/iServer/FacilityAnalystUpstream3DParameters.js

@@ -12,8 +12,8 @@ import {FacilityAnalyst3DParameters} from './FacilityAnalyst3DParameters';
  * @extends {FacilityAnalyst3DParameters}
  * @param {Object} options - 参数。
  * @param {Array.<number>} options.sourceNodeIDs - 指定的设施点 ID 数组。
- * @param {number} [options.edgeID] - 指定的弧段 ID。edgeID 与 nodeID 必须指定一个。
- * @param {number} [options.nodeID] - 指定的结点 ID。edgeID 与 edgeID 必须指定一个。
+ * @param {number} [options.edgeID] - 三维设施网络分析中指定的弧段 ID，nodeID 与 edgeID 两者不能同时存在。
+ * @param {number} [options.nodeID] - 三维设施网络分析中指定的节点 ID，nodeID 与 edgeID 两者不能同时存在。
  * @param {boolean} [options.isUncertainDirectionValid=false] - 指定不确定流向是否有效。指定为 true，表示不确定流向有效，遇到不确定流向时分析继续进行；
  * 指定为 false，表示不确定流向无效，遇到不确定流向将停止在该方向上继续查找。
  * @usage

src/common/iServer/FeatureService.js

@@ -23,7 +23,7 @@ const FEATURE_SERVICE_MAP = {
  * @class FeatureService
  * @constructs FeatureService
  * @category  iServer Data Feature
- * @classdesc 数据集类。提供：ID 查询，范围查询，SQL查询，几何查询，缓冲区查询，地物编辑，要素附件查询、添加、删除等方法。
+ * @classdesc 数据集类。提供：ID 查询，范围查询，SQL查询，空间查询，缓冲区查询，地物编辑，要素附件查询、添加、删除等方法。
  * @example
  *      new FeatureService(url).getFeaturesByIDs(param,function(result){
  *          //doSomething
@@ -130,8 +130,8 @@ export class FeatureService {
 
   /**
    * @function FeatureService.prototype.getFeaturesByGeometry
-   * @description 数据集几何查询服务类。
-   * @param {GetFeaturesByGeometryParameters} params - 数据集几何查询参数类。
+   * @description 数据集空间查询服务类。
+   * @param {GetFeaturesByGeometryParameters} params - 数据集空间查询参数类。
    * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
    * @param {DataFormat} [resultFormat=DataFormat.GEOJSON] - 返回的数据格式。
    * @returns {Promise} Promise 对象。

src/common/iServer/GeoRelationAnalystParameters.js

@@ -16,8 +16,8 @@ import {Util} from '../commontypes/Util';
  * @param {boolean} [options.isBorderInside] - 边界处理方式，即位于面边线上的点是否被面包含。此参数仅用于空间关系为包含或被包含的情况。
  * @param {boolean} [options.returnFeature] - 是否返回 Feature 信息。
  * @param {boolean} [options.returnGeoRelatedOnly=true] - 仅返回满足指定空间关系的空间对象。
- * @param {number} [options.startRecord=0] - 分析结果起始记录位置。
- * @param {number} [options.expectCount=500] - 空间关系分析期望返回结果记录数，如果实际不足500条结果则返回所有分析结果。
+ * @param {number} [options.startRecord=0] - 空间关系分析结果起始记录位置。
+ * @param {number} [options.expectCount=500] - 空间关系分析期望返回结果记录数，如果实际不足 500 条结果则返回所有分析结果。
  * @usage
  */
 export class GeoRelationAnalystParameters {
@@ -68,7 +68,7 @@ export class GeoRelationAnalystParameters {
 
         /**
          * @member {number} [GeoRelationAnalystParameters.prototype.returnGeoRelatedOnly=0]
-         * @description 分析结果起始记录位置。
+         * @description 空间关系分析结果起始记录位置。
          */
         this.startRecord = 0;
 

src/common/iServer/GeometryOverlayAnalystParameters.js

@@ -17,7 +17,7 @@ import {ServerGeometry} from './ServerGeometry';
  * @param {Object} options.sourceGeometry - 叠加分析的源几何对象。
  * @param {Array.<GeoJSONFeature>} [options.operateGeometries] - 批量叠加分析的操作几何对象数组。
  * @param {Array.<GeoJSONFeature>} [options.sourceGeometries] -批量叠加分析的源几何对象数组。
- * @param {OverlayOperationType} [options.operation] - 叠加操作枚举值。
+ * @param {OverlayOperationType} [options.operation] - 叠加方式，可选择 CLIP，ERASE，IDENTITY，INTERSECT，UNION，UPDATE，XOR 之一。
  * @extends {OverlayAnalystParameters}
  * @usage
  */

src/common/iServer/GetFeaturesByBoundsParameters.js

@@ -16,17 +16,17 @@ import { GetFeaturesParametersBase } from './GetFeaturesParametersBase';
  *      <p style="font-size: 13px">推荐设置 returnFeaturesOnly 配置为 true 来提升性能，如果需要获取总数量与数据集信息，FeatureService 提供了 getFeaturesCount 和 getFeaturesDatasetInfo 方法</p>
  * </div>
  * @param {Object} options - 参数。
- * @param {ModuleBounds} options.bounds - 查询的范围对象。
+ * @param {ModuleBounds} options.bounds - 查询的矩形坐标范围。
  * @param {Array.<string>} options.datasetNames - 数据集名称列表。
  * @param {string} [options.attributeFilter] - 范围查询属性过滤条件。
  * @param {Array.<string>} [options.fields] - 查询结果返回字段。默认返回所有字段。
  * @param {SpatialQueryMode} [options.spatialQueryMode=SpatialQueryMode.CONTAIN] - 空间查询模式。
- * @param {boolean} [options.returnContent=true] - 是否直接返回查询结果。
- * @param {boolean} [options.returnFeaturesOnly=false] - 是否仅返回要素信息。当 returnContent 为 true 时设置有效。
- * @param {number} [options.fromIndex=0] - 查询结果的最小索引号。
- * @param {number} [options.toIndex=19] - 查询结果的最大索引号。
- * @param {string|number} [options.targetEpsgCode] - 动态投影的目标坐标系对应的 EPSG Code，使用此参数时，returnContent 参数需为 true。
- * @param {Object} [options.targetPrj] - 动态投影的目标坐标系。使用此参数时，returnContent 参数需为 true。如：prjCoordSys={"epsgCode":3857}。当同时设置 targetEpsgCode 参数时，此参数不生效。
+ * @param {boolean} [options.returnContent=true] - 是否立即返回新创建资源的表述还是返回新资源的 URI。如果为 true，则直接返回新创建资源，即查询结果的表述。如果为 false，则返回的是查询结果资源的 URI。
+ * @param {boolean} [options.returnFeaturesOnly=false] - 是否仅返回要素信息。当 returnContent 为 true 时设置有效。如果为 true，仅返回要素信息，以提升查询性能。如果为 false，返回完整的查询结果，包含查询结果的要素信息、数据集信息以及要素数量。
+ * @param {number} [options.fromIndex=0] - 查询结果的最小索引号，指定了返回结果的开始位置。
+ * @param {number} [options.toIndex=19] - 查询结果的最大索引号，指定了返回结果的结束位置。例如 fromIndex=0&toIndex=2，表示仅返回前 3 条查询结果信息。如果该值大于预期查询结果的最大索引号，则以预期查询结果的最大索引号为实际查询结果的最大索引号。
+ * @param {string|number} [options.targetEpsgCode] - 查询结果的目标坐标系对应的 EPSG Code，使用此参数时，returnContent 参数需为 true。
+ * @param {Object} [options.targetPrj] - 查询结果的目标坐标系。使用此参数时，returnContent 参数需为 true。如：prjCoordSys={"epsgCode":3857}。当此参数设置的坐标系统不同于数据的原有坐标系统时，系统会进行坐标转换，并返回坐标转换后的查询结果。当同时设置 targetEpsgCode 参数时，此参数不生效。
  * @param {MetricsAggParameter|GeoHashGridAggParameter} [options.aggregations] - 聚合查询参数。该参数仅支持数据来源为 Elasticsearch 服务的 SuperMap iServer 的 REST 数据服务。
  * @extends {GetFeaturesParametersBase}
  * @usage
@@ -43,7 +43,7 @@ export class GetFeaturesByBoundsParameters extends GetFeaturesParametersBase {
 
         /**
          * @member {ModuleBounds} GetFeaturesByBoundsParameters.prototype.bounds
-         * @description 用于查询的范围对象。
+         * @description 查询的矩形坐标范围。
          *
          */
         this.bounds = null;