Skip to content

Commit 2c6c2df

Browse files
wuzhuorui5wuzhuorui5
committed
index on master: 95c7d06 修改部分API，统一修改数据类型大小写。增加leaflet链接。增加leaflet下部分文件@pravite标签。review by caoxinke。
1 parent 95c7d06 commit 2c6c2df

Some content is hidden

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

41 files changed

+581
-269
lines changed

‎src/common/iServer/GetFeaturesByBoundsParameters.js‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ import GetFeaturesParametersBase from './GetFeaturesParametersBase';
88
* @classdesc 数据集范围查询参数类,该类用于设置数据集范围查询的相关参数。
99
* @param options - {Object} 参数。如：<br>
1010
* bounds - {SuperMap.Bounds} 用于查询的范围对象。</br>
11-
* attributeFilter - {string} 范围查询属性过滤条件。</br>
12-
* fields - {Array(String)} 设置查询结果返回字段。默认返回所有字段。</br>
11+
* attributeFilter - {String} 范围查询属性过滤条件。</br>
12+
* fields - {Array<String>} 设置查询结果返回字段。默认返回所有字段。</br>
1313
* spatialQueryMode - {SuperMap.SpatialQueryMode} 空间查询模式常量,必设参数。</br>
1414
* queryParameter - {SuperMap.FilterParameter} 查询过滤条件参数。</br>
15-
* datasetNames - {Array(String)} 数据集集合中的数据集名称列表。</br>
16-
* returnContent - {boolean} 是否直接返回查询结果。</br>
15+
* datasetNames - {Array<String>} 数据集集合中的数据集名称列表。</br>
16+
* returnContent - {Boolean} 是否直接返回查询结果。</br>
1717
* fromIndex - {Integer} 查询结果的最小索引号。</br>
1818
* toIndex - {Integer} 查询结果的最大索引号。</br>
1919
* @extends SuperMap.GetFeaturesParametersBase
2020
*/
2121

