Skip to content

Commit a7867a4

Browse files
chenmeiyiSupermapchenmeiyiSupermap
committed
【API】common/iServer下A-E开头的文件，规范API写法、修改错误的API描述。
1 parent 076eac4 commit a7867a4

31 files changed

+473
-476
lines changed

‎src/common/iServer/AddressMatchService.js‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ import {GeoDecodingParameter} from './GeoDecodingParameter';
66

77
/**
88
* @class SuperMap.AddressMatchService
9-
* @category iServer AddressMatch
9+
* @category iServer AddressMatch
1010
* @classdesc 地址匹配服务，包括正向匹配和反向匹配。
11-
* @param options - {Object} 参数。
12-
* @param url {string} 地址匹配服务地址。
11+
* @param {string} url - 地址匹配服务地址。
12+
* @param {Object} options - 参数。
1313
*/
1414
export class AddressMatchService extends CommonServiceBase {
1515

@@ -28,8 +28,8 @@ export class AddressMatchService extends CommonServiceBase {
2828

2929
/**
3030
* @function SuperMap.AddressMatchService.prototype.code
31-
* @param url {string} 正向地址匹配服务地址
32-
* @param params {SuperMap.GeoCodingParameter} 正向地址匹配服务参数
31+
* @param {string} url - 正向地址匹配服务地址。
32+
* @param {SuperMap.GeoCodingParameter} params - 正向地址匹配服务参数。
3333
*/
3434
code(url, params) {
3535
if (!(params instanceof GeoCodingParameter)) {
@@ -40,8 +40,8 @@ export class AddressMatchService extends CommonServiceBase {
4040

4141
/**
4242
* @function SuperMap.AddressMatchService.prototype.decode
43-
* @param url {string} 反向地址匹配服务地址
44-
* @param params {SuperMap.GeoDecodingParameter} 反向地址匹配服务参数
43+
* @param {string} url - 反向地址匹配服务地址。
44+
* @param {SuperMap.GeoDecodingParameter} params - 反向地址匹配服务参数。
4545
*/
4646
decode(url, params) {
4747
if (!(params instanceof GeoDecodingParameter)) {
@@ -53,8 +53,8 @@ export class AddressMatchService extends CommonServiceBase {
5353
/**
5454
* @function SuperMap.AddressMatchService.prototype.processAsync
5555
* @description 负责将客户端的动态分段服务参数传递到服务端。
56-
* @param url - {string} 服务地址
57-
* @param params - {Object} 参数
56+
* @param {string} url - 服务地址。
57+
* @param {Object} params - 参数。
5858
*/
5959

6060
processAsync(url, params) {
@@ -74,7 +74,7 @@ export class AddressMatchService extends CommonServiceBase {
7474

7575
/**
7676
* @function SuperMap.AddressMatchService.prototype.serviceProcessCompleted
77-
* @param result - {Object} 服务器返回的结果对象。
77+
* @param {Object} result - 服务器返回的结果对象。
7878
* @description 服务流程是否完成
7979
*/
8080
serviceProcessCompleted(result) {
@@ -83,7 +83,7 @@ export class AddressMatchService extends CommonServiceBase {
8383

8484
/**
8585
* @function SuperMap.AddressMatchService.prototype.serviceProcessCompleted
86-
* @param result - {Object} 服务器返回的结果对象。
86+
* @param {Object} result - 服务器返回的结果对象。
8787
* @description 服务流程是否失败
8888
*/
8989
serviceProcessFailed(result) {

‎src/common/iServer/AreaSolarRadiationParameters.js‎

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

44
/**
55
* @class SuperMap.AreaSolarRadiationParameters
6-
* @category iServer SpatialAnalyst SolarradiationAnalyst
6+
* @category iServer SpatialAnalyst SolarRadiationAnalyst
77
* @classdesc 地区太阳辐射参数类。
8-
* @param options -{Object} 可选参数。如:</br>
9-
* dataset - {string} 要用来做地区太阳辐射数据源中数据集的名称。该名称用形如"数据集名称@数据源别名"的形式来表示，例如：JingjinTerrain@Jingjin。（必设参数）。</br>
10-
* targetDatasourceName - {string} 指定的存储结果数据集的数据源名称（必设参数）, 例如："Jingjin"。</br>
11-
* totalGridName - {string} 指定地区太阳辐射总辐射量数据集的名称（必设参数）。</br>
12-
* diffuseDatasetGridName - {string} 指定地区太阳辐射散射辐射量数据集的名称。</br>
13-
* durationDatasetGridName - {string} 指定地区太阳辐射太阳直射持续时间数据集的名称。</br>
14-
* directDatasetGridName - {string} 指定地区太阳辐射直射辐射量数据集的名称。</br>
15-
* latitude - {number} 待计算区域的纬度值。</br>
16-
* timeMode - {string} 时间模式。可选值"WITHINDAY"（单日）或"MULTIDAYS"（多日），默认值为"MULTIDAYS"。</br>
17-
* dayStart - {number} 起始日期（年内的第几天）。（必设参数）</br>
18-
* dayEnd - {number} 结束日期（年内的第几天）。（必设参数）</br>
19-
* hourStart - {number} 起始时间（一天中的第几个小时）。</br>
20-
* hourEnd - {number} 结束时间（一天中的第几个小时）。</br>
21-
* transmittance - {number} 太阳辐射穿过大气的透射率。</br>
22-
* hourInterval - {number} 计算时的小时间隔（设置的越小计算量越大并且计算结果更精确, 默认为0.5小时，如果修改此参数，必须使用整数）</br>
23-
* dayInterval - {number} 计算时的天数间隔（设置的越小计算量越大并且计算结果更精确, 默认为5天，必须使用整数）</br>
24-
* deleteExistResultDataset - {boolean} 如果用户命名的结果数据集名称与已有的数据集重名，是否删除已有的数据集。默认为 false，即不删除。
8+
* @param {Object} options - 参数。</br>
9+
* @param {string} options.dataset - 要用来做地区太阳辐射数据源中数据集的名称（必设参数）。该名称用形如"数据集名称@数据源别名"的形式来表示，例如：JingjinTerrain@Jingjin。</br>
10+
* @param {string} options.targetDatasourceName - 指定的存储结果数据集的数据源名称（必设参数）, 例如："Jingjin"。</br>
11+
* @param {string} options.totalGridName - 指定地区太阳辐射总辐射量数据集的名称（必设参数）。</br>
12+
* @param {string} options.diffuseDatasetGridName - 指定地区太阳辐射散射辐射量数据集的名称。</br>
13+
* @param {string} options.durationDatasetGridName - 指定地区太阳辐射太阳直射持续时间数据集的名称。</br>
14+
* @param {string} options.directDatasetGridName - 指定地区太阳辐射直射辐射量数据集的名称。</br>
15+
* @param {number} options.latitude - 待计算区域的纬度值。</br>
16+
* @param {string} [options.timeMode = "MULTIDAYS"] - 时间模式。可选值"WITHINDAY"（单日）或"MULTIDAYS"（多日）。</br>
17+
* @param {number} options.dayStart - 起始日期（年内的第几天），必设参数。</br>
18+
* @param {number} options.dayEnd - 结束日期（年内的第几天），必设参数。</br>
19+
* @param {number} options.hourStart - 起始时间（一天中的第几个小时）。</br>
20+
* @param {number} options.hourEnd - 结束时间（一天中的第几个小时）。</br>
21+
* @param {number} options.transmittance - 太阳辐射穿过大气的透射率。</br>
22+
* @param {number} [options.hourInterval=0.5] - 计算时的小时间隔（设置的越小计算量越大并且计算结果更精确, 默认为0.5小时，如果修改此参数，必须使用整数）。</br>
23+
* @param {number} [options.dayInterval=5] - 计算时的天数间隔（设置的越小计算量越大并且计算结果更精确, 默认为5天，必须使用整数）。</br>
24+
* @param {boolean} [options.deleteExistResultDataset=false] - 如果用户命名的结果数据集名称与已有的数据集重名，是否删除已有的数据集。
2525
*/
2626
export class AreaSolarRadiationParameters {
2727

2828
constructor(options) {
2929
/**
30-
* @member SuperMap.AreaSolarRadiationParameters.prototype.dataset - {string}
31-
* @description 要用来做地区太阳辐射数据源中数据集的名称。该名称用形如"数据集名称@数据源别名"形式来表示，例如：JingjinTerrain@Jingjin （必设参数）。注：地区太阳辐射数据必须为栅格数据集。
30+
* @member {string} SuperMap.AreaSolarRadiationParameters.prototype.dataset
31+
* @description 要用来做地区太阳辐射数据源中数据集的名称（必设参数）。该名称用形如"数据集名称@数据源别名"形式来表示，例如：JingjinTerrain@Jingjin。注：地区太阳辐射数据必须为栅格数据集。
3232
*/
3333
this.dataset = null;
3434

3535
/**
36-
* @member SuperMap.AreaSolarRadiationParameters.prototype.targetDatasourceName - {string}
36+
* @member {string} SuperMap.AreaSolarRadiationParameters.prototype.targetDatasourceName
3737
* @description 指定的存储结果数据集的数据源名称（必设参数），例如："Jingjin"。
3838
*/
3939
this.targetDatasourceName = null;
4040

4141
/**
42-
* @member SuperMap.AreaSolarRadiationParameters.prototype.totalGridName - {string}
42+
* @member {string} SuperMap.AreaSolarRadiationParameters.prototype.totalGridName
4343
* @description 指定地区太阳辐射总辐射量数据集的名称（必设参数）。
4444
*/
4545
this.totalGridName = null;
4646

4747
/**
48-
* @member SuperMap.AreaSolarRadiationParameters.prototype.diffuseDatasetGridName - {string}
48+
* @member {string} SuperMap.AreaSolarRadiationParameters.prototype.diffuseDatasetGridName
4949
* @description 指定地区太阳辐射散射辐射量数据集的名称。
5050
*/
5151
this.diffuseDatasetGridName = null;
5252

5353
/**
54-
* @member SuperMap.AreaSolarRadiationParameters.prototype.durationDatasetGridName - {string}
54+
* @member {string} SuperMap.AreaSolarRadiationParameters.prototype.durationDatasetGridName
5555
* @description 指定地区太阳辐射太阳直射持续时间数据集的名称。
5656
*/
5757
this.durationDatasetGridName = null;
5858

5959
/**
60-
* @member SuperMap.AreaSolarRadiationParameters.prototype.durationDatasetGridName - {string}
60+
* @member {string} SuperMap.AreaSolarRadiationParameters.prototype.durationDatasetGridName
6161
* @description 指定地区太阳辐射直射辐射量数据集的名称。
6262
*/
6363
this.directDatasetGridName = null;
6464

6565
/**
66-
* @member SuperMap.AreaSolarRadiationParameters.prototype.latitude - {number}
66+
* @member {number} SuperMap.AreaSolarRadiationParameters.prototype.latitude
6767
* @description 待计算区域的纬度值。
6868
*/
6969
this.latitude = null;
7070

7171
/**
72-
* @member SuperMap.AreaSolarRadiationParameters.prototype.timeMode - {string}
72+
* @member {string} SuperMap.AreaSolarRadiationParameters.prototype.timeMode
7373
* @description 时间模式。可选值"WITHINDAY"（单日）或"MULTIDAYS"（多日），默认值为"MULTIDAYS";
7474
*/
7575
this.timeMode = "MULTIDAYS";
7676

7777
/**
78-
* @member SuperMap.AreaSolarRadiationParameters.prototype.dayStart - {number}
79-
* @description 起始日期（年内的第几天）。（必设参数）
78+
* @member {number} SuperMap.AreaSolarRadiationParameters.prototype.dayStart
79+
* @description 起始日期（年内的第几天），必设参数。
8080
*/
8181
this.dayStart = null;
8282

8383
/**
84-
* @member SuperMap.AreaSolarRadiationParameters.prototype.dayEnd - {number}
85-
* @description 结束日期（年内的第几天）。（必设参数）
84+
* @member {number} SuperMap.AreaSolarRadiationParameters.prototype.dayEnd
85+
* @description 结束日期（年内的第几天），必设参数。
8686
*/
8787
this.dayEnd = null;
8888

8989
/**
90-
* @member SuperMap.AreaSolarRadiationParameters.prototype.hourStart - {number}
90+
* @member {number} SuperMap.AreaSolarRadiationParameters.prototype.hourStart
9191
* @description 起始时间（一天中的第几个小时）。
9292
*/
9393
this.hourStart = null;
9494

9595
/**
96-
* @member SuperMap.AreaSolarRadiationParameters.prototype.hourEnd - {number}
96+
* @member {number} SuperMap.AreaSolarRadiationParameters.prototype.hourEnd
9797
* @description 结束时间（一天中的第几个小时）。
9898
*/
9999
this.hourEnd = null;
100100

101101
/**
102-
* @member SuperMap.AreaSolarRadiationParameters.prototype.transmittance - {number}
102+
* @member {number} SuperMap.AreaSolarRadiationParameters.prototype.transmittance
103103
* @description 太阳辐射穿过大气的透射率。
104104
*/
105105
this.transmittance = null;
106106

107107
/**
108-
* @member SuperMap.AreaSolarRadiationParameters.prototype.hourInterval - {number}
108+
* @member {number} SuperMap.AreaSolarRadiationParameters.prototype.hourInterval
109109
* @description 计算时的小时间隔（设置的越小计算量越大并且计算结果更精确, 默认为0.5小时，如果修改此参数，必须使用整数）
110110
*/
111111
this.hourInterval = null;
112112

113113
/**
114-
* @member SuperMap.AreaSolarRadiationParameters.prototype.dayInterval - {number}
114+
* @member {number} SuperMap.AreaSolarRadiationParameters.prototype.dayInterval
115115
* @description 计算时的天数间隔（设置的越小计算量越大并且计算结果更精确, 默认为5天，必须使用整数）
116116
*/
117117
this.dayInterval = null;
118118

119119
/**
120-
* @member SuperMap.AreaSolarRadiationParameters.prototype.deleteExistResultDataset - {boolean}
120+
* @member {boolean} SuperMap.AreaSolarRadiationParameters.prototype.deleteExistResultDataset
121121
* @description 如果用户命名的结果数据集名称与已有的数据集重名，是否删除已有的数据集。默认为 false，即不删除。
122122
*/
123123
this.deleteExistResultDataset = false;
@@ -143,9 +143,9 @@ export class AreaSolarRadiationParameters {
143143

144144
/**
145145
* @function SuperMap.AreaSolarRadiationParameters.toObject
146-
* @param param - {SuperMap.AreaSolarRadiationParameters} 地区太阳辐射参数类。
147-
* @param tempObj - {SuperMap.AreaSolarRadiationParameters} 地区太阳辐射参数对象。
148-
* @return {object} JSON对象。
146+
* @param {SuperMap.AreaSolarRadiationParameters} param - 地区太阳辐射参数类。
147+
* @param {SuperMap.AreaSolarRadiationParameters} tempObj - 地区太阳辐射参数对象。
148+
* @returns {Object} JSON对象。
149149
* @description 将SuperMap.AreaSolarRadiationParameters对象转换成JSON对象。
150150
*/
151151
static toObject(param, tempObj) {

‎src/common/iServer/AreaSolarRadiationService.js‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ import {Util} from '../commontypes/Util';
55

66
/**
77
* @class SuperMap.AreaSolarRadiationService
8-
* @category iServer SpatialAnalyst SolarradiationAnalyst
8+
* @category iServer SpatialAnalyst SolarRadiationAnalyst
99
* @classdesc 地区太阳辐射服务类。
10-
* @param url - {string} 服务的访问地址。如</br> http://localhost:8090/iserver/services/spatialanalyst-sample/restjsr/spatialanalyst 。</br>
11-
* @param options - {Object} 参数。如:</br>
12-
* eventListeners - {Object} 需要被注册的监听器对象。
13-
* @extends SuperMap.SpatialAnalystBase
10+
* @param {string} url - 服务的访问地址。如：</br>http://localhost:8090/iserver/services/spatialanalyst-sample/restjsr/spatialanalyst。</br>
11+
* @param {Object} options - 参数。</br>
12+
* @param {Object} options.eventListeners - 需要被注册的监听器对象。
13+
* @extends {SuperMap.SpatialAnalystBase}
1414
* @example 例如：
1515
* (start code)
1616
* var myAreaSolarRadiationService = new SuperMap.AreaSolarRadiationService(url);
@@ -39,8 +39,8 @@ export class AreaSolarRadiationService extends SpatialAnalystBase {
3939

4040
/**
4141
* @function SuperMap.AreaSolarRadiationService.prototype.processAsync
42-
* @description 负责将客户端的查询参数传递到服务端。
43-
* @param parameter - {SuperMap.AreaSolarRadiationParameters} 地区太阳辐射参数
42+
* @description 负责将客户端的查询参数传递到服务端。
43+
* @param {SuperMap.AreaSolarRadiationParameters} parameter - 地区太阳辐射参数。
4444
*/
4545
processAsync(parameter) {
4646
if (!(parameter instanceof AreaSolarRadiationParameters)) {

‎src/common/iServer/BufferAnalystParameters.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@ import {BufferSetting} from './BufferSetting';
44

55
/**
66
* @class SuperMap.BufferAnalystParameters
7-
* @category iServer SpatialAnalyst BufferAnalyst
7+
* @category iServer SpatialAnalyst BufferAnalyst
88
* @classdesc 缓冲区分析参数基类。
9-
* @param options - {Object} 参数。如:</br>
10-
* bufferSetting - {@link SuperMap.BufferSetting} 设置缓冲区通用参数。为缓冲区分析提供必要的参数信息，包括左缓冲距离、右缓冲距离、端点类型、圆头缓冲圆弧处线段的个数信息。
9+
* @param {Object} options - 参数。</br>
10+
* @param {SuperMap.BufferSetting} options.bufferSetting - 设置缓冲区通用参数。为缓冲区分析提供必要的参数信息，包括左缓冲距离、右缓冲距离、端点类型、圆头缓冲圆弧处线段的个数信息。
1111
*/
1212
export class BufferAnalystParameters {
1313

1414

1515
constructor(options) {
1616
var me = this;
1717
/**
18-
* @member SuperMap.BufferAnalystParameters.prototype.bufferSetting - {SuperMap.BufferSetting}
18+
* @member {SuperMap.BufferSetting} SuperMap.BufferAnalystParameters.prototype.bufferSetting
1919
* @description 设置缓冲区通用参数。为缓冲区分析提供必要的参数信息，包括左缓冲距离、右缓冲距离、端点类型、圆头缓冲圆弧处线段的个数信息。
2020
*/
2121
me.bufferSetting = new BufferSetting();

‎src/common/iServer/BufferAnalystService.js‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ import {GeometryBufferAnalystParameters} from './GeometryBufferAnalystParameters
66

77
/**
88
* @class SuperMap.BufferAnalystService
9-
* @category iServer SpatialAnalyst BufferAnalyst
10-
* @classdesc 缓冲区分析服务类
9+
* @category iServer SpatialAnalyst BufferAnalyst
10+
* @classdesc 缓冲区分析服务类。
1111
* 该类负责将客户设置的缓冲区分析参数传递给服务端，并接收服务端返回的缓冲区分析结果数据。
12-
* 缓冲区分析结果通过该类支持的事件的监听函数参数获取
13-
* @param url - {string} 服务的访问地址。如 http://localhost:8090/iserver/services/spatialanalyst-changchun/restjsr/spatialanalyst 。
14-
* @param options - {Object} 可选参数。如:</br>
15-
* eventListeners - {Object} 需要被注册的监听器对象。
16-
* @extends SuperMap.SpatialAnalystBase
12+
* 缓冲区分析结果通过该类支持的事件的监听函数参数获取。
13+
* @param {string} url - 服务的访问地址。如：http://localhost:8090/iserver/services/spatialanalyst-changchun/restjsr/spatialanalyst。
14+
* @param {Object} options - 参数。</br>
15+
* @param {object} options.eventListeners - 需要被注册的监听器对象。
16+
* @extends {SuperMap.SpatialAnalystBase}
1717
* @example 例如：
1818
* (start code)
1919
* var myBufferAnalystService = new SuperMap.BufferAnalystService(url, {
@@ -32,7 +32,7 @@ export class BufferAnalystService extends SpatialAnalystBase {
3232
constructor(url, options) {
3333
super(url, options);
3434
/**
35-
* @member SuperMap.BufferAnalystService.prototype.mode -{string}
35+
* @member {string} SuperMap.BufferAnalystService.prototype.mode
3636
* @description 缓冲区分析类型
3737
*/
3838
this.mode = null;
@@ -56,7 +56,7 @@ export class BufferAnalystService extends SpatialAnalystBase {
5656
/**
5757
* @method SuperMap.BufferAnalystService.prototype.processAsync
5858
* @description 负责将客户端的查询参数传递到服务端。
59-
* @param parameter - {BufferAnalystParameters} 缓冲区分析参数
59+
* @param {SuperMap.BufferAnalystParameters} parameter - 缓冲区分析参数
6060
*/
6161
processAsync(parameter) {
6262
var parameterObject = {};

0 commit comments

Comments
 (0)