common 下 api 参数优化 review by songym

Author: liqian7

src/common/format/GeoJSON.js

@@ -359,9 +359,9 @@ export class GeoJSON extends JSONFormat {
      * @param {Function} filter - 对象中每个层次每个键值对都会调用此函数得出一个结果。每个值都会被 filter 函数的结果所替换掉。这个函数可被用来将某些对象转化成某个类相应的对象，或者将日期字符串转化成Date对象。
      * @param {string} [type='FeaureCollection'] - 可选的字符串，它决定了输出的格式。支持的值有："Geometry","Feature"，和 "FeatureCollection"，如果此值为null。
      * @returns {Object}  返回值依赖于 type 参数的值。
-     *     -如果 type 等于 "FeatureCollection"，返回值将会是 {@link SuperMap.Feature.Vector}> 数组。
+     *     -如果 type 等于 "FeatureCollection"，返回值将会是 {@link SuperMap.Feature.Vector} 数组。
      *     -如果 type 为 "Geometry",输入的 JSON 对象必须表示一个唯一的几何体，然后返回值就会是 {@link SuperMap.Feature.Geometry}。
-     *     -如果 type 为 "Feature"，输入的 JSON 对象也必须表示的一个要素，这样返回值才会是 {@link SuperMap.Feature.Vector}> 。
+     *     -如果 type 为 "Feature"，输入的 JSON 对象也必须表示的一个要素，这样返回值才会是 {@link SuperMap.Feature.Vector}。
      */
 
      read(json, type, filter) {

src/common/iServer/AreaSolarRadiationParameters.js

@@ -19,28 +19,28 @@ import {Util} from '../commontypes/Util';
  * @param {number} [options.hourStart] - 起始时间（一天中的第几个小时）。 
  * @param {number} [options.hourEnd] - 结束时间（一天中的第几个小时）。 
  * @param {number} [options.transmittance] - 太阳辐射穿过大气的透射率。 
- * @param {number} [options.hourInterval=0.5] - 计算时的小时间隔（设置的越小计算量越大并且计算结果更精确, 默认为0.5小时，如果修改此参数，必须使用整数）。 
- * @param {number} [options.dayInterval=5] - 计算时的天数间隔（设置的越小计算量越大并且计算结果更精确, 默认为5天，必须使用整数）。 
+ * @param {number} [options.hourInterval=0.5] - 计算时的小时间隔（设置的越小计算量越大并且计算结果更精确，如果修改此参数，必须使用整数）。 
+ * @param {number} [options.dayInterval=5] - 计算时的天数间隔（设置的越小计算量越大并且计算结果更精确，必须使用整数）。 
  * @param {boolean} [options.deleteExistResultDataset=false] - 如果用户命名的结果数据集名称与已有的数据集重名，是否删除已有的数据集。
  */
 export class AreaSolarRadiationParameters {
 
     constructor(options) {
         /**
          *  @member {string} SuperMap.AreaSolarRadiationParameters.prototype.dataset
-         *  @description 要用来做地区太阳辐射数据源中数据集的名称（必设参数）。该名称用形如"数据集名称@数据源别名"形式来表示，例如：JingjinTerrain@Jingjin。注：地区太阳辐射数据必须为栅格数据集。
+         *  @description 要用来做地区太阳辐射数据源中数据集的名称。该名称用形如“数据集名称@数据源别名”形式来表示，例如：JingjinTerrain@Jingjin。注：地区太阳辐射数据必须为栅格数据集。
          */
         this.dataset = null;
 
         /**
          * @member {string} SuperMap.AreaSolarRadiationParameters.prototype.targetDatasourceName
-         * @description 指定的存储结果数据集的数据源名称（必设参数），例如："Jingjin"。
+         * @description 指定的存储结果数据集的数据源名称，例如："Jingjin"。
          */
         this.targetDatasourceName = null;
 
         /**
          * @member {string} SuperMap.AreaSolarRadiationParameters.prototype.totalGridName
-         * @description 指定地区太阳辐射总辐射量数据集的名称（必设参数）。
+         * @description 指定地区太阳辐射总辐射量数据集的名称。
          */
         this.totalGridName = null;
 
@@ -76,13 +76,13 @@ export class AreaSolarRadiationParameters {
 
         /**
          *  @member {number} SuperMap.AreaSolarRadiationParameters.prototype.dayStart
-         *  @description 起始日期（年内的第几天），必设参数。
+         *  @description 起始日期（年内的第几天）。
          */
         this.dayStart = null;
 
         /**
          *  @member {number} SuperMap.AreaSolarRadiationParameters.prototype.dayEnd
-         * @description 结束日期（年内的第几天），必设参数。
+         * @description 结束日期（年内的第几天）。
          */
         this.dayEnd = null;
 
@@ -118,7 +118,7 @@ export class AreaSolarRadiationParameters {
 
         /**
          * @member {boolean} [SuperMap.AreaSolarRadiationParameters.prototype.deleteExistResultDataset=false]
-         * @description 如果用户命名的结果数据集名称与已有的数据集重名，是否删除已有的数据集。\
+         * @description 如果用户命名的结果数据集名称与已有的数据集重名，是否删除已有的数据集。
          */
         this.deleteExistResultDataset = false;
 

src/common/iServer/BufferAnalystParameters.js

@@ -6,16 +6,16 @@ import {BufferSetting} from './BufferSetting';
  * @class SuperMap.BufferAnalystParameters
  * @category iServer SpatialAnalyst BufferAnalyst
  * @classdesc 缓冲区分析参数基类。
- * @param {Object} options - 参数。
- * @param {SuperMap.BufferSetting} options.bufferSetting - 设置缓冲区通用参数。为缓冲区分析提供必要的参数信息，包括左缓冲距离、右缓冲距离、端点类型、圆头缓冲圆弧处线段的个数信息。
+ * @param {Object} options - 参数。 
+ * @param {SuperMap.BufferSetting} [options.bufferSetting] - 设置缓冲区通用参数。为缓冲区分析提供必要的参数信息，包括左缓冲距离、右缓冲距离、端点类型、圆头缓冲圆弧处线段的个数信息。
  */
 export class BufferAnalystParameters {
 
 
     constructor(options) {
         var me = this;
         /**
-         * @member {SuperMap.BufferSetting} SuperMap.BufferAnalystParameters.prototype.bufferSetting
+         * @member {SuperMap.BufferSetting} [SuperMap.BufferAnalystParameters.prototype.bufferSetting]
          * @description 设置缓冲区通用参数。为缓冲区分析提供必要的参数信息，包括左缓冲距离、右缓冲距离、端点类型、圆头缓冲圆弧处线段的个数信息。
          */
         me.bufferSetting = new BufferSetting();

src/common/iServer/BufferDistance.js

@@ -5,7 +5,7 @@ import {Util} from '../commontypes/Util';
  * @class SuperMap.BufferDistance
  * @category iServer SpatialAnalyst BufferAnalyst
  * @classdesc 缓冲区分析的缓冲距离类。通过该类可以设置缓冲区分析的缓冲距离，距离可以是数值也可以是数值型的字段表达式。
- * @param {Object} options - 参数。
+ * @param {Object} options - 参数。 
  * @param {string} [options.exp] - 以数值型的字段表达式作为缓冲区分析的距离值。 
  * @param {number} [options.value=100] - 以数值作为缓冲区分析的距离值。单位：米。
  */

src/common/iServer/BurstPipelineAnalystParameters.js

@@ -6,7 +6,7 @@ import {Util} from '../commontypes/Util';
  * @category iServer NetworkAnalyst BurstAnalyse
  * @classdesc 爆管分析参数类。
  * @param {Object} options - 参数。 
- * @param {Array.<number>} options.sourceNodeIDs - 指定的设施点ID数组。 
+ * @param {Array.<number>} options.sourceNodeIDs - 指定的设施点 ID 数组。 
  * @param {number} [options.edgeID] - 指定的弧段ID，edgeID 与 nodeID 必须指定一个。 
  * @param {number} [options.nodeID] - 指定的结点ID，edgeID 与 nodeID 必须指定一个。 
  * @param {boolean} [options.isUncertainDirectionValid=false] - 指定不确定流向是否有效。
@@ -18,19 +18,19 @@ export class BurstPipelineAnalystParameters {
         var me = this;
         /**
          * @member {Array.<number>} SuperMap.BurstPipelineAnalystParameters.prototype.sourceNodeIDs
-         * @description 指定的设施点ID数组。
+         * @description 指定的设施点 ID 数组。
          */
         this.sourceNodeIDs = null;
 
         /**
          * @member {number} [SuperMap.BurstPipelineAnalystParameters.prototype.edgeID]
-         * @description 指定的弧段ID，edgeID 与 nodeID 必须指定一个。 
+         * @description 指定的弧段 ID，edgeID 与 nodeID 必须指定一个。 
          */
         this.edgeID = null;
 
         /**
          * @member {number} [SuperMap.BurstPipelineAnalystParameters.prototype.nodeID]
-         * @description 指定的结点ID，edgeID 与 nodeID 必须指定一个。 
+         * @description 指定的结点 ID，edgeID 与 nodeID 必须指定一个。 
          */
         this.nodeID = null;
 

src/common/iServer/ChartQueryFilterParameter.js

@@ -6,11 +6,11 @@ import {Util} from '../commontypes/Util';
  * @category  iServer Map Chart
  * @classdesc 海图查询过滤参数类，用于设置海图查询的过滤参数。包括：物标代码、物标可应用对象的选择（是否查询点、线或面）、属性字段过滤条件。
  * @param {Object} options - 参数。 
+ * @param {string} options.attributeFilter - 属性字段过滤条件。 
+ * @param {number} options.chartFeatureInfoSpecCode - 查询的物标代号。
  * @param {boolean} [options.isQueryPoint] - 是否查询点。 
  * @param {boolean} [options.isQueryLine] - 是否查询线。 
  * @param {boolean} [options.isQueryRegion] - 是否查询面。 
- * @param {string} options.attributeFilter - 属性字段过滤条件。 
- * @param {number} options.chartFeatureInfoSpecCode - 查询的物标代号。
  */
 export class ChartQueryFilterParameter {
 

src/common/iServer/ChartQueryParameters.js

@@ -9,9 +9,9 @@ import {ChartQueryFilterParameter} from './ChartQueryFilterParameter';
  *            必设属性有：queryMode、chartLayerNames、chartQueryFilterParameters。当进行海图范围查询时，必设属性还包括 bounds。
  * @param {Object} options - 参数。 
  * @param {string} options.queryMode - 海图查询模式类型，支持两种查询方式：海图属性查询（"ChartAttributeQuery"）和海图空间查询（"ChartBoundsQuery"）。 
- * @param {(SuperMap.Bounds|L.Bounds|ol.extent)} [options.bounds] - 海图查询范围。当进行海图范围查询时，此参数为必选。
  * @param {Array.<string>} options.chartLayerNames - 查询的海图图层的名称。
- * @param {Array.<{SuperMap.ChartQueryFilterParameter}>} [options.chartQueryFilterParameters] - 海图查询过滤参数。包括：物标代码、物标可应用对象的选择（是否查询点、线或面）、属性字段过滤条件。 
+ * @param {Array.<{SuperMap.ChartQueryFilterParameter}>} options.chartQueryFilterParameters - 海图查询过滤参数。包括：物标代码、物标可应用对象的选择（是否查询点、线或面）、属性字段过滤条件。 
+ * @param {(SuperMap.Bounds|L.Bounds|ol.extent)} [options.bounds] - 海图查询范围。当进行海图范围查询时，此参数为必选。
  * @param {boolean} [options.returnContent=true] - 获取或设置是返回查询结果记录集 recordsets，还是返回查询结果的资源 resourceInfo。 
  * @param {number} [options.startRecord=0] - 查询起始记录位置。 
  * @param {number} [options.expectCount] - 期望查询结果返回的记录数，该值大于0。

src/common/iServer/ClipParameter.js

@@ -7,11 +7,11 @@ import {ServerGeometry} from './ServerGeometry';
  * @category iServer SpatialAnalyst Interpolation
  * @classdesc 用于裁剪的参数。
  * @description 优先使用用户指定的裁剪区域多边形进行裁剪，也可以通过指定数据源和数据集名，从而使用指定数据集的边界多边形进行裁剪。
- * @param {Object} options - 参数。
- * @param {string} options.clipDatasetName - 裁剪的数据集名。
- * @param {string} options.clipDatasourceName - 裁剪的数据集所在数据源的名字。
- * @param {(SuperMap.Geometry.Polygon|L.Polygon|L.GeoJSON|ol.geom.Polygon|ol.format.GeoJSON)} options.clipRegion - 用户指定的裁剪区域。</br>
- * @param {boolean} [options.isClipInRegion=false] - 是否对裁剪区内的数据集进行裁剪。
+ * @param {Object} options - 参数。 
+ * @param {string} [options.clipDatasetName] - 裁剪的数据集名。 
+ * @param {string} [options.clipDatasourceName] - 裁剪的数据集所在数据源的名字。 
+ * @param {(SuperMap.Geometry.Polygon|L.Polygon|L.GeoJSON|ol.geom.Polygon|ol.format.GeoJSON)} [options.clipRegion] - 用户指定的裁剪区域。 
+ * @param {boolean} [options.isClipInRegion=true] - 是否对裁剪区内的数据集进行裁剪。 
  * @param {boolean} [options.isExactClip=true] - 是否使用精确裁剪。
  */
 export class ClipParameter {
@@ -20,27 +20,27 @@ export class ClipParameter {
     constructor(options) {
         /**
          * @member {string} SuperMap.ClipParameter.prototype.clipDatasetName
-         * @description 用于裁剪的数据集名，当clipRegion不设置时起作用。
+         * @description 用于裁剪的数据集名，clipDatasetName 与 clipRegion 必须设置一个。
          */
         this.clipDatasetName = null;
 
         /**
          * @member {string} SuperMap.ClipParameter.prototype.clipDatasourceName
-         * @description 用于裁剪的数据集所在数据源的名字。
+         * @description 用于裁剪的数据集所在数据源的名字。当 clipRegion 不设置时起作用。
          */
         this.clipDatasourceName = null;
 
         /**
          * @member {(SuperMap.Geometry.Polygon|L.Polygon|L.GeoJSON|ol.geom.Polygon|ol.format.GeoJSON)} SuperMap.ClipParameter.prototype.clipRegion
-         * @description 用户指定的裁剪区域，优先使用。
+         * @description 用户指定的裁剪区域，优先使用，clipDatasetName 与 clipRegion 必须设置一个。 
          */
         this.clipRegion = null;
 
         /**
-         * @member {boolean} SuperMap.ClipParameter.prototype.isClipInRegion
-         * @description 是否对裁剪区内的数据集进行裁剪。
+         * @member {boolean} [SuperMap.ClipParameter.prototype.isClipInRegion=true]
+         * @description 是否对裁剪区内的数据集进行裁剪。若为 true，则对裁剪区域内的结果进行裁剪，若为 false，则对裁剪区域外的结果进行裁剪。 
          */
-        this.isClipInRegion = false;
+        this.isClipInRegion = true;
 
         /**
          * @member {boolean} [SuperMap.ClipParameter.prototype.isExactClip=true]

src/common/iServer/CommonServiceBase.js

@@ -36,7 +36,6 @@ import {
  * @param {string} [options.proxy] - 服务代理地址。
  * @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务器类型，iServer|iPortal|Online。
  * @param {boolean} [options.withCredentials=false] - 请求是否携带 cookie。
- * @param {SuperMap.DataFormat} [options.format=SuperMap.DataFormat.GEOJSON] - 查询结果返回格式，目前支持 iServerJSON 和 GeoJSON 两种格式。参数格式为 "ISERVER"，"GEOJSON"。
  */
 export class CommonServiceBase {
 

src/common/iServer/DataReturnOption.js

@@ -7,9 +7,9 @@ import {DataReturnMode} from '../REST';
  * @category iServer SpatialAnalyst
  * @classdesc 数据返回设置类。
  * @param {Object} options - 参数。 
- * @param {number} [options.expectCount=1000] - 设置返回的最大记录数，小于或者等于0时表示返回所有记录数。 
+ * @param {number} [options.expectCount=1000] - 设置返回的最大记录数，小于或者等于 0 时表示返回所有记录数。 
  * @param {string} [options.dataset] - 设置结果数据集标识，当 dataReturnMode 为 {@link SuperMap.DataReturnMode.DATASET_ONLY}或{@link SuperMap.DataReturnMode.DATASET_AND_RECORDSET}时有效，
- *                                   作为返回数据集的名称。该名称用形如 "数据集名称@数据源别名" 形式来表示。 
+ *                                   作为返回数据集的名称。该名称用形如“数据集名称@数据源别名”形式来表示。 
  * @param {SuperMap.DataReturnMode} [options.dataReturnMode=SuperMap.DataReturnMode.RECORDSET_ONLY] - 数据返回模式。 
  * @param {boolean} [options.deleteExistResultDataset=true] - 如果用户命名的结果数据集名称与已有的数据集重名，是否删除已有的数据集。
  */