Skip to content

Commit 6a878da

Browse files
author
caoxinke
committed
common 下注释修改统一；新增leaflet、legacy注释。 commit by tangqin review by caoxinke
1 parent 60bceab commit 6a878da

File tree

184 files changed

+5768
-4142
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

184 files changed

+5768
-4142
lines changed

‎dist/iclient9-leaflet.js‎

Lines changed: 2294 additions & 1397 deletions
Large diffs are not rendered by default.

‎dist/iclient9-leaflet.min.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/iclient9-legacy.js‎

Lines changed: 249 additions & 111 deletions
Large diffs are not rendered by default.

‎dist/iclient9-openlayers.js‎

Lines changed: 801 additions & 1156 deletions
Large diffs are not rendered by default.

‎src/common/control/TimeControlBase.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import SuperMap from '../SuperMap';
22

33
/**
44
* @class SuperMap.TimeControlBase
5-
* @description 时间控制基类类。
5+
* @classdesc 时间控制基类类。
66
* @param options - {Object} 该类开放的可选属性。如：<br>
77
* speed - {Number} 速度。不能小于0，默认为1（表示每帧渲染的数据之间的间隔为1），设置越大速度越快。<br>
88
* startTime - {Number} 的起始时间，必须为数字，且小于等于endTime。如果不设置，初始化时为0，建议设置。<br>

‎src/common/control/TimeFlowControl.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ import TimeControlBase from './TimeControlBase';
33

44
/**
55
* @class SuperMap.TimeControl
6-
* @description 时间管理类。<br>
6+
* @classdesc 时间管理类。<br>
77
* 此类只负责时间上的控制，具体执行的操作需要用户在初始化时的回调函数内部进行实现。<br>
88
* 如设置起始时间为1000，结束时间是2000，步长设置为1，
99
* 那么表示按照每次1年（可以通过setSpeed进行修改）的变化从公元1000年开始到公元2000年为止，默认每1秒会1次(通过setFrequency修改)
10-
* @augments SuperMap.TimeControlBase
10+
* @extends SuperMap.TimeControlBase
1111
* @param callback - {Function} 每次刷新回调函数，必设属性。具体的效果需要用户在此回调函数里面实现。
1212
* @param options - {Object} 该类开放的可选属性。如：<br>
1313
* speed - {Number} 步长(单位ms)。不能小于0，默认为1（表示每次刷新的数据之间的间隔为1ms）。<br>

‎src/common/format/Format.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import SuperMap from '../SuperMap';
22
/**
33
* @class SuperMap.Format
4-
* @description 读写各种格式的格式类基类。其子类应该包含并实现read和write方法。
4+
* @classdesc 读写各种格式的格式类基类。其子类应该包含并实现read和write方法。
55
* @param options - {Object} 选项对象，其属性会被直接设置到format实例。如：<br>
66
* keepData - {Boolean} 如果设置为true， <data> 属性会指向被解析的对象（例如json或xml数据对象）。
77
* @return {SuperMap.Format} 实例。

‎src/common/format/JSON.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
import Format from './Format';
33
/**
44
* @class SuperMap.Format.JSON
5-
* @description 安全的读写JSON的解析类。使用<SuperMap.Format.JSON> 构造函数创建新实例。
6-
* @augments SuperMap.Format
5+
* @classdesc 安全的读写JSON的解析类。使用<SuperMap.Format.JSON> 构造函数创建新实例。
6+
* @extends SuperMap.Format
77
* @param options - {Object} 选项对象，其属性会被直接设置到JSON实例。
88
*/
99
export default class JSONFormat extends Format {

‎src/common/iServer/BuildCacheJobParameter.js‎

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import SuperMap from '../SuperMap';
22

33
/**
44
* @class SuperMap.BuildCacheJobParameter
5-
* @description 地图缓存参数类
5+
* @classdesc 地图缓存参数类
66
* @param options - {Object} 可选参数。如：<br>
77
* datasetName - {String} 数据集名称。<br>
88
* cacheName - {String} 缓存名称。<br>
@@ -16,75 +16,61 @@ import SuperMap from '../SuperMap';
1616
*/
1717
export default class BuildCacheJobParameter {
1818
/**
19-
* APIProperty: datasetName
2019
* @member SuperMap.BuildCacheJobParameter.prototype.datasetName -{String}
2120
* @description 数据集名称。
2221
*/
2322
datasetName= "";
2423

2524
/**
26-
* APIProperty: cacheName
2725
* @member SuperMap.BuildCacheJobParameter.prototype.cacheName -{String}
2826
* @description 缓存名称。
2927
*/
3028
cacheName= "";
3129

3230

3331
/**
34-
* APIProperty: cacheType
3532
* @member SuperMap.BuildCacheJobParameter.prototype.cacheType -{String}
3633
* @description 存储类型。
3734
*/
3835
cacheType= "";
3936

4037

4138
/**
42-
* APIProperty: serverAddresses
4339
* @member SuperMap.BuildCacheJobParameter.prototype.serverAddresses -{String}
4440
* @description MongoDB地址。
4541
*/
46-
4742
serverAdresses= "";
4843

4944

5045
/**
51-
* APIProperty: database
5246
* @member SuperMap.BuildCacheJobParameter.prototype.database -{String}
5347
* @description 数据库。
5448
*/
55-
5649
database= "";
5750

5851

5952
/**
60-
* APIProperty: version
6153
* @member SuperMap.BuildCacheJobParameter.prototype.version -{String}
6254
* @description 版本。
6355
*/
64-
6556
version= "";
6657

6758

6859
/**
69-
* APIProperty: bounds
7060
* @member SuperMap.BuildCacheJobParameter.prototype.bounds -{SuperMap.Bounds}
7161
* @description 缓存范围。
7262
*/
73-
7463
bounds= "";
7564

7665

7766
/**
78-
* APIProperty: imageType
7967
* @member SuperMap.BuildCacheJobParameter.prototype.imageType -{number}
8068
* @description 缓存类型。
8169
*/
82-
8370
imageType= 'Heatmap';
8471

8572

8673
/**
87-
* APIProperty: level
8874
* @member SuperMap.BuildCacheJobParameter.prototype.level -{number}
8975
* @description 缓存比例尺级别。
9076
*/
@@ -99,7 +85,6 @@ export default class BuildCacheJobParameter {
9985

10086

10187
/**
102-
* APIMethod: destroy
10388
* @function destroy
10489
* @description 释放资源，将引用资源的属性置空。
10590
*/

‎src/common/iServer/BuildCacheJobsService.js‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,15 @@ import BuildCacheJobParameter from './BuildCacheJobParameter';
44

55
/**
66
* @class SuperMap.BuildCacheJobsService
7-
* @description 创建大数据缓存服务类
8-
* @augments SuperMap.ProcessingServiceBase
7+
* @classdesc 创建大数据缓存服务类
8+
* @extends SuperMap.ProcessingServiceBase
99
* @param url -{String} 大数据缓存服务地址。
1010
* @param options - {Object} 交互服务时所需可选参数。
1111
*/
12-
1312
export default class BuildCacheJobsService extends ProcessingServiceBase {
1413

15-
/**
16-
* @function SuperMap.BuildCacheJobsService.constructor
14+
/*
15+
* @function SuperMap.BuildCacheJobsService.prototype.constructor
1716
* @description SuperMap.BuildCacheJobsService 的构造函数
1817
* @param url -{String} 大数据缓存服务地址。
1918
* @param options - {Object} 交互服务时所需可选参数。
@@ -31,15 +30,15 @@ export default class BuildCacheJobsService extends ProcessingServiceBase {
3130
}
3231

3332
/**
34-
* @function SuperMap.BuildCacheJobsService.getBuildCacheJobs
33+
* @function SuperMap.BuildCacheJobsService.prototype.getBuildCacheJobs
3534
* @description 获取创建的大数据缓存
3635
*/
3736
getBuildCacheJobs() {
3837
return super.getJobs(this.url);
3938
}
4039

4140
/**
42-
* @function SuperMap.BuildCacheJobsService.getBuildCacheJob
41+
* @function SuperMap.BuildCacheJobsService.prototype.getBuildCacheJob
4342
* @description 获取指定 id的大数据缓存
4443
* @param id - {String} 大数据缓存id
4544
*/
@@ -48,9 +47,9 @@ export default class BuildCacheJobsService extends ProcessingServiceBase {
4847
}
4948

5049
/**
51-
* @function SuperMap.BuildCacheJobsService.addBuildCacheJob
50+
* @function SuperMap.BuildCacheJobsService.prototype.addBuildCacheJob
5251
* @description 新建大数据缓存服务
53-
* @param params - {BuildCacheJobParameter}地图缓存参数类
52+
* @param params - {SuperMap.BuildCacheJobParameter} 地图缓存参数类
5453
* @param seconds - {String} 开始创建后，获取创建成功结果的时间间隔
5554
*/
5655
addBuildCacheJob(params, seconds) {

0 commit comments

Comments
 (0)