【fix】 修复缺陷ICL-1386; distance 属性； review by qiwei

zhangjiangqiu · zhangjiangqiu · commit c8c8555b4745 · 2022-03-17T19:25:20.000+08:00
diff --git a/src/common/iServer/ChartQueryParameters.js b/src/common/iServer/ChartQueryParameters.js
@@ -14,7 +14,7 @@ import {ChartQueryFilterParameter} from './ChartQueryFilterParameter';
  * @param {string} options.queryMode - 海图查询模式类型，支持两种查询方式：海图属性查询（"ChartAttributeQuery"）和海图空间查询（"ChartBoundsQuery"）。
  * @param {Array.<string>} options.chartLayerNames - 查询的海图图层的名称。
  * @param {Array.<ChartQueryFilterParameter>} options.chartQueryFilterParameters - 海图查询过滤参数。包括：物标代码、物标可应用对象的选择（是否查询点、线或面）、属性字段过滤条件。
- * @param {(SuperMap.Bounds|L.Bounds|L.LatLngBounds|ol.extent|mapboxgl.LngLatBounds|GeoJSONObject)} [options.bounds] - 海图查询范围。当进行海图范围查询时，此参数为必选。
+ * @param {(SuperMap.Bounds|L.Bounds|L.LatLngBounds|ol.extent|mapboxgl.LngLatBounds|GeoJSONObject)} options.bounds - 海图查询范围。当进行海图范围查询时，此为必选参数。
  * @param {boolean} [options.returnContent=true] - 获取或设置是返回查询结果记录集 recordsets，还是返回查询结果的资源 resourceInfo。
  * @param {number} [options.startRecord=0] - 查询起始记录位置。
  * @param {number} [options.expectCount] - 期望查询结果返回的记录数，该值大于0。
