Skip to content

Commit 8baf4bd

Browse files
Yuki-ZhaoYuki-Zhao
committed
【update】1) 补充注释return值
1 parent e7d2029 commit 8baf4bd

File tree

1 file changed

+45
-63
lines changed

1 file changed

+45
-63
lines changed

‎src/openlayers/mapping/WebMap.js

Lines changed: 45 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1004,7 +1004,7 @@ export class WebMap extends Observable {
10041004
* @function ol.supermap.WebMap.prototype.createWMSSource
10051005
* @description 创建wms地图source。
10061006
* @param {Object} layerInfo - 图层信息。
1007-
* @returns {ol/source/TileWMS}
1007+
* @returns {ol/source/TileWMS} wms的source
10081008
*/
10091009
createWMSSource(layerInfo) {
10101010
let that = this;
@@ -1191,7 +1191,7 @@ export class WebMap extends Observable {
11911191
* @function ol.supermap.WebMap.prototype.createWMTSSource
11921192
* @description 获取WMTS类型图层的source。
11931193
* @param {Object} layerInfo - 图层信息。
1194-
* @returns {ol/tilegrid}
1194+
* @returns {ol/source/WMTS} wmts的souce
11951195
*/
11961196
createWMTSSource(layerInfo) {
11971197
let extent = layerInfo.extent || olProj.get(layerInfo.projection).getExtent();
@@ -1220,7 +1220,7 @@ export class WebMap extends Observable {
12201220
* @param {string} unit - 单位
12211221
* @param {number} dpi - dpi
12221222
* @param {Array} origin 瓦片的原点
1223-
* @returns {ol/tilegrid/WMTS}
1223+
* @returns {ol/tilegrid/WMTS} wmts的瓦片
12241224
*/
12251225
getWMTSTileGrid(extent, scales, unit, dpi, origin, matrixIds) {
12261226
let resolutionsInfo = this.getReslutionsFromScales(scales, dpi || 96, unit);
@@ -1240,7 +1240,7 @@ export class WebMap extends Observable {
12401240
* @param {number} dpi - 地图dpi
12411241
* @param {string} unit - 单位
12421242
* @param {number} datumAxis
1243-
* @returns {{res: Array, matrixIds: Array}}
1243+
* @returns {{res: Array, matrixIds: Array}}
12441244
*/
12451245
getReslutionsFromScales(scales, dpi, unit, datumAxis) {
12461246
unit = (unit && unit.toLowerCase()) || 'degrees';
@@ -1756,9 +1756,12 @@ export class WebMap extends Observable {
17561756
return features;
17571757
}
17581758
/**
1759-
* 行政区划数据处理
1760-
* @param {*} content
1761-
* @param {*} layerInfo
1759+
* @private
1760+
* @function ol.supermap.WebMap.prototype.excelData2FeatureByDivision
1761+
* @description 行政区划数据处理
1762+
* @param {object} content - 文件内容
1763+
* @param {object} layerInfo - 图层信息
1764+
* @returns {object} geojson对象
17621765
*/
17631766
excelData2FeatureByDivision(content, divisionType, divisionField) {
17641767
let me = this;
@@ -1778,9 +1781,10 @@ export class WebMap extends Observable {
17781781
}
17791782

17801783
/**
1784+
* @private
1785+
* @function ol.supermap.WebMap.prototype._parseGeoJsonData2Feature
17811786
* @description 将geojson的数据转换成ol.Feature
1782-
* @author gaozy
1783-
* @param {any} metaData
1787+
* @param {object} metaData - 文件内容
17841788
* @returns {Array.<ol/Feature>} features
17851789
*/
17861790
_parseGeoJsonData2Feature(metaData) {
@@ -1799,15 +1803,15 @@ export class WebMap extends Observable {
17991803
}
18001804
return features;
18011805
}
1802-
18031806
/**
1807+
* @private
1808+
* @function ol.supermap.WebMap.prototype.changeExcel2Geojson
18041809
* @description 将excel和csv数据转换成标准geojson数据
1805-
* @author chengl
1806-
* @param {Array} datas excel和csv数据
1807-
* @param {String} divisionType 行政区划类型（省份 or 城市）
1808-
* @param {String} divisionField 行政区划字段
1809-
* @returns {GeoJSONObject} geojson GeoJSON数据
1810-
* @memberof AddFromFileModal
1810+
* @param {array} features - feature对象
1811+
* @param {array} datas - 数据内容
1812+
* @param {string} divisionType - 行政区划类型
1813+
* @param {string} divisionField - 行政区划字段
1814+
* @returns {object} geojson对象
18111815
*/
18121816
changeExcel2Geojson(features, datas, divisionType, divisionField) {
18131817
let geojson = {
@@ -1997,7 +2001,7 @@ export class WebMap extends Observable {
19972001
} else if (layerInfo.layerType === "HEAT") {
19982002
layer = this.createHeatLayer(layerInfo, features);
19992003
} else if (layerInfo.layerType === "MARKER") {
2000-
layer = this.createMarkerLayer(layerInfo, features);
2004+
layer = this.createMarkerLayer(features);
20012005
} else if(layerInfo.layerType === "DATAFLOW_POINT_TRACK") {
20022006
layer = this.createDataflowLayer(layerInfo, index);
20032007
} else if(layerInfo.layerType === "DATAFLOW_HEAT") {
@@ -2091,26 +2095,6 @@ export class WebMap extends Observable {
20912095
});
20922096
}
20932097
}
2094-
/**
2095-
* @private
2096-
* @function ol.supermap.WebMap.prototype.getResolution
2097-
* @description 比例尺转换为分辨率
2098-
* @param {String} scale - 比例尺
2099-
* @returns {Number} 分辨率
2100-
*/
2101-
getResolution(scale) {
2102-
let str = scale.split(":")[1];
2103-
str = str.replace(/,/g, "");
2104-
let num = Number(str.trim()), res;
2105-
if (this.baseProjection === 'EPSG:4326') {
2106-
//4326
2107-
res = num * .0254 / 96 / ((Math.PI * 2 * 6370997) / 360);
2108-
} else {
2109-
//3857
2110-
res = num * .0254 / 96;
2111-
}
2112-
return res;
2113-
}
21142098

21152099
/**
21162100
* @private
@@ -2119,7 +2103,7 @@ export class WebMap extends Observable {
21192103
* @param {object} layerInfo - 图层信息
21202104
* @param {number} index 图层的顺序
21212105
* @param {String} type 创建的图层类型，restData为创建数据服务的mvt, restMap为创建地图服务的mvt
2122-
* @returns {Object} 图层对象
2106+
* @returns {ol/layer/VectorTile} 图层对象
21232107
*/
21242108
addVectorTileLayer(layerInfo, index, type) {
21252109
let layer;
@@ -2146,7 +2130,7 @@ export class WebMap extends Observable {
21462130
* @function ol.supermap.WebMap.prototype.createDataVectorTileLayer
21472131
* @description 创建vectorTILE图层
21482132
* @param {object} layerInfo - 图层信息
2149-
* @returns {Object} 图层对象
2133+
* @returns {ol/layer/VectorTile} 图层对象
21502134
*/
21512135
createDataVectorTileLayer(layerInfo) {
21522136
//创建图层
@@ -2248,7 +2232,7 @@ export class WebMap extends Observable {
22482232
* @description 添加大数据图层到地图上
22492233
* @param {object} layerInfo - 图层信息
22502234
* @param {array} features - feature的集合
2251-
* @return {string}
2235+
* @return {ol/layer/image} 大数据图层
22522236
*/
22532237
createGraphicLayer(layerInfo, features) {
22542238
features = layerInfo.filterCondition ? this.getFiterFeatures(layerInfo.filterCondition, features) : features;
@@ -2270,7 +2254,7 @@ export class WebMap extends Observable {
22702254
* @param {array} features - feature的集合
22712255
* @param {object} style - 图层样式
22722256
* @param {string} featureType - feature的类型
2273-
* @return {string}
2257+
* @return {array} 大数据图层要素数组
22742258
*/
22752259
getGraphicsFromFeatures(features, style, featureType) {
22762260
let olStyle = StyleUtils.getOpenlayersStyle(style, featureType),
@@ -2292,7 +2276,7 @@ export class WebMap extends Observable {
22922276
* @description 添加符号图层
22932277
* @param {object} layerInfo - 图层信息
22942278
* @param {array} features - feature的集合
2295-
* @return {object}
2279+
* @return {ol/layer/Vector} 符号图层
22962280
*/
22972281
createSymbolLayer(layerInfo, features) {
22982282
let style = StyleUtils.getSymbolStyle(layerInfo.style);
@@ -2312,7 +2296,7 @@ export class WebMap extends Observable {
23122296
* @description 添加标签图层
23132297
* @param {object} layerInfo - 图层信息
23142298
* @param {array} features -feature的集合
2315-
* @returns {object}图层对象
2299+
* @returns {ol/layer/Vector} 图层对象
23162300
*/
23172301
addLabelLayer(layerInfo, features) {
23182302
let labelStyle = layerInfo.labelStyle;
@@ -2351,7 +2335,7 @@ export class WebMap extends Observable {
23512335
* @description 获取标签样式
23522336
* @param {object} parameters - 标签图层样式参数
23532337
* @param {object} layerInfo - 图层样式参数
2354-
* @returns {ol/style/Style}
2338+
* @returns {ol/style/Style} 标签样式
23552339
*/
23562340
getLabelStyle(parameters, layerInfo) {
23572341
let style = layerInfo.style || layerInfo.pointStyle;
@@ -2386,7 +2370,7 @@ export class WebMap extends Observable {
23862370
* @description 创建vector图层
23872371
* @param {object} layerInfo - 图层信息
23882372
* @param {array} features -feature的集合
2389-
* @returns {ol/style/Style}
2373+
* @returns {ol/layer/Vector} 矢量图层
23902374
*/
23912375
createVectorLayer(layerInfo, features) {
23922376
let style = StyleUtils.toOpenLayersStyle(layerInfo.style, layerInfo.featureType);
@@ -2405,7 +2389,7 @@ export class WebMap extends Observable {
24052389
* @description 创建热力图图层
24062390
* @param {object} layerInfo - 图层信息
24072391
* @param {array} features -feature的集合
2408-
* @returns {ol/layer/Heatmap}
2392+
* @returns {ol/layer/Heatmap} 热力图图层
24092393
*/
24102394
createHeatLayer(layerInfo, features) {
24112395
//因为热力图，随着过滤，需要重新计算权重
@@ -2536,7 +2520,7 @@ export class WebMap extends Observable {
25362520
* @description 获取单值专题图的styleGroup
25372521
* @param {object} parameters- 图层信息
25382522
* @param {array} features - feature 数组
2539-
* @returns {Array}
2523+
* @returns {Array} 单值样式
25402524
*/
25412525
getUniqueStyleGroup(parameters, features) {
25422526
// 找出所有的单值
@@ -2600,7 +2584,7 @@ export class WebMap extends Observable {
26002584
* @description 创建分段图层
26012585
* @param {object} layerInfo- 图层信息
26022586
* @param {array} features - 所有feature结合
2603-
* @returns {ol/layer/Vector}
2587+
* @returns {ol/layer/Vector} 单值图层
26042588
*/
26052589
createRangeLayer(layerInfo, features) {
26062590
//这里获取styleGroup要用所以的feature
@@ -2642,7 +2626,7 @@ export class WebMap extends Observable {
26422626
* @description 创建分段专题图的图层source
26432627
* @param {object} parameters- 图层信息
26442628
* @param {array} features - 所以的feature集合
2645-
* @returns {*}
2629+
* @returns {Object} 图层source
26462630
*/
26472631
createRangeSource(parameters, features) {
26482632
//找到合适的专题字段
@@ -2664,7 +2648,7 @@ export class WebMap extends Observable {
26642648
* @description 获取分段专题图的styleGroup样式
26652649
* @param {object} parameters- 图层信息
26662650
* @param {array} features - 所以的feature集合
2667-
* @returns {*}
2651+
* @returns {Array} styleGroups
26682652
*/
26692653
getRangeStyleGroup(parameters, features) {
26702654
// 找出分段值
@@ -2781,11 +2765,10 @@ export class WebMap extends Observable {
27812765
* @private
27822766
* @function ol.supermap.WebMap.prototype.createMarkerLayer
27832767
* @description 创建标注图层
2784-
* @param {object} layerInfo- 图层信息
27852768
* @param {array} features - 所以的feature集合
2786-
* @returns {*}
2769+
* @returns {ol/layer/Vector} 矢量图层
27872770
*/
2788-
createMarkerLayer(layerInfo, features) {
2771+
createMarkerLayer(features) {
27892772
features && this.setEachFeatureDefaultStyle(features);
27902773
return new olLayer.Vector({
27912774
source: new olSource.Vector({
@@ -2801,7 +2784,7 @@ export class WebMap extends Observable {
28012784
* @description 创建数据流图层
28022785
* @param {object} layerInfo- 图层信息
28032786
* @param {number} layerIndex - 图层的zindex
2804-
* @returns {*}
2787+
* @returns {ol/layer/Vector} 数据流图层
28052788
*/
28062789
createDataflowLayer(layerInfo, layerIndex) {
28072790
let layerStyle = layerInfo.pointStyle, style;
@@ -2921,7 +2904,6 @@ export class WebMap extends Observable {
29212904
* @param {object} layer - 图层对象
29222905
* @param {string} directionField - 方向字段
29232906
* @param {string} styleType - 样式的类型
2924-
* @returns {*} 图层上feature对应的样式
29252907
*/
29262908
setFeatureStyle(layer, directionField, styleType) {
29272909
let layerStyle = layer.get('styleOL');
@@ -2953,7 +2935,7 @@ export class WebMap extends Observable {
29532935
* @function ol.supermap.WebMap.prototype.createDataflowHeatLayer
29542936
* @description 创建数据流服务的热力图图层
29552937
* @param {object} layerInfo - 图层参数
2956-
* @returns {*} 热力图图层对象
2938+
* @returns {ol/layer/Heatmap} 热力图图层对象
29572939
*/
29582940
createDataflowHeatLayer(layerInfo) {
29592941
let source = this.createDataflowHeatSource(layerInfo);
@@ -2977,7 +2959,7 @@ export class WebMap extends Observable {
29772959
* @function ol.supermap.WebMap.prototype.createDataflowHeatSource
29782960
* @description 创建数据流服务的热力图的source
29792961
* @param {object} layerInfo - 图层参数
2980-
* @returns {*} 热力图source对象
2962+
* @returns {ol/souce/Vector} 热力图source对象
29812963
*/
29822964
createDataflowHeatSource(layerInfo) {
29832965
let that = this,
@@ -3081,7 +3063,7 @@ export class WebMap extends Observable {
30813063
//说明是文字的feature类型
30823064
geomType = "TEXT";
30833065
}
3084-
let attributes = this.setFeatureInfo(feature);
3066+
let attributes = that.setFeatureInfo(feature);
30853067
feature.setProperties({
30863068
useStyle: defaultStyle,
30873069
attributes
@@ -3105,7 +3087,7 @@ export class WebMap extends Observable {
31053087
* @function ol.supermap.WebMap.prototype.setFeatureInfo
31063088
* @description 为feature设置属性
31073089
* @param {array} feature - 单个feature
3108-
* @returns {*}
3090+
* @returns {object} 属性
31093091
*/
31103092
setFeatureInfo(feature) {
31113093
let attributes = feature.get('attributes'),
@@ -3132,7 +3114,7 @@ export class WebMap extends Observable {
31323114
* @description 创建等级符号图层
31333115
* @param {object} layerInfo - 图层信息
31343116
* @param {array} features - 添加到图层上的features
3135-
* @returns {*}
3117+
* @returns {ol/layer/Vector} 矢量图层
31363118
*/
31373119
createRankSymbolLayer(layerInfo, features) {
31383120
let styleSource = this.createRankStyleSource(layerInfo, features, layerInfo.featureType);
@@ -3164,7 +3146,7 @@ export class WebMap extends Observable {
31643146
* @param {object} parameters - 图层信息
31653147
* @param {array} features - 添加到图层上的features
31663148
* @param {string} featureType - feature的类型
3167-
* @returns {*}
3149+
* @returns {object} styleGroups
31683150
*/
31693151
createRankStyleSource(parameters, features, featureType) {
31703152
let themeSetting = parameters.themeSetting,
@@ -3180,7 +3162,7 @@ export class WebMap extends Observable {
31803162
* @param {array} features - 添加到图层上的features
31813163
* @param {object} parameters - 图层参数
31823164
* @param {string} featureType - feature的类型
3183-
* @returns {*}
3165+
* @returns {array} stylegroup
31843166
*/
31853167
getRankStyleGroup(themeField, features, parameters, featureType) {
31863168
// 找出所有的单值
@@ -3249,7 +3231,7 @@ export class WebMap extends Observable {
32493231
* @function ol.supermap.WebMap.prototype.checkUploadToRelationship
32503232
* @description 检查是否上传到关系型
32513233
* @param {String} fileId - 文件的id
3252-
* @returns {Promise<T | never>} 关系型文件一些参数
3234+
* @returns {Promise<T | never>} 关系型文件一些参数
32533235
*/
32543236
checkUploadToRelationship(fileId) {
32553237
let url = this.getRequestUrl(`${this.server}web/datas/${fileId}/datasets.json`);

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy