Skip to content

Commit 6f1f55d

Browse files
xilanhuaweidapaoxilanhuaweidapao
committed
【API】 ol下 optional参数修改 review by songym
1 parent 411d683 commit 6f1f55d

Some content is hidden

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

50 files changed

+896
-862
lines changed

‎build/jsdocs/template/typeLinkExt.js‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
var olapi = "https://openlayers.org/en/v4.6.5/apidoc/";
22
var lfapi = "http://leafletjs.com/reference-1.3.1.html";
33
var mbglapi = "https://www.mapbox.com/mapbox-gl-js/api/";
4+
var mapv = "https://github.com/huiyan-fe/mapv/blob/master/src/"
45
var typeLinks = {
56
//openlayers
67
"ol.Map": olapi + "ol.Map.html",
@@ -25,6 +26,8 @@ var typeLinks = {
2526
"ol.source.VectorTile": olapi + "ol.source.VectorTile",
2627
"ol.Pixel": olapi + "ol.html#.Pixel",
2728
"ol.source.State": olapi + "ol.source.html#.State",
29+
"ol.layer.Layer": olapi + "ol.layer.Layer.html",
30+
2831

2932
//leaflet
3033
"L.Marker": lfapi + '#marker',
@@ -48,6 +51,10 @@ var typeLinks = {
4851

4952
//mapboxgl
5053
"mapboxgl.Evented": mbglapi + '#Evented',
51-
"mapboxgl.Map": mbglapi + '#map'
54+
"mapboxgl.Map": mbglapi + '#map',
55+
//mapv
56+
"Mapv.DataSet": mapv + 'data/DataSet.md',
57+
"Mapv.BaiduMapLayer": mapv + 'map/baidu-map/Layer.md'
58+
5259
}
5360
exports.typeLinks = typeLinks;

‎src/openlayers/control/ChangeTileVersion.js‎

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ ol.supermap.control = ol.supermap.control || {};
77
/**
88
* @class ol.supermap.control.ChangeTileVersion
99
* @category Control
10-
* @classdesc 版本切换控件(目前仅支持IE10及以上)暂时不支持自定义位置
10+
* @classdesc 版本切换控件(目前仅支持IE10及以上)暂时不支持自定义位置。
1111
* @extends {ol.control.Control}
12-
* @param {options} options -参数。<br>
13-
* @param {string} options.title - 提示信息。<br>
14-
* @param {string} options.tooltip - 提示显示位置 top | right | bottom | left。<br>
15-
* @param {boolean} options.collapsed - 是否折叠。<br>
16-
* @param {string} options.lastText - 上一个版本的按钮布局。<br>
17-
* @param {string} options.nextText - 下一个版本的按钮布局。<br>
18-
* @param {string} options.ico - 控件显示的logo。<br>
19-
* @param {string} options.orientation - 方向horizontal|vertical。<br>
20-
* @param {boolean} options.switch - 是否显示上/下一个版本切换控件
12+
* @param {options} options -参数。
13+
* @param {string} [options.title='switch tile version'] - 提示信息。
14+
* @param {string} [options.tooltip='top'] - 提示显示位置 top | right | bottom | left。
15+
* @param {boolean} [options.collapsed=true] - 是否折叠。
16+
* @param {string} [options.lastText='-'] - 上一个版本的按钮布局。
17+
* @param {string} [options.nextText='+'] - 下一个版本的按钮布局。
18+
* @param {string} [options.ico='V'] - 控件显示的logo。
19+
* @param {string} [options.orientation='horizontal'] - 方向horizontal|vertical。
20+
* @param {boolean} [options.switch=true] - 是否显示上/下一个版本切换控件。
2121
* @example
2222
* var control = new ol.supermap.control.ChangeTileVersion({
2323
* layer: baseLayer,
@@ -71,7 +71,7 @@ export class ChangeTileVersion extends ol.control.Control {
7171

7272
/**
7373
* @function ol.supermap.control.ChangeTileVersion.prototype.initLayout
74-
* @description 初始化
74+
* @description 初始化。
7575
*/
7676
function initLayout() {
7777
var className = 'ol-control-ctv';
@@ -145,7 +145,7 @@ export class ChangeTileVersion extends ol.control.Control {
145145

146146
/**
147147
* @function ol.supermap.control.ChangeTileVersion.prototype.addDomEvent
148-
* @description 为元素添加事件
148+
* @description 为元素添加事件。
149149
*/
150150
addDomEvent(this._container, "click", function (e) {
151151
e.preventDefault();
@@ -169,10 +169,10 @@ export class ChangeTileVersion extends ol.control.Control {
169169

170170
/**
171171
* @function ol.supermap.control.ChangeTileVersion.prototype.createElement
172-
* @description 新建元素
173-
* @param {string} tagName - 标签名
174-
* @param {string} className - 类名
175-
* @param {Object} container - 容器
172+
* @description 新建元素。
173+
* @param {string} tagName - 标签名。
174+
* @param {string} className - 类名。
175+
* @param {Object} container - 容器。
176176
* @returns {object|Element} 元素
177177
*/
178178
function createElement(tagName, className, container) {
@@ -187,11 +187,11 @@ export class ChangeTileVersion extends ol.control.Control {
187187

188188
/**
189189
* @function ol.supermap.control.ChangeTileVersion.prototype.addDomEvent
190-
* @description 为元素添加事件
191-
* @param {Object} obj - 事件对象集
192-
* @param {string} type - 事件类型
193-
* @param {Object} fn -容器
194-
* @param {Object} context -当前环境
190+
* @description 为元素添加事件。
191+
* @param {Object} obj - 事件对象集。
192+
* @param {string} type - 事件类型。
193+
* @param {Object} fn -容器。
194+
* @param {Object} context -当前环境。
195195
* @returns {addDomEvent} 添加的事件
196196
*/
197197
function addDomEvent(obj, type, fn, context) {
@@ -256,8 +256,8 @@ export class ChangeTileVersion extends ol.control.Control {
256256

257257
/**
258258
* @function ol.supermap.control.ChangeTileVersion.prototype.setContent
259-
* @description 设置版本相关信息
260-
* @param {Object} version - 版本信息
259+
* @description 设置版本相关信息。
260+
* @param {Object} version - 版本信息。
261261
*/
262262
setContent(version) {
263263
var content = version || {};
@@ -267,7 +267,7 @@ export class ChangeTileVersion extends ol.control.Control {
267267
/**
268268
* @function ol.supermap.control.ChangeTileVersion.prototype.setVersionName
269269
* @description 设置版本号
270-
* @param {string} content -版本内容
270+
* @param {string} content -版本内容。
271271
*/
272272
setVersionName(content) {
273273
var value = content;
@@ -280,8 +280,8 @@ export class ChangeTileVersion extends ol.control.Control {
280280

281281
/**
282282
* @function ol.supermap.control.ChangeTileVersion.prototype.setToolTip
283-
* @description 设置提示信息
284-
* @param {string} tooltip - 工具提示
283+
* @description 设置提示信息。
284+
* @param {string} tooltip - 工具提示。
285285
* @returns {this} this
286286
*/
287287
setToolTip(tooltip) {
@@ -291,8 +291,8 @@ export class ChangeTileVersion extends ol.control.Control {
291291

292292
/**
293293
* @function ol.supermap.control.ChangeTileVersion.prototype.updateLength
294-
* @description 更新进度条长度
295-
* @param {number} length - 进度条长度
294+
* @description 更新进度条长度。
295+
* @param {number} length - 进度条长度。
296296
*/
297297
updateLength(length) {
298298
if (length > 0) {
@@ -304,8 +304,8 @@ export class ChangeTileVersion extends ol.control.Control {
304304

305305
/**
306306
* @function ol.supermap.control.ChangeTileVersion.prototype.setLayer
307-
* @description 绑定图层
308-
* @param {Object} layer - 图层
307+
* @description 绑定图层。
308+
* @param {Object} layer - 图层。
309309
*/
310310
setLayer(layer) {
311311
if (layer) {
@@ -326,8 +326,8 @@ export class ChangeTileVersion extends ol.control.Control {
326326

327327
/**
328328
* @function ol.supermap.control.ChangeTileVersion.prototype.update
329-
* @description 更新缓存切片集及进度条长度
330-
* @param {Object} tileVersions - 待更新的切片版本
329+
* @description 更新缓存切片集及进度条长度。
330+
* @param {Object} tileVersions - 待更新的切片版本。
331331
*/
332332
update(tileVersions) {
333333
this.tileVersions = tileVersions;
@@ -336,7 +336,7 @@ export class ChangeTileVersion extends ol.control.Control {
336336

337337
/**
338338
* @function ol.supermap.control.ChangeTileVersion.prototype.getTileSetsInfo
339-
* @description 请求获取切片集信息
339+
* @description 请求获取切片集信息。
340340
*/
341341
getTileSetsInfo() {
342342
var me = this;
@@ -349,15 +349,15 @@ export class ChangeTileVersion extends ol.control.Control {
349349

350350
/**
351351
* @function ol.supermap.control.ChangeTileVersion.prototype.removeLayer
352-
* @description 移除绑定的地图图层
352+
* @description 移除绑定的地图图层。
353353
*/
354354
removeLayer() {
355355
this.options.layer = null;
356356
}
357357

358358
/**
359359
* @function ol.supermap.control.ChangeTileVersion.prototype.nextTilesVersion
360-
* @description 下一个版本，第一次不进行加减，是无版本的状态
360+
* @description 下一个版本，第一次不进行加减，是无版本的状态。
361361
* @returns {this} this
362362
*/
363363
nextTilesVersion() {
@@ -376,7 +376,7 @@ export class ChangeTileVersion extends ol.control.Control {
376376

377377
/**
378378
* @function ol.supermap.control.ChangeTileVersion.prototype.lastTilesVersion
379-
* @description 获取上一个版本信息
379+
* @description 获取上一个版本信息。
380380
* @returns {this} this
381381
*/
382382
lastTilesVersion() {
@@ -390,8 +390,8 @@ export class ChangeTileVersion extends ol.control.Control {
390390

391391
/**
392392
* @function ol.supermap.control.ChangeTileVersion.prototype.tilesVersion
393-
* @description 根据指定版本号请求版本
394-
* @param {Object} version - 版本信息
393+
* @description 根据指定版本号请求版本。
394+
* @param {Object} version - 版本信息。
395395
*/
396396
tilesVersion(version) {
397397
var layer = this.options.layer,
@@ -408,15 +408,15 @@ export class ChangeTileVersion extends ol.control.Control {
408408

409409
/**
410410
* @function ol.supermap.control.ChangeTileVersion.prototype.getValue
411-
* @description 获取进度条的值。注：(进度条的值并不是版本号)
411+
* @description 获取进度条的值。注：(进度条的值并不是版本号)。
412412
*/
413413
getValue() {
414414
return this.slider.value;
415415
}
416416

417417
/**
418418
* @function ol.supermap.control.ChangeTileVersion.prototype.getVersion
419-
* @description 获取当前进度条值对应的版本号
419+
* @description 获取当前进度条值对应的版本号。
420420
*/
421421
getVersion() {
422422
var version = this.tileVersions[this.getValue()];

‎src/openlayers/control/Logo.js‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ ol.supermap.control = ol.supermap.control || {};
1212
* @example
1313
* var control = new ol.supermap.control.Logo();
1414
* map.addControl(control);
15-
* @param {Object} options - logo控件配置项。</br>
16-
* @param {string} options.imageUrl - logo图片地址。</br>
17-
* @param {number} options.width - logo图片宽。</br>
18-
* @param {number} options.height - logo图片高。</br>
19-
* @param {string} options.link - 跳转链接。</br>
20-
* @param {string} options.alt - logo图片失效时显示文本。
15+
* @param {Object} options - logo控件配置项。
16+
* @param {string} [options.imageUrl] - logo图片地址。
17+
* @param {number} [options.width] - logo图片宽。
18+
* @param {number} [options.height] - logo图片高。
19+
* @param {string} [options.link='http://iclient.supermap.io'] - 跳转链接。
20+
* @param {string} [options.alt='SuperMap iClient'] - logo图片失效时显示文本。
2121
*/
2222
export class Logo extends ol.control.Control {
2323

@@ -34,7 +34,7 @@ export class Logo extends ol.control.Control {
3434

3535
/**
3636
* @function ol.supermap.control.Logo.prototype.initLayerout
37-
* @description 初始化图层信息
37+
* @description 初始化图层信息。
3838
*/
3939
function initLayerout() {
4040
var className = 'ol-control-logo ol-unselectable ol-control';
@@ -71,7 +71,7 @@ export class Logo extends ol.control.Control {
7171
/**
7272
* @function ol.supermap.control.Logo.prototype.setDivStyle
7373
* @div 获取div对象
74-
* @description 设置对象style
74+
* @description 设置对象style。
7575
*/
7676
function setDivStyle(div) {
7777
var attributionsElem = document.getElementsByClassName('ol-attribution');

‎src/openlayers/mapping/BaiduMap.js‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ import ol from 'openlayers';
44
* @class ol.source.BaiduMap
55
* @category ThirdPartyMap
66
* @classdesc 百度地图图层源。
7-
* @param {Object} opt_options - 参数。<br>
8-
* @param {string} url - 服务地址。<br>
9-
* @param {string} tileProxy - 代理地址
7+
* @param {Object} opt_options - 参数。
8+
* @param {string} [opt_options.url='http://online1.map.bdimg.com/onlinelabel/?qt=tile&x={x}&y={y}&z={z}&styles={styles}&udt=20170408'] - 服务地址。
9+
* @param {string} [opt_options.tileProxy] - 代理地址。
10+
* @param {boolean} [hidpi = false] - 是否使用高分辨率地图。
1011
* @extends {ol.source.TileImage}
1112
*/
1213
export class BaiduMap extends ol.source.TileImage {
@@ -69,7 +70,7 @@ export class BaiduMap extends ol.source.TileImage {
6970

7071
/**
7172
* @function ol.source.BaiduMap.defaultTileGrid
72-
* @description 获取默认瓦片格网
73+
* @description 获取默认瓦片格网。
7374
* @returns {ol.tilegrid.TileGrid} 返回瓦片格网对象
7475
*/
7576
static defaultTileGrid() {

0 commit comments

Comments
 (0)