@@ -34,7 +34,7 @@ export class ChartQueryParameters {
          * @member {(SuperMap.Bounds|L.Bounds|L.LatLngBounds|ol.extent|mapboxgl.LngLatBounds|GeoJSONObject)} ChartQueryParameters.prototype.bounds
          * @description 海图查询范围。
          */
-        this.bounds = null;
+         this.bounds = null;
 
         /**
          * @member {Array.<string>} ChartQueryParameters.prototype.chartLayerNames
diff --git a/src/common/iServer/CreateDatasetParameters.js b/src/common/iServer/CreateDatasetParameters.js
@@ -9,8 +9,8 @@ import {Util} from '../commontypes/Util';
  * @category iServer Data Dataset
  * @classdesc 数据集创建参数类。
  * @param {Object} options - 参数。
- * @param {string} options.datasourceName - 数据源名称(必选)。
- * @param {string} options.datasetName - 数据集名称(必选)。
+ * @param {string} options.datasourceName - 数据源名称，此为必选参数。
+ * @param {string} options.datasetName - 数据集名称，此为必选参数。
  * @param {string} options.datasetType - 数据集类型。目前支持创建的出聚集类型有：点、线、面、文本、复合（CAD）和属性数据集。
  * @usage
  */
@@ -23,15 +23,15 @@ export class CreateDatasetParameters {
 
         /**
          * @member {string} CreateDatasetParameters.prototype.datasourceName
-         * @description 数据源名称。
+         * @description 数据源名称，此为必选参数。
          */
-        this.datasourceName = null;
+         this.datasourceName = null;
 
         /**
          * @member {string} CreateDatasetParameters.prototype.datasetName
-         * @description 数据集名称。
+         * @description 数据集名称，此为必选参数。
          */
-        this.datasetName = null;
+         this.datasetName = null;
 
         /**
          * @member {string} CreateDatasetParameters.prototype.datasetType
diff --git a/src/common/iServer/InterpolationAnalystParameters.js b/src/common/iServer/InterpolationAnalystParameters.js
@@ -15,7 +15,7 @@ import {
  * @param {string} options.outputDatasetName - 插值分析结果数据集的名称。
  * @param {string} options.outputDatasourceName - 插值分析结果数据源的名称。
  * @param {string} [options.zValueFieldName] - 进行插值分析的字段名称，插值分析不支持文本类型的字段。
- * @param {string} [options.dataset] - 待分析的数据集名称。当插值分析类型（InterpolationAnalystType）为 dataset 时，此参数为必选。
+ * @param {string} [options.dataset] - 待分析的数据集名称。当插值分析类型（InterpolationAnalystType）为 dataset 时，此为必选参数。
  * @param {Array.<GeometryPoint|L.LatLng|L.Point|ol.geom.Point|mapboxgl.LngLat|Array.<number>>} [options.inputPoints] - 用于做插值分析的离散点集合。当插值分析类型（InterpolationAnalystType）为 geometry 时，此参数为必设参数。
  * @param {number} [options.searchRadius=0] - 查找半径，即参与运算点的查找范围，与点数据集单位相同。
  * @param {number} [options.zValueScale=1] - 进行插值分析值的缩放比率。
@@ -97,7 +97,7 @@ export class InterpolationAnalystParameters {
         /**
          * @member {string} [InterpolationAnalystParameters.prototype.dataset]
          * @description 用来做插值分析的数据源中数据集的名称，该名称用形如 "数据集名称@数据源别名" 形式来表示。
-         * 当插值分析类型（InterpolationAnalystType）为 dataset 时，此参数为必选。
+         * 当插值分析类型（InterpolationAnalystType）为 dataset 时，此为必选参数。
          */
         this.dataset = null;
 
diff --git a/src/common/iServer/InterpolationDensityAnalystParameters.js b/src/common/iServer/InterpolationDensityAnalystParameters.js
@@ -19,8 +19,8 @@ import {InterpolationAnalystParameters} from './InterpolationAnalystParameters';
  * @param {number} [options.resolution] - 插值结果栅格数据集的分辨率，即一个像元所代表的实地距离，与点数据集单位相同。
  * @param {FilterParameter} [options.filterQueryParameter] - 属性过滤条件。
  * @param {string} [options.pixelFormat] - 指定结果栅格数据集存储的像素格式。
- * @param {string} [options.dataset] - 用来做插值分析的数据源中数据集的名称，该名称用形如 "数据集名称@数据源别名" 形式来表示。当插值分析类型（InterpolationAnalystParameters.prototype.InterpolationAnalystType）为 dataset 时，必设参数。
- * @param {Array.<GeometryPoint|L.LatLng|L.Point|ol.geom.Point|mapboxgl.LngLat|Array.<number>>} [options.inputPoints] - 用于做插值分析的离散点集合。当插值分析类型（InterpolationAnalystParameters.prototype.InterpolationAnalystType）为 geometry 时，必设参数。
+ * @param {string} [options.dataset] - 用来做插值分析的数据源中数据集的名称，该名称用形如 "数据集名称@数据源别名" 形式来表示。当插值分析类型（InterpolationAnalystParameters.prototype.InterpolationAnalystType）为 dataset 时，此为必选参数。
+ * @param {Array.<GeometryPoint|L.LatLng|L.Point|ol.geom.Point|mapboxgl.LngLat|Array.<number>>} [options.inputPoints] - 用于做插值分析的离散点集合。当插值分析类型（InterpolationAnalystParameters.prototype.InterpolationAnalystType）为 geometry 时，此为必选参数。
  * @extends {InterpolationAnalystParameters}
  * @example
  * var myInterpolationDensityAnalystParameters = new InterpolationDensityAnalystParameters({
diff --git a/src/common/iServer/InterpolationIDWAnalystParameters.js b/src/common/iServer/InterpolationIDWAnalystParameters.js
@@ -22,8 +22,8 @@ import {InterpolationAnalystParameters} from './InterpolationAnalystParameters';
  * @param {number} [options.resolution] - 插值结果栅格数据集的分辨率，即一个像元所代表的实地距离，与点数据集单位相同。
  * @param {FilterParameter} [options.filterQueryParameter] - 属性过滤条件。
  * @param {string} [options.pixelFormat] - 指定结果栅格数据集存储的像素格式。
- * @param {string} [options.dataset] - 要用来做插值分析的数据源中数据集的名称。该名称用形如”数据集名称@数据源别名”形式来表示。当插值分析类型(SuperMap.InterpolationAnalystType)为 dataset 时，必设参数。
- * @param {Array.<GeometryPoint|L.LatLng|L.Point|ol.geom.Point|mapboxgl.LngLat|Array.<number>>} [options.inputPoints] - 用于做插值分析的离散点集合。当插值分析类型（SuperMap.InterpolationAnalystType）为 geometry 时，必设参数。
+ * @param {string} [options.dataset] - 要用来做插值分析的数据源中数据集的名称。该名称用形如”数据集名称@数据源别名”形式来表示。当插值分析类型(SuperMap.InterpolationAnalystType)为 dataset 时，此为必选参数。
+ * @param {Array.<GeometryPoint|L.LatLng|L.Point|ol.geom.Point|mapboxgl.LngLat|Array.<number>>} [options.inputPoints] - 用于做插值分析的离散点集合。当插值分析类型（SuperMap.InterpolationAnalystType）为 geometry 时，此为必选参数。
  * @extends {InterpolationAnalystParameters}
  * @example 例如：
  * var myInterpolationIDWAnalystParameters = new InterpolationIDWAnalystParameters({
diff --git a/src/common/iServer/InterpolationKrigingAnalystParameters.js b/src/common/iServer/InterpolationKrigingAnalystParameters.js
@@ -147,7 +147,7 @@ export class InterpolationKrigingAnalystParameters extends InterpolationAnalystP
 
         /**
          * @member {SearchMode} InterpolationKrigingAnalystParameters.prototype.searchMode
-         * @description 插值运算时，查找参与运算点的方式，有固定点数查找、定长查找、块查找。必设参数。
+         * @description 插值运算时，查找参与运算点的方式，有固定点数查找、定长查找、块查找。此为必选参数。
          * 简单克吕金和泛克吕金不支持块查找。
          * 具体如下：<br>
          * {KDTREE_FIXED_COUNT} 使用 KDTREE 的固定点数方式查找参与内插分析的点。<br>
diff --git a/src/common/iServer/InterpolationRBFAnalystParameters.js b/src/common/iServer/InterpolationRBFAnalystParameters.js
@@ -26,8 +26,8 @@ import {InterpolationAnalystParameters} from './InterpolationAnalystParameters';
  * @param {number} [options.resolution] - 插值结果栅格数据集的分辨率，即一个像元所代表的实地距离，与点数据集单位相同。
  * @param {FilterParameter} [options.filterQueryParameter] - 属性过滤条件。
  * @param {string} [options.pixelFormat] - 指定结果栅格数据集存储的像素格式。
- * @param {string} [options.dataset] - 要用来做插值分析的数据源中数据集的名称。该名称用形如”数据集名称@数据源别名”形式来表示。当插值分析类型(InterpolationAnalystType)为 dataset 时。此参数为必选。
- * @param {Array.<GeometryPoint|L.LatLng|L.Point|ol.geom.Point|mapboxgl.LngLat|Array.<number>>} [options.inputPoints] - 用于做插值分析的离散点集合。当插值分析类型（InterpolationAnalystType）为 geometry 时。此参数为必选。
+ * @param {string} [options.dataset] - 要用来做插值分析的数据源中数据集的名称。该名称用形如”数据集名称@数据源别名”形式来表示。当插值分析类型(InterpolationAnalystType)为 dataset 时。此为必选参数。
+ * @param {Array.<GeometryPoint|L.LatLng|L.Point|ol.geom.Point|mapboxgl.LngLat|Array.<number>>} [options.inputPoints] - 用于做插值分析的离散点集合。当插值分析类型（InterpolationAnalystType）为 geometry 时。此为必选参数。
  * @example
  * var myInterpolationRBFAnalystParameters = new InterpolationRBFAnalystParameters({
  *     dataset:"SamplesP@Interpolation",
diff --git a/src/common/iServer/QueryByDistanceParameters.js b/src/common/iServer/QueryByDistanceParameters.js
@@ -14,6 +14,7 @@ import {QueryParameters} from './QueryParameters';
  * @param {Object} options - 参数。
  * @param {GeoJSONObject} options.geometry - 用于查询的几何对象。
  * @param {Array.<FilterParameter>} options.queryParams - 查询过滤条件参数数组。
+ * @param {number} options.distance - 查询距离，单位与所查询图层对应的数据集单位相同。距离查询时，表示距离地物的距离。最近地物查询时，表示距离的容限。此为必选参数。
  * @param {string} [options.customParams] - 自定义参数，供扩展使用。
  * @param {Object} [options.prjCoordSys] -自定义参数，供 SuperMap Online 提供的动态投影查询扩展使用。如 {"epsgCode":3857}。
  * @param {number} [options.expectCount=100000] - 期望返回结果记录个数。
@@ -22,7 +23,6 @@ import {QueryParameters} from './QueryParameters';
  * @param {number} [options.startRecord=0] - 查询起始记录号。
  * @param {number} [options.holdTime=10] - 资源在服务端保存的时间，单位为分钟。
  * @param {boolean} [options.returnCustomResult=false] -仅供三维使用。
- * @param {number} [options.distance=0] - 查询距离。
  * @param {boolean} [options.isNearest=false] - 是否为最近距离查询。
  * @param {boolean} [options.returnContent=true] - 是否立即返回新创建资源的表述还是返回新资源的 URI。
  * @param {boolean} [options.returnFeatureWithFieldCaption = false] - 返回的查询结果要素字段标识是否为字段别名。为 false 时，返回的是字段名；为 true 时，返回的是字段别名。
@@ -37,9 +37,8 @@ export class QueryByDistanceParameters extends QueryParameters {
         /**
          * @member {number} [QueryByDistanceParameters.prototype.distance=0]
          * @description 查询距离，单位与所查询图层对应的数据集单位相同。
-         *              当查找最近地物时，该属性无效。
+         *              距离查询时，表示距离地物的距离。最近地物查询时，表示距离的容限。
          */
-        this.distance = 0;
 
         /**
          * @member {GeoJSONObject} QueryByDistanceParameters.prototype.geometry
diff --git a/src/common/security/TokenServiceParameter.js b/src/common/security/TokenServiceParameter.js
@@ -13,8 +13,8 @@ import {ClientType} from '../REST';
  * @param {string} options.username - 用户名。
  * @param {string} options.password - 密码。
  * @param {ClientType} [options.clientType='ClientType.NONE'] - token 申请的客户端标识类型。
- * @param {string} [options.ip] - clientType=IP 时，必选。
- * @param {string} [options.referer] -clientType=Referer 时，必选。如果按照指定 URL 的方式申请令牌，则设置相应的 URL。
+ * @param {string} [options.ip] - clientType=IP 时，此为必选参数。
+ * @param {string} [options.referer] -clientType=Referer 时，此为必选参数。如果按照指定 URL 的方式申请令牌，则设置相应的 URL。
  * @param {number} [options.expiration=60] - 申请令牌的有效期,从发布令牌的时间开始计算,单位为分钟。
  * @usage
  *
@@ -41,13 +41,13 @@ export class TokenServiceParameter {
 
         /**
          * @member {string} [TokenServiceParameter.prototype.ip]
-         * @description clientType=IP 时，必选。
+         * @description clientType=IP 时，此为必选参数。
          */
 
         this.ip = null;
         /**
          * @member {string} [TokenServiceParameter.prototype.referer]
-         * @description clientType=Referer 时，必选。如果按照指定 URL 的方式申请令牌，则设置相应的 URL。
+         * @description clientType=Referer 时，此为必选参数。如果按照指定 URL 的方式申请令牌，则设置相应的 URL。
          */
         this.referer = null;
 
