@@ -112,7 +112,32 @@ export function conversionDegree(degrees) {
112112 return `${ degree } °${ fraction } '${ second } ` ;
113113}
114114
115- export function scalesToResolutions ( scales , bounds , dpi , mapUnit , level = 22 ) {
115+ /**
116+ * @function scalesToResolutions
117+ * @description 通过比例尺数组计算分辨率数组,没有传入比例尺数组时通过地图范围与地图最大级别进行计算。
118+ * @version 11.0.1
119+ * @param {Array } scales - 比例尺数组。
120+ * @param {Object } bounds - 地图范围。
121+ * @param {number } dpi - 屏幕分辨率。
122+ * @param {string } mapUnit - 地图单位。
123+ * @param {number } [level=22] - 地图最大级别。
124+ * @returns {number } 分辨率。
125+ * @usage
126+ * ```
127+ * // 浏览器
128+ * <script type="text/javascript" src="{cdn}"></script>
129+ * <script>
130+ * const result = {namespace}.scalesToResolutions(scales, bounds, dpi, mapUnit);
131+ *
132+ * </script>
133+ *
134+ * // ES6 Import
135+ * import { scalesToResolutions } from '{npm}';
136+ *
137+ * const result = scalesToResolutions(scales, bounds, dpi, mapUnit);
138+ * ```
139+ */
140+ export function scalesToResolutions ( scales , bounds , dpi , mapUnit , level = 22 ) {
116141 var resolutions = [ ] ;
117142 if ( scales && scales . length > 0 ) {
118143 for ( let i = 0 ; i < scales . length ; i ++ ) {
@@ -128,7 +153,28 @@ export function scalesToResolutions(scales, bounds, dpi, mapUnit, level = 22) {
128153 return b - a ;
129154 } ) ;
130155}
131-
156+ /**
157+ * @function getZoomByResolution
158+ * @description 通过分辨率获取地图级别。
159+ * @version 11.0.1
160+ * @param {number } resolution - 分辨率。
161+ * @param {Array } resolutions - 分辨率数组。
162+ * @returns {number } 地图级别。
163+ * @usage
164+ * ```
165+ * // 浏览器
166+ * <script type="text/javascript" src="{cdn}"></script>
167+ * <script>
168+ * const result = {namespace}.getZoomByResolution(resolution, resolutions);
169+ *
170+ * </script>
171+ *
172+ * // ES6 Import
173+ * import { getZoomByResolution } from '{npm}';
174+ *
175+ * const result = getZoomByResolution(resolution, resolutions);
176+ * ```
177+ */
132178export function getZoomByResolution ( resolution , resolutions ) {
133179 let zoom = 0 ;
134180 let minDistance ;
@@ -144,6 +190,29 @@ export function getZoomByResolution(resolution, resolutions) {
144190 return zoom ;
145191}
146192
193+ /**
194+ * @function scaleToResolution
195+ * @description 通过比例尺计算分辨率。
196+ * @version 11.0.1
197+ * @param {number } scale - 比例尺。
198+ * @param {number } dpi - 屏幕分辨率。
199+ * @param {string } mapUnit - 地图单位。
200+ * @returns {number } 分辨率。
201+ * @usage
202+ * ```
203+ * // 浏览器
204+ * <script type="text/javascript" src="{cdn}"></script>
205+ * <script>
206+ * const result = {namespace}.scaleToResolution(scale, dpi, mapUnit);
207+ *
208+ * </script>
209+ *
210+ * // ES6 Import
211+ * import { scaleToResolution } from '{npm}';
212+ *
213+ * const result = scaleToResolution(scale, dpi, mapUnit);
214+ * ```
215+ */
147216export function scaleToResolution ( scale , dpi , mapUnit ) {
148217 const inchPerMeter = 1 / 0.0254 ;
149218 const meterPerMapUnitValue = getMeterPerMapUnit ( mapUnit ) ;
0 commit comments