修改initMap version 为 11.0.1

xilanhuaweidapao · xilanhuaweidapao · commit f23a10ead00e · 2022-10-19T18:43:34.000+08:00
diff --git a/src/common/util/MapCalculateUtil.js b/src/common/util/MapCalculateUtil.js
@@ -112,7 +112,32 @@ export function conversionDegree(degrees) {
     return `${degree}°${fraction}'${second}`;
 }
 
-export function scalesToResolutions(scales, bounds, dpi, mapUnit, level = 22) {
+/**
+  * @function scalesToResolutions
+  * @description 通过比例尺数组计算分辨率数组，没有传入比例尺数组时通过地图范围与地图最大级别进行计算。
+  * @version 11.0.1
+  * @param {Array} scales - 比例尺数组。
+  * @param {Object} bounds - 地图范围。
+  * @param {number} dpi - 屏幕分辨率。
+  * @param {string} mapUnit - 地图单位。
+  * @param {number} [level=22] - 地图最大级别。
+  * @returns {number} 分辨率。
+  * @usage
+  * ```
+  * // 浏览器
+  * <script type="text/javascript" src="{cdn}"></script>
+  * <script>
+  *   const result = {namespace}.scalesToResolutions(scales, bounds, dpi, mapUnit);
+  *
+  * </script>
+  *
+  * // ES6 Import
+  * import { scalesToResolutions } from '{npm}';
+  *
+  * const result = scalesToResolutions(scales, bounds, dpi, mapUnit);
+  * ```
+ */
+ export function scalesToResolutions(scales, bounds, dpi, mapUnit, level = 22) {
   var resolutions = [];
   if (scales && scales.length > 0) {
     for (let i = 0; i < scales.length; i++) {
@@ -128,7 +153,28 @@ export function scalesToResolutions(scales, bounds, dpi, mapUnit, level = 22) {
     return b - a;
   });
 }
-
+/**
+  * @function getZoomByResolution
+  * @description 通过分辨率获取地图级别。
+  * @version 11.0.1
+  * @param {number} resolution - 分辨率。
+  * @param {Array} resolutions - 分辨率数组。
+  * @returns {number} 地图级别。
+  * @usage
+  * ```
+  * // 浏览器
+  * <script type="text/javascript" src="{cdn}"></script>
+  * <script>
+  *   const result = {namespace}.getZoomByResolution(resolution, resolutions);
+  *
+  * </script>
+  *
+  * // ES6 Import
+  * import { getZoomByResolution } from '{npm}';
+  *
+  * const result = getZoomByResolution(resolution, resolutions);
+  * ```
+ */
 export function getZoomByResolution(resolution, resolutions) {
   let zoom = 0;
   let minDistance;
@@ -144,6 +190,29 @@ export function getZoomByResolution(resolution, resolutions) {
   return zoom;
 }
 
+/**
+  * @function scaleToResolution
+  * @description 通过比例尺计算分辨率。
+  * @version 11.0.1
+  * @param {number} scale - 比例尺。
+  * @param {number} dpi - 屏幕分辨率。
+  * @param {string} mapUnit - 地图单位。
+  * @returns {number} 分辨率。
+  * @usage
+  * ```
+  * // 浏览器
+  * <script type="text/javascript" src="{cdn}"></script>
+  * <script>
+  *   const result = {namespace}.scaleToResolution(scale, dpi, mapUnit);
+  *
+  * </script>
+  *
+  * // ES6 Import
+  * import { scaleToResolution } from '{npm}';
+  *
+  * const result = scaleToResolution(scale, dpi, mapUnit);
+  * ```
+ */
 export function scaleToResolution(scale, dpi, mapUnit) {
   const inchPerMeter = 1 / 0.0254;
   const meterPerMapUnitValue = getMeterPerMapUnit(mapUnit);
diff --git a/src/leaflet/mapping/initMap.js b/src/leaflet/mapping/initMap.js
@@ -13,6 +13,7 @@ import proj4 from 'proj4';
  * @function initMap
  * @description 根据 SuperMap iServer 服务参数，创建地图与图层。目前仅支持SuperMap iServer 地图服务，创建的图层为 TiledMapLayer。
  * @category BaseTypes Util
+ * @version 11.0.1
  * @example
  *       initMap(url, {mapOptions, layerOptions});
  * @param {string} url - 服务地址，例如: http://{ip}:{port}/iserver/services/map-world/rest/maps/World。
@@ -64,6 +65,7 @@ export function initMap(url, options) {
  * @function crsFromMapJSON
  * @description 通过iServer REST地图的配置信息，构建地图的CRS（非平面投影、EPSG:3857、EPSG:4326需要先注册投影）。
  * @category BaseTypes Util
+ * @version 11.0.1
  * @param {Object} mapJSONObj - 地图参数。
  * @param {Object} mapJSONObj.prjCoordSys - 投影配置。
  * @param {Object} mapJSONObj.bounds - 范围。
diff --git a/src/openlayers/mapping/InitMap.js b/src/openlayers/mapping/InitMap.js
@@ -14,6 +14,7 @@ window.proj4 = proj4;
  * @function initMap
  * @description 根据 SuperMap iServer 服务参数，创建地图与图层。目前仅支持SuperMap iServer 地图服务，创建的图层为 ol.Tile。
  * @category BaseTypes Util 
+ * @version 11.0.1
  * @param {number} url - 服务地址,例如: http://{ip}:{port}/iserver/services/map-world/rest/maps/World。
  * @param {Object} options - 参数。
  * @param {Object} [options.mapOptions] - 地图配置，参数设置参考 {@link https://openlayers.org/en/v6.15.1/apidoc/module-ol_Map-Map.html}。
@@ -63,6 +64,7 @@ export function initMap(url, options = {}) {
 /**
  * @function  viewOptionsFromMapJSON
  * @category BaseTypes Util
+ * @version 11.0.1
  * @description 通过 iServer REST 地图参数构造 ol 视图对象。
  * @param {Object} mapJSONObj - 地图 JSON 对象。
  * @param {number} [level=22] - 地图最大级别。
