Skip to content

Commit 6ad0774

Browse files
xiongjiaojiaoxiongjiaojiao
committed
【docs】去掉重复api
1 parent 257cc45 commit 6ad0774

File tree

11 files changed

+18
-83
lines changed

11 files changed

+18
-83
lines changed

‎build/jsdocs/leaflet/docs.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
"src/common/iServer/ProcessingServiceBase",
3737
"src/common/iServer/PointWithMeasure",
3838
"src/common/iServer/ServerTheme",
39+
"src/common/iServer/QueryService",
3940
"src/common/overlay/RankSymbol",
4041
"src/common/overlay/ThemeVector",
4142
"src/common/overlay/Graph",

‎build/jsdocs/mapboxgl/docs.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
"src/common/iServer/ProcessingServiceBase",
3737
"src/common/iServer/PointWithMeasure",
3838
"src/common/iServer/ServerTheme",
39+
"src/common/iServer/QueryService",
3940
"src/common/overlay/RankSymbol",
4041
"src/common/overlay/ThemeVector",
4142
"src/common/overlay/Graph",

‎build/jsdocs/maplibregl/docs.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
"src/common/iServer/ProcessingServiceBase",
3535
"src/common/iServer/PointWithMeasure",
3636
"src/common/iServer/ServerTheme",
37+
"src/common/iServer/QueryService",
3738
"src/common/overlay/RankSymbol",
3839
"src/common/overlay/ThemeVector",
3940
"src/common/overlay/Graph",

‎build/jsdocs/openlayers/docs.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
"src/common/iServer/ProcessingServiceBase",
3636
"src/common/iServer/PointWithMeasure",
3737
"src/common/iServer/ServerTheme",
38+
"src/common/iServer/QueryService",
3839
"src/common/overlay/RankSymbol",
3940
"src/common/overlay/Graph",
4041
"src/common/overlay/ThemeVector",

‎src/common/iServer/GetFeaturesParametersBase.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { Util } from '../commontypes/Util';
99
* @category iServer Data FeatureResults
1010
* @classdesc 要素查询参数基类。此类存储了进行要素查询的数据集列表以及一些通用的查询参数，
1111
* 包括：是否返回查询结果、查询结果的最大/最小索引号、动态投影的目标坐标系、聚合查询相关参数等。
12-
* * <div style="padding: 20px;border: 1px solid #eee;border-left-width: 5px;border-radius: 3px;border-left-color: #ce4844;">
12+
* <div style="padding: 20px;border: 1px solid #eee;border-left-width: 5px;border-radius: 3px;border-left-color: #ce4844;">
1313
* <p style="color: #ce4844">Notice</p>
1414
* <p style="font-size: 13px">推荐设置 returnFeaturesOnly 配置为 true 来提升性能，如果需要获取总数量与数据集信息，FeatureService 提供了 getFeaturesCount 和 getFeaturesDatasetInfo 方法</p>
1515
* </div>

‎src/common/iServer/InitMapServiceBase.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ export class InitMapServiceBase {
7070
}
7171