2222
export default class GetFeaturesByBoundsParameters extends GetFeaturesParametersBase {
2323
/**
24-
* @member SuperMap.GetFeaturesByBoundsParameters.prototype.getFeatureMode -{string}
24+
* @member SuperMap.GetFeaturesByBoundsParameters.prototype.getFeatureMode -{String}
2525
* @description 数据集查询模式。
2626
* 范围查询有"BOUNDS"，"BOUNDS_ATTRIBUTEFILTER"两种,当用户设置attributeFilter时会自动切换到BOUNDS_ATTRIBUTEFILTER访问服务。
2727
*/
@@ -35,13 +35,13 @@ export default class GetFeaturesByBoundsParameters extends GetFeaturesParameters
3535
bounds = null;
3636

3737
/**
38-
* @member SuperMap.GetFeaturesByBoundsParameters.prototype.fields -{Array(String)}
38+
* @member SuperMap.GetFeaturesByBoundsParameters.prototype.fields -{Array<String>}
3939
* @description 设置查询结果返回字段。当指定了返回结果字段后，则 GetFeaturesResult 中的 features 的属性字段只包含所指定的字段。不设置即返回全部字段。
4040
*/
4141
fields = null;
4242

4343
/**
44-
* @member SuperMap.GetFeaturesByBoundsParameters.prototype.attributeFilter -{string}
44+
* @member SuperMap.GetFeaturesByBoundsParameters.prototype.attributeFilter -{String}
4545
* @description 范围查询属性过滤条件。
4646
*/
4747
attributeFilter = null;

‎src/common/iServer/TransferSolutionService.js‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@ import TransferSolutionParameters from './TransferSolutionParameters';
44

55
/**
66
* @class SuperMap.TransferSolutionService
7-
* @classdesc
8-
* 交通换乘方案查询服务类。
9-
* 返回结果通过该类支持的事件的监听函数参数获取。
10-
* @param url - {string} 与客户端交互的交通换乘方案查询服务地址。
7+
* @classdesc 交通换乘方案查询服务类。返回结果通过该类支持的事件的监听函数参数获取。
8+
* @param url - {String} 与客户端交互的交通换乘方案查询服务地址。
119
* 例如:</br>"http://localhost:8090/iserver/services/traffictransferanalyst-sample/restjsr/traffictransferanalyst/Traffic-Changchun"。
12-
* @param options - {Object} 参数。
10+
* @param options - {Object} 参数。如</br>
1311
* eventListeners - {Object} 需要被注册的监听器对象。</br>
1412
* @extends SuperMap.CommonServiceBase
1513
* @example 例如：
@@ -23,7 +21,13 @@ import TransferSolutionParameters from './TransferSolutionParameters';
2321
*
2422
*/
2523
export default class TransferSolutionService extends CommonServiceBase {
26-
24+
/*
25+
* @function SuperMap.TransferSolutionService.prototype.constructor
26+
* @param url - {String} 与客户端交互的交通换乘方案查询服务地址。
27+
* 例如:</br>"http://localhost:8090/iserver/services/traffictransferanalyst-sample/restjsr/traffictransferanalyst/Traffic-Changchun"。
28+
* @param options - {Object} 参数。如:</br>
29+
* eventListeners - {Object} 需要被注册的监听器对象。</br>
30+
*/
2731
constructor(url, options) {
2832
super(url, options);
2933
}

‎src/common/security/ServerInfo.js‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@ import {ServerType} from '../REST';
33
/**
44
* @class SuperMap.ServerInfo
55
* @classdesc 服务器信息(安全相关)，包含服务器类型，服务地址，token服务地址等
6-
* @param type - {string} 服务器类型
7-
* @param options - {object} 非必填，服务器信息相关可选参数。如：<br>
8-
* server - {string} 数据库服务器名
9-
* tokenServiceUrl - {string} 非必填，如：http://supermapiserver:8090/iserver/services/security/tokens.json
10-
* keyServiceUrl - {string} 非必填，如：http://supermapiserver:8092/web/mycontent/keys/register.json
6+
* @param type -{string} 类型
7+
* @param options - {Object} 参数。
118
*/
9+
10+
1211
export default class ServerInfo {
1312
/**
1413
* @member SuperMap.ServerInfo.prototype.type -{SuperMap.ServerType}
@@ -18,19 +17,19 @@ export default class ServerInfo {
1817

1918
/**
2019
* @member SuperMap.ServerInfo.prototype.server -{string}
21-
* @description 非必填，server - {string} 数据库服务器名
20+
* @description 非必填，如：http://supermapiserver:8090/iserver/services/security/tokens.json
2221
*/
2322
server = null;
2423

2524
/**
2625
* @member SuperMap.ServerInfo.prototype.tokenServiceUrl -{string}
27-
* @description 非必填，如：http://supermapiserver:8090/iserver/services/security/tokens.json
26+
* @description 非必填，如：http://supermapiserver:8092/web/mycontent/keys/register.json
2827
*/
2928
tokenServiceUrl = null;
3029

3130
/**
3231
* @member SuperMap.ServerInfo.prototype.keyServiceUrl -{string}
33-
* @description 非必填。如：http://supermapiserver:8092/web/mycontent/keys/register.json
32+
* @description 非必填。
3433
*/
3534
keyServiceUrl = null;
3635

‎src/leaflet/mapping/CloudTileLayer.js‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ export var CloudTileLayer = L.TileLayer.extend({
2828
defaultURL: 'http://t2.supermapcloud.com/FileService/image',
2929

3030
options: {
31-
/*
32-
* APIProperty: mapName
33-
* {String} 地图名称，默认为 quanguo。
34-
*/
31+
/**
32+
* @member L.supermap.cloudTileLayer.prototype.options -{String}
33+
* @description 地图名称，默认为 quanguo。
34+
*/
3535
mapName: "quanguo",
36-
/*
37-
* Property: type
38-
* {String} 地图投影。
39-
*/
36+
/**
37+
* @member L.supermap.cloudTileLayer.prototype.type -{{String} }
38+
* @description 地图投影。
39+
*/
4040
type: "web",
4141
minZoom: 3,
4242
maxZoom: 18,

‎src/openlayers/control/ChangeTileVersion.js‎

Lines changed: 48 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ ol.supermap.control = ol.supermap.control || {};
88
* @class ol.supermap.control.ChangeTileVersion
99
* @classdesc 版本切换控件(目前仅支持IE10及以上)暂时不支持自定义位置
1010
* @extends ol.control.Control
11-
* @param options -{options} 可选参数。如：<br>
12-
* title - {string} 提示信息。<br>
13-
* tooltip - {string} 提示显示位置 top | right | bottom | left。<br>
11+
* @param options -{object} 参数。如：<br>
12+
* title - {String} 提示信息。<br>
13+
* tooltip - {String} 提示显示位置 top | right | bottom | left。<br>
1414
* collapsed - {boolean} 是否折叠。<br>
15-
* lastText - {string} 上一个版本的按钮布局。<br>
16-
* nextText - {string} 下一个版本的按钮布局。<br>
17-
* ico - {string} 控件显示的logo。<br>
18-
* orientation - {string} 方向horizontal|vertical。<br>
15+
* lastText - {String} 上一个版本的按钮布局。<br>
16+
* nextText - {String} 下一个版本的按钮布局。<br>
17+
* ico - {String} 控件显示的logo。<br>
18+
* orientation - {String} 方向horizontal|vertical。<br>
1919
* switch - {boolean} 是否显示上/下一个版本切换控件
2020
* @example
2121
* 用法： var control = new ol.supermap.control.ChangeTileVersion({
@@ -26,10 +26,6 @@ ol.supermap.control = ol.supermap.control || {};
2626
*/
2727
export default class ChangeTileVersion extends ol.control.Control {
2828

29-
/*
30-
* @function ol.supermap.control.ChangeTileVersion.prototype.constructor
31-
* @param options -{options} 参数
32-
*/
3329
constructor(options) {
3430
options = options || {};
3531
//鼠标滑过时提示
@@ -71,7 +67,7 @@ export default class ChangeTileVersion extends ol.control.Control {
7167
if (options.layer) {
7268
this.setLayer(options.layer);
7369
}
74-
/**
70+
/*
7571
* @function ol.supermap.control.ChangeTileVersion.prototype.initLayout
7672
* @description 初始化
7773
*/
@@ -146,10 +142,7 @@ export default class ChangeTileVersion extends ol.control.Control {
146142
else {
147143
this._sliderContainer.style.width = 150 + 'px';
148144
}
149-
/**
150-
* @function ol.supermap.control.ChangeTileVersion.prototype.addDomEvent
151-
* @description 为元素添加事件
152-
*/
145+
153146
addDomEvent(this._container, "click", function (e) {
154147
e.preventDefault();
155148
e.stopPropagation();
@@ -170,6 +163,15 @@ export default class ChangeTileVersion extends ol.control.Control {
170163
return this._container;
171164
}
172165

166+
/*
167+
* @function ol.supermap.control.ChangeTileVersion.prototype.createElement
168+
* @description 新建元素
169+
* @param tagName -{string} 标签名
170+
* @param className -{string} 类名
171+
* @param container -{object} 容器
172+
* @return {object|Element} 元素
173+
*/
174+
173175
function createElement(tagName, className, container) {
174176
var el = document.createElement(tagName);
175177
el.className = className || '';
@@ -180,6 +182,16 @@ export default class ChangeTileVersion extends ol.control.Control {
180182
return el;
181183
}
182184

185+
/*
186+
* @function ol.supermap.control.ChangeTileVersion.prototype.addDomEvent
187+
* @description 为元素添加事件
188+
* @param obj -{object} 事件对象集
189+
* @param type -{string} 事件类型
190+
* @param fn -{object} 容器
191+
* @param context -{object} 当前环境
192+
* @return {addDomEvent} 添加的事件
193+
*/
194+
183195
function addDomEvent(obj, type, fn, context) {
184196
var handler = function (e) {
185197
if (fn) {
@@ -238,10 +250,11 @@ export default class ChangeTileVersion extends ol.control.Control {
238250
this.tilesVersion(version);
239251
}
240252
}
253+
241254
/**
242255
* @function ol.supermap.control.ChangeTileVersion.prototype.setContent
243256
* @description 设置版本相关信息
244-
* @param version -{string} 版本信息
257+
* @param version -{object} 版本信息
245258
*/
246259
setContent(version) {
247260
var content = version || {};
@@ -261,19 +274,23 @@ export default class ChangeTileVersion extends ol.control.Control {
261274
this._sliderValue.innerHTML = value;
262275
return this;
263276
}
277+
264278
/**
265-
* @function ol.supermap.control.ChangeTileVersion.prototype.setVersionName
279+
* @function ol.supermap.control.ChangeTileVersion.prototype.setToolTip
266280
* @description 设置提示信息
267-
* @param tooltip -{HTMLElement}||{String} 版本内容
281+
* @param tooltip -{string} 工具提示
282+
* @return {ChangeTileVersion}
268283
*/
269284
setToolTip(tooltip) {
270285
this.tooltip.innerHTML = tooltip;
271286
return this;
272287
}
288+
273289
/**
274290
* @function ol.supermap.control.ChangeTileVersion.prototype.updateLength
275291
* @description 更新进度条长度
276-
* @param length -{number}进度条长度
292+
* @param length -{number} 进度条长度
293+
* @return {ChangeTileVersion}
277294
*/
278295
updateLength(length) {
279296
if (length > 0) {
@@ -282,10 +299,12 @@ export default class ChangeTileVersion extends ol.control.Control {
282299
}
283300
return this;
284301
}
302+
285303
/**
286304
* @function ol.supermap.control.ChangeTileVersion.prototype.setLayer
287305
* @description 绑定图层
288-
* @param layer -{object} 图层信息
306+
* @param layer -{object} 图层
307+
* @return {ChangeTileVersion}
289308
*/
290309
setLayer(layer) {
291310
if (layer) {
@@ -304,10 +323,11 @@ export default class ChangeTileVersion extends ol.control.Control {
304323
me.getTileSetsInfo();
305324
return this;
306325
}
326+
307327
/**
308328
* @function ol.supermap.control.ChangeTileVersion.prototype.update
309329
* @description 更新缓存切片集及进度条长度
310-
* @param tileVersions -{object} 瓦片信息
330+
* @param tileVersions -{object} 待更新的切片版本
311331
*/
312332
update(tileVersions) {
313333
this.tileVersions = tileVersions;
@@ -317,6 +337,7 @@ export default class ChangeTileVersion extends ol.control.Control {
317337
/**
318338
* @function ol.supermap.control.ChangeTileVersion.prototype.getTileSetsInfo
319339
* @description 请求获取切片集信息
340+
* @return {ChangeTileVersion}
320341
*/
321342
getTileSetsInfo() {
322343
var me = this;
@@ -328,6 +349,7 @@ export default class ChangeTileVersion extends ol.control.Control {
328349
}
329350
return this;
330351
}
352+
331353
/**
332354
* @function ol.supermap.control.ChangeTileVersion.prototype.removeLayer
333355
* @description 移除绑定的地图图层
@@ -365,7 +387,9 @@ export default class ChangeTileVersion extends ol.control.Control {
365387
/**
366388
* @function ol.supermap.control.ChangeTileVersion.prototype.tilesVersion
367389
* @description 根据指定版本号请求版本
390+
* @param version -{object} 版本信息
368391
*/
392+
369393
tilesVersion(version) {
370394
var layer = this.options.layer,
371395
tileVersions = this.tileVersions;
@@ -378,13 +402,15 @@ export default class ChangeTileVersion extends ol.control.Control {
378402
}
379403
}
380404
}
405+
381406
/**
382407
* @function ol.supermap.control.ChangeTileVersion.prototype.getValue
383408
* @description 获取进度条的值。注：(进度条的值并不是版本号)
384409
*/
385410
getValue() {
386411
return this.slider.value;
387412
}
413+
388414
/**
389415
* @function ol.supermap.control.ChangeTileVersion.prototype.getVersion
390416
* @description 获取当前进度条值对应的版本号

‎src/openlayers/control/Logo.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export default class Logo extends ol.control.Control {
3030
super(options);
3131
this.options = options;
3232
this.element = options.element = initLayerout.call(this);
33-
/**
33+
/*
3434
* @function ol.supermap.control.Logo.prototype.initLayerout
3535
* @description 初始化图层信息
3636
*/
@@ -65,9 +65,9 @@ export default class Logo extends ol.control.Control {
6565
"<img src=" + imgSrc + " alt='" + alt + "' style='border: none;" + styleSize + "white-space: nowrap'></a>";
6666
return div;
6767
}
68-
/**
68+
/*
6969
* @function ol.supermap.control.Logo.prototype.setDivStyle
70-
* @div 获取容器对象
70+
* @div 获取div对象
7171
* @description 设置对象style
7272
*/
7373
function setDivStyle(div) {

0 commit comments

Comments
 (0)