8000 [fix]MapCaculateUtil doc关闭 · SuperMap/iClient-JavaScript@60a434c · GitHub
[go: up one dir, main page]
Skip to content

Commit 60a434c

Browse files
luoxiao-supermapluoxiao-supermap
committed
[fix]MapCaculateUtil doc关闭
1 parent 9905f9b commit 60a434c

File tree

1 file changed

+75
-72
lines changed

1 file changed

+75
-72
lines changed

‎src/common/util/MapCalculateUtil.js

Lines changed: 75 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { Unit } from '../REST';
22

33
/**
4+
* @private
45
* @function getMeterPerMapUnit
56
* @description 单位换算，把米|度|千米|英寸|英尺换成米。
67
* @category BaseTypes Util
@@ -43,6 +44,7 @@ export var getMeterPerMapUnit = function(mapUnit) {
4344
};
4445

4546
/**
47+
* @private
4648
* @function getWrapNum
4749
* @description 获取该坐标系的经纬度范围的经度或纬度。
4850
* @category BaseTypes Util
@@ -84,6 +86,7 @@ export function getWrapNum(x, includeMax = true, includeMin = true, range = [-18
8486
}
8587

8688
/**
89+
* @private
8790
* @function conversionDegree
8891
* @description 转换经纬度。
8992
* @category BaseTypes Util
@@ -114,29 +117,30 @@ export function conversionDegree(degrees) {
114117
}
115118

116119
/**
117-
* @function scalesToResolutions
118-
* @description 通过比例尺数组计算分辨率数组，没有传入比例尺数组时通过地图范围与地图最大级别进行计算。
119-
* @version 11.0.1
120-
* @param {Array} scales - 比例尺数组。
121-
* @param {Object} bounds - 地图范围。
122-
* @param {number} dpi - 屏幕分辨率。
123-
* @param {string} mapUnit - 地图单位。
124-
* @param {number} [level=22] - 地图最大级别。
125-
* @returns {number} 分辨率。
126-
* @usage
127-
* ```
128-
* // 浏览器
129-
* <script type="text/javascript" src="{cdn}"></script>
130-
* <script>
131-
* const result = {namespace}.scalesToResolutions(scales, bounds, dpi, mapUnit);
132-
*
133-
* </script>
134-
*
135-
* // ES6 Import
136-
* import { scalesToResolutions } from '{npm}';
137-
*
138-
* const result = scalesToResolutions(scales, bounds, dpi, mapUnit);
139-
* ```
120+
* @private
121+
* @function scalesToResolutions
122+
* @description 通过比例尺数组计算分辨率数组，没有传入比例尺数组时通过地图范围与地图最大级别进行计算。
123+
* @version 11.0.1
124+
* @param {Array} scales - 比例尺数组。
125+
* @param {Object} bounds - 地图范围。
126+
* @param {number} dpi - 屏幕分辨率。
127+
* @param {string} mapUnit - 地图单位。
128+
* @param {number} [level=22] - 地图最大级别。
129+
* @returns {number} 分辨率。
130+
* @usage
131+
* ```
132+
* // 浏览器
133+
* <script type="text/javascript" src="{cdn}"></script>
134+
* <script>
135+
* const result = {namespace}.scalesToResolutions(scales, bounds, dpi, mapUnit);
136+
*
137+
* </script>
138+
*
139+
* // ES6 Import
140+
* import { scalesToResolutions } from '{npm}';
141+
*
142+
* const result = scalesToResolutions(scales, bounds, dpi, mapUnit);
143+
* ```
140144
*/
141145
export function scalesToResolutions(scales, bounds, dpi, mapUnit, level = 22) {
142146
var resolutions = [];
@@ -155,26 +159,27 @@ export function conversionDegree(degrees) {
155159
});
156160
}
157161
/**
158-
* @function getZoomByResolution
159-
* @description 通过分辨率获取地图级别。
160-
* @version 11.0.1
161-
* @param {number} resolution - 分辨率。
162-
* @param {Array} resolutions - 分辨率数组。
163-
* @returns {number} 地图级别。
164-
* @usage
165-
* ```
166-
* // 浏览器
167-
* <script type="text/javascript" src="{cdn}"></script>
168-
* <script>
169-
* const result = {namespace}.getZoomByResolution(resolution, resolutions);
170-
*
171-
* </script>
172-
*
173-
* // ES6 Import
174-
* import { getZoomByResolution } from '{npm}';
175-
*
176-
* const result = getZoomByResolution(resolution, resolutions);
177-
* ```
162+
* @private
163+
* @function getZoomByResolution
164+
* @description 通过分辨率获取地图级别。
165+
* @version 11.0.1
166+
* @param {number} resolution - 分辨率。
167+
* @param {Array} resolutions - 分辨率数组。
168+
* @returns {number} 地图级别。
169+
* @usage
170+
* ```
171+
* // 浏览器
172+
* <script type="text/javascript" src="{cdn}"></script>
173+
* <script>
174+
* const result = {namespace}.getZoomByResolution(resolution, resolutions);
175+
*
176+
* </script>
177+
*
178+
* // ES6 Import
179+
* import { getZoomByResolution } from '{npm}';
180+
*
181+
* const result = getZoomByResolution(resolution, resolutions);
182+
* ```
178183
*/
179184
export function getZoomByResolution(resolution, resolutions) {
180185
let zoom = 0;
@@ -192,27 +197,28 @@ export function getZoomByResolution(resolution, resolutions) {
192197
}
193198

194199
/**
195-
* @function scaleToResolution
196-
* @description 通过比例尺计算分辨率。
197-
* @version 11.0.1
198-
* @param {number} scale - 比例尺。
199-
* @param {number} dpi - 屏幕分辨率。
200-
* @param {string} mapUnit - 地图单位。
201-
* @returns {number} 分辨率。
202-
* @usage
203-
* ```
204-
* // 浏览器
205-
* <script type="text/javascript" src="{cdn}"></script>
206-
* <script>
207-
* const result = {namespace}.scaleToResolution(scale, dpi, mapUnit);
208-
*
209-
* </script>
210-
*
211-
* // ES6 Import
212-
* import { scaleToResolution } from '{npm}';
213-
*
214-
* const result = scaleToResolution(scale, dpi, mapUnit);
215-
* ```
200+
* @private
201+
* @function scaleToResolution
202+
* @description 通过比例尺计算分辨率。
203+
* @version 11.0.1
204+
* @param {number} scale - 比例尺。
205+
* @param {number} dpi - 屏幕分辨率。
206+
* @param {string} mapUnit - 地图单位。
207+
* @returns {number} 分辨率。
208+
* @usage
209+
* ```
210+
* // 浏览器
211+
* <script type="text/javascript" src="{cdn}"></script>
212+
* <script>
213+
* const result = {namespace}.scaleToResolution(scale, dpi, mapUnit);
214+
*
215+
* </script>
216+
*
217+
* // ES6 Import
218+
* import { scaleToResolution } from '{npm}';
219+
*
220+
* const result = scaleToResolution(scale, dpi, mapUnit);
221+
* ```
216222
*/
217223
export function scaleToResolution(scale, dpi, mapUnit) {
218224
const inchPerMeter = 1 / 0.0254;
@@ -222,28 +228,25 @@ export function scaleToResolution(scale, dpi, mapUnit) {
222228
}
223229

224230
/**
231+
* @private
225232
* 范围是否相交
226233
* @param {Array} extent1 范围1
227234
* @param {Array} extent2 范围2
228235
* @return {boolean} 范围是否相交。
229236
*/
230-
export function intersects(extent1, extent2) {
231-
return (
232-
extent1[0] <= extent2[2] &&
233-
extent1[2] >= extent2[0] &&
234-
extent1[1] <= extent2[3] &&
235-
extent1[3] >= extent2[1]
236-
);
237+
export function intersects(extent1, extent2) {
238+
return extent1[0] <= extent2[2] && extent1[2] >= extent2[0] && extent1[1] <= extent2[3] && extent1[3] >= extent2[1];
237239
}
238240

239241
/**
242+
* @private
240243
* 获取两个范围的交集
241244
* @param {Array} extent1 Extent 1
242245
* @param {Array} extent2 Extent 2
243246
* @return {Array} 相交范围数组.
244247
* @api
245248
*/
246-
export function getIntersection(extent1, extent2) {
249+
export function getIntersection(extent1, extent2) {
247250
const intersection = [];
248251
if (intersects(extent1, extent2)) {
249252
if (extent1[0] > extent2[0]) {

0 commit comments

Comments
 (0)
0