Skip to content

Commit b03094e

Browse files
author
raoqingyun
committed
【API】修改jsdoc中注释内容 commit by zhangzhw review by chenmy
1 parent a7867a4 commit b03094e

File tree

5 files changed

+48
-47
lines changed

5 files changed

+48
-47
lines changed

‎src/common/iServer/AggQueryBuilderParameter.js‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,23 @@ import {SuperMap} from "../SuperMap";
22
import {Util} from '../commontypes/Util';
33

44
/**
5-
* @class SuperMap.AggQueryBuilderParameter
6-
* @classdesc 聚合查询QueryBuilder参数基类,该参数仅支持数据来源Elasticsearch服务的数据服务
7-
* @category iServer Data FeatureResults
8-
* @param {object} option 初始化参数 <br>
9-
* @param {String} name 查询结果名称 <br>
10-
* @param {String} queryType 查询类型 <br>
5+
* @class SuperMap.AggQueryBuilderParameter
6+
* @classdesc 聚合查询QueryBuilder参数基类,该参数仅支持数据来源Elasticsearch服务的数据服务
7+
* @category iServer Data FeatureResults
8+
* @param {Object} option - 初始化参数 <br>
9+
* @param {string} option.name - 查询结果名称 <br>
10+
* @param {SuperMap.AggregationQueryBuilderType} option.queryType - 查询类型 <br>
1111
*/
1212
export class AggQueryBuilderParameter {
1313
constructor(option) {
1414

1515
/**
16-
* @member SuperMap.AggQueryBuilderParameter.prototype.name -{String}
16+
* @member {string} SuperMap.AggQueryBuilderParameter.prototype.name
1717
* @description 查询结果名称
1818
*/
1919
this.name = null;
2020
/**
21-
* @member SuperMap.AggQueryBuilderParameter.prototype.queryType -{String}
21+
* @member {SuperMap.AggregationQueryBuilderType} SuperMap.AggQueryBuilderParameter.prototype.queryType
2222
* @description 查询类型
2323
*/
2424
this.queryType = null;

‎src/common/iServer/AggregationParameter.js‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,35 @@ import {SuperMap} from '../SuperMap';
22
import {Util} from '../commontypes/Util';
33

44
/**
5-
* @class SuperMap.AggregationParameter
6-
* @classdesc 聚合查询参数设置,该参数仅支持数据来源Elasticsearch服务的数据服务
7-
* @category iServer Data FeatureResults
8-
* @param {object} options 初始化参数 <br>
9-
* @param {String} aggName 聚合名称 <br>
10-
* @param {String} aggType 聚合类型设置 <br>
11-
* @param {String} aggFieldName 聚合字段 <br>
12-
* @param {object} subAgg 子聚合类 </br>
5+
* @class SuperMap.AggregationParameter
6+
* @classdesc 聚合查询参数设置,该参数仅支持数据来源Elasticsearch服务的数据服务
7+
* @category iServer Data FeatureResults
8+
* @param {Object} options - 初始化参数 <br>
9+
* @param {string} options.aggName - 聚合名称 <br>
10+
* @param {SuperMap.AggregationType} options.aggType - 聚合类型设置 <br>
11+
* @param {string} options.aggFieldName - 聚合字段 <br>
12+
* @param {SuperMap.AggregationParameter} options.subAgg - 子聚合类 </br>
1313
*
1414
*/
1515
export class AggregationParameter {
1616
constructor(options) {
1717
/**
18-
* @member SuperMap.AggregationParameter.prototype.aggName - {String}
18+
* @member {string} SuperMap.AggregationParameter.prototype.aggName
1919
* @description 聚合名称
2020
*/
2121
this.aggName = null;
2222
/**
23-
* @member SuperMap.AggregationParameter.prototype.aggType - {String}
23+
* @member {SuperMap.AggregationType} SuperMap.AggregationParameter.prototype.aggType
2424
* @description 聚合类型设置类
2525
*/
2626
this.aggType = null;
2727
/**
28-
* @member SuperMap.AggregationParameter.prototype.aggFieldName - {String}
28+
* @member {string} SuperMap.AggregationParameter.prototype.aggFieldName
2929
* @description 聚合字段
3030
*/
3131
this.aggFieldName = null;
3232
/**
33-
* @member SuperMap.AggregationParameter.prototype.subAgg - {object}
33+
* @member {SuperMap.AggregationParameter} SuperMap.AggregationParameter.prototype.subAgg
3434
* @description 子聚合
3535
*/
3636
this.subAgg = null;

‎src/common/iServer/FilterAggParameter.js‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,27 @@ import {SuperMap} from "../SuperMap";
22
import {AggregationType} from '../REST';
33
import {Util} from '../commontypes/Util';
44
import {AggregationParameter} from "./AggregationParameter";
5+
import {AggQueryBuilderParameter} from "./AggQueryBuilderParameter";
56

67
/**
7-
* @class SuperMap.FilterAggParameter
8-
* @classdesc 过滤条件参数设置,该参数仅支持数据来源Elasticsearch服务的数据服务
9-
* @category iServer Data FeatureResults
10-
* @param {object} option 初始化参数 <br>
11-
* @param {object} filterParam 过滤条件参数设置类 <br>
12-
* @param {String} aggType 聚合类型 <br>
8+
* @class SuperMap.FilterAggParameter
9+
* @classdesc 过滤条件参数设置,该参数仅支持数据来源Elasticsearch服务的数据服务
10+
* @category iServer Data FeatureResults
11+
* @param {Object} options - 初始化参数 <br>
12+
* @param {SuperMap.AggQueryBuilderParameter} options.filterParam - 过滤条件参数设置类 <br>
13+
* @param {SuperMap.AggregationType} [options.aggType=SuperMap.AggregationType.FILTER] - 聚合类型 <br>
1314
*/
1415
export class FilterAggParameter extends AggregationParameter {
1516

1617
constructor(options) {
1718
super(options);
1819
/**
19-
* @member SuperMap.FilterAggParameter.prototype.filterParam -{object}
20-
* @description 过滤条件参数设置类
20+
* @member {SuperMap.AggQueryBuilderParameter} SuperMap.FilterAggParameter.prototype.filterParam
21+
* @description 过滤条件参数设置类
2122
*/
2223
this.filterParam = null;
2324
/**
24-
* @member SuperMap.FilterAggParameter.prototype.aggType -{String}
25+
* @member {SuperMap.AggregationType} [SuperMap.FilterAggParameter.prototype.aggType=SuperMap.AggregationType.FILTER]
2526
* @description 聚合类型
2627
*/
2728
this.aggType = AggregationType.FILTER;

‎src/common/iServer/GeoBoundingBoxQueryBuilderParameter.js‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,24 @@ import {AggregationQueryBuilderType} from "../REST";
44
import {AggQueryBuilderParameter} from "./AggQueryBuilderParameter";
55

66
/**
7-
* @class SuperMap.GeoBoundingBoxQueryBuilderParameter
8-
* @classdesc bounds查询参数设置类,该参数仅支持数据来源Elasticsearch服务的数据服务
9-
* @category iServer Data FeatureResults
10-
* @param {object} option 初始化参数 <br>
11-
* @param {String} bounds 查询范围 <br>
12-
* @param {String} queryType 查询类型 <br>
7+
* @class SuperMap.GeoBoundingBoxQueryBuilderParameter
8+
* @classdesc bounds查询参数设置类,该参数仅支持数据来源Elasticsearch服务的数据服务
9+
* @category iServer Data FeatureResults
10+
* @param {Object} options - 初始化参数 <br>
11+
* @param {(SuperMap.Bounds|L.Bounds|ol.extent)} options.bounds - 查询范围。 <br>
12+
* @param {SuperMap.AggregationQueryBuilderType} [options.queryType=SuperMap.AggregationQueryBuilderType.GEO_BOUNDING_BOX] - 查询类型 <br>
1313
*/
1414
export class GeoBoundingBoxQueryBuilderParameter extends AggQueryBuilderParameter {
1515
constructor(options) {
1616
super(options);
1717
/**
18-
* @member SuperMap.GeoBoundingBoxQueryBuilderParameter.prototype.bounds -{String}
19-
* @description 查询范围
18+
* @member {(SuperMap.Bounds|L.Bounds|ol.extent)} SuperMap.GeoBoundingBoxQueryBuilderParameter.prototype.bounds
19+
* @description 查询范围。
2020
*/
2121
this.bounds = null;
2222

2323
/**
24-
* @member SuperMap.GeoBoundingBoxQueryBuilderParameter.prototype.queryType -{String}
24+
* @member {SuperMap.AggregationQueryBuilderType} [SuperMap.GeoBoundingBoxQueryBuilderParameter.prototype.queryType=SuperMap.AggregationQueryBuilderType.GEO_BOUNDING_BOX]
2525
* @description 查询类型
2626
*/
2727
this.queryType = AggregationQueryBuilderType.GEO_BOUNDING_BOX;

‎src/common/iServer/GeoHashGridAggParameter.js‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,23 @@ import {Util} from '../commontypes/Util';
44
import {AggregationParameter} from "./AggregationParameter";
55

66
/**
7-
* @class SuperMap.GeoHashGridAggParameter
8-
* @classdesc 格网聚合查询参数类,该参数仅支持数据来源Elasticsearch服务的数据服务
9-
* @category iServer Data FeatureResults
10-
* @param {object} option 初始化参数 <br>
11-
* @param {number} precision 网格中数字的精度 <br>
12-
* @param {String} aggType 格网聚合类型 <br>
7+
* @class SuperMap.GeoHashGridAggParameter
8+
* @classdesc 格网聚合查询参数类,该参数仅支持数据来源Elasticsearch服务的数据服务
9+
* @category iServer Data FeatureResults
10+
* @param {Object} option - 初始化参数 <br>
11+
* @param {number} [option.precision=5] - 网格中数字的精度 <br>
12+
* @param {SuperMap.AggregationType} [option.aggType=SuperMap.AggregationType.GEOHASH_GRID] - 格网聚合类型 <br>
1313
*/
1414
export class GeoHashGridAggParameter extends AggregationParameter {
1515
constructor(option) {
1616
super(option);
1717
/**
18-
* @member SuperMap.GeoHashGridAggParameter.prototype.precision -{number}
18+
* @member {number} [SuperMap.GeoHashGridAggParameter.prototype.precision=5]
1919
* @description 网格中数字的精度，默认为5
2020
*/
2121
this.precision = 5;
2222
/**
23-
* @member SuperMap.GeoHashGridAggParameter.aggType.precision -{String}
23+
* @member {SuperMap.AggregationType} [SuperMap.GeoHashGridAggParameter.prototype.aggType=SuperMap.AggregationType.GEOHASH_GRID]
2424
* @description 格网聚合类型
2525
*/
2626
this.aggType = AggregationType.GEOHASH_GRID;
@@ -39,7 +39,7 @@ export class GeoHashGridAggParameter extends AggregationParameter {
3939
* @function SuperMap.GeoHashGridAggParameter.toJsonParameters
4040
* @description 将对象转为json格式
4141
* @param param 转换对象
42-
* @returns {string|Object}
42+
* @returns {string|object}
4343
*/
4444
static toJsonParameters(param) {
4545
var parameters = {

0 commit comments

Comments
 (0)