7272
/**
73-
* @function getMapInfo
73+
* @function getWKT
7474
* @description 获取坐标投影的 WKT。
7575
* @returns {Promise}
7676
*/
@@ -149,7 +149,7 @@ export function getTileset(tilesets = [], targets) {
149149

150150
/**
151151
* @private
152-
* @function createMapOptions
152+
* @function scalesToResolutions
153153
* @description mapboxgl maplibregl 获取地图resolutions。
154154
* @returns {Array} resolutions
155155
*/

‎src/common/overlay/l7/L7LayerBase.js‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@ import { Util as CommonUtil } from '../../commontypes/Util';
22
import { CustomOverlayLayer } from '../Base';
33

44
/**
5-
* @class L7Layer
5+
* @class L7LayerBase
66
* @category Visualization L7
7-
* @version 11.2.0
7+
* @version 11.2.1
88
* @classdesc L7Layer对接了@antv/L7的图层类型，能够通过mapbox-gl操作@antv/L7的图层。
99
* @param {Object} options - 图层配置项，包括以下参数：
1010
* @param {string} options.type - @antv/L7的图层类型，详情参见: {@link https://l7.antv.antgroup.com/api/point_layer/pointlayer}。
@@ -50,8 +50,9 @@ export class L7LayerBase extends CustomOverlayLayer {
5050
this.setSelectedDatasFn = this.setSelectedDatas.bind(this);
5151
this.reRenderFn = this.reRender.bind(this);
5252
}
53+
5354
/**
54-
* @function L7Layer.prototype.getL7Layer
55+
* @function L7LayerBase.prototype.getL7Layer
5556
* @description 获取@antv/L7的layer实例。
5657
* @returns {Object} @antv/L7的layer实例。
5758
*/
@@ -60,7 +61,7 @@ export class L7LayerBase extends CustomOverlayLayer {
6061
}
6162

6263
/**
63-
* @function L7Layer.prototype.reRender
64+
* @function L7LayerBase.prototype.reRender
6465
* @description 当修改@antv/L7的layer的配置时，重新渲染。
6566
*/
6667
reRender() {

‎src/leaflet/core/Util.js‎

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
getMeterPerMapUnit as MeterPerMapUnit,
88
getZoomByResolution,
99
scalesToResolutions,
10-
getDpi
10+
getDpi,
11+
scaleToResolution as transformScaleToResolution
1112
} from '@supermapgis/iclient-common/util/MapCalculateUtil';
1213

1314
/**
@@ -136,36 +137,7 @@ export var resolutionToScale = function(resolution, dpi, mapUnit) {
136137
return scale;
137138
};
138139

139-
/**
140-
* @function scaleToResolution
141-
* @category BaseTypes Util
142-
* @description 通过比例尺计算分辨率。
143-
* @param {number} scale - 比例尺。
144-
* @param {number} dpi - 屏幕分辨率。
145-
* @param {string} mapUnit - 地图单位。
146-
* @returns {number} 分辨率。
147-
* @usage
148-
* ```
149-
* // 浏览器
150-
* <script type="text/javascript" src="{cdn}"></script>
151-
* <script>
152-
* const result = {namespace}.Util.scaleToResolution(scale, dpi, mapUnit);
153-
*
154-
* </script>
155-
*
156-
* // ES6 Import
157-
* import { scaleToResolution } from '{npm}';
158-
*
159-
* const result = scaleToResolution(scale, dpi, mapUnit);
160-
* ```
161-
*/
162-
export var scaleToResolution = function(scale, dpi, mapUnit) {
163-
var inchPerMeter = 1 / 0.0254;
164-
var meterPerMapUnitValue = getMeterPerMapUnit(mapUnit);
165-
var resolution = scale * dpi * inchPerMeter * meterPerMapUnitValue;
166-
resolution = 1 / resolution;
167-
return resolution;
168-
};
140+
export var scaleToResolution = transformScaleToResolution;
169141

170142
/**
171143
* @function normalizeScale

‎src/mapboxgl/overlay/L7Layer.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import { featureFilter } from '@mapbox/mapbox-gl-style-spec';
1212
* @class L7Layer
1313
* @category Visualization L7
1414
* @version 11.2.0
15+
* @extends {L7LayerBase}
1516
* @classdesc L7Layer对接了@antv/L7的图层类型，能够通过mapbox-gl操作@antv/L7的图层。
1617
* @param {Object} options - 图层配置项，包括以下参数：
1718
* @param {string} options.type - @antv/L7的图层类型，详情参见: {@link https://l7.antv.antgroup.com/api/point_layer/pointlayer}。

‎src/maplibregl/mapping/WebMap.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import MapManager from './webmap/MapManager';
1616
* @version 11.2.1
1717
* @extends {WebMapBase}
1818
* @category iPortal/Online Resources Map
19+
* @classdesc 对接 iPortal/Online 地图类。
1920
* <div style="padding: 20px;border: 1px solid #eee;border-left-width: 5px;border-radius: 3px;border-left-color: #ce4844;">
2021
* <p style="color: #ce4844">Notice</p>
2122
* <p style="font-size: 13px">该功能可能依赖以下插件，请确认引入该插件。</p>

0 commit comments

Comments
 (0)