[fix]api优化 ol.source review by xiongjj

Author: luoxiao-supermap

build/jsdocs/openlayers/index.md

@@ -28,18 +28,18 @@ SuperMap iClient for OpenLayers 是一套基于OpenLayers的云GIS网络客户
     <th width="33.3%">可视化</th><th width="33.3%">地图</th><th width="33.3%"></th>
 </tr><tr>
     <td><p>丰富的可视化效果，矢量瓦片、客户端专题图、开源可视化库[ECharts](https://echarts.baidu.com/)，[MapV](https://mapv.baidu.com/)</p>
-        <a href="ol.source.VectorTileSuperMapRest.html">ol.source.VectorTileSuperMapRest</a><br>
-        <a href="ol.source.Graphic.html">ol.source.Graphic</a><br>
-        <a href="ol.source.DataFlow.html">ol.source.DataFlow</a><br>
-        <a href="ol.source.Range.html">ol.source.Range</a><br>
-        <a href="ol.source.Unique.html">ol.source.Unique</a><br>
-        <a href="ol.source.Mapv.html">ol.source.Mapv</a><br>
+        <a href="VectorTileSuperMapRest.html">VectorTileSuperMapRest</a><br>
+        <a href="Graphic.html">Graphic</a><br>
+        <a href="DataFlow.html">DataFlow</a><br>
+        <a href="Range.html">Range</a><br>
+        <a href="Unique.html">Unique</a><br>
+        <a href="Mapv.html">Mapv</a><br>
         ......</td>
     <td><p>丰富地图，iSevrer REST MAP、互联网地图</p>
-        <a href="ol.source.TileSuperMapRest.html">ol.source.TileSuperMapRest</a><br>
-        <a href="ol.source.ImageSuperMapRest.html">ol.source.ImageSuperMapRest</a><br>
-        <a href="ol.source.BaiduMap.html">ol.source.BaiduMap</a><br>
-        <a href="ol.source.Tianditu.html">ol.source.Tianditu</a><br>
+        <a href="TileSuperMapRest.html">TileSuperMapRest</a><br>
+        <a href="ImageSuperMapRest.html">ImageSuperMapRest</a><br>
+        <a href="BaiduMap.html">BaiduMap</a><br>
+        <a href="Tianditu.html">Tianditu</a><br>
          ......</td>
     <td><p></p>
 </tr></table>

build/jsdocs/plugins/usage.js

@@ -14,6 +14,7 @@ exports.defineTags = function (dictionary) {
         const deprecatedClasses = [];
         let aliasClass = '';
         let deprecatedClassInstance;
+        let browserNamespace = '';
         if (doclet.tags) {
           for (let index = 0; index < doclet.tags.length; index++) {
             const tag = doclet.tags[index];
@@ -26,14 +27,18 @@ exports.defineTags = function (dictionary) {
             if (tag.title === 'deprecatedclassinstance') {
               deprecatedClassInstance = tag.value;
             }
+            if (tag.title === 'browsernamespace') {
+              browserNamespace = tag.value;
+            }
           }
         }
         doclet.usage = {
           className: doclet.kind === 'class' ? doclet.name : '',
           aliasClass: aliasClass,
           globalParams,
           deprecatedClasses: deprecatedClasses,
-          deprecatedClassInstance: deprecatedClassInstance
+          deprecatedClassInstance: deprecatedClassInstance,
+          browserNamespace: browserNamespace
         };
       }
     }

build/jsdocs/template/tmpl/usage.tmpl

@@ -4,7 +4,7 @@
 <code>// 浏览器
 &lt;script type="text/javascript" src="<?js= data.globalParams.cdn ?>"&gt;&lt;/script&gt;
 &lt;script&gt;
-  <?js= "new {namespace}.{className}({paramsNames});".replace('{className}', data.aliasClass || data.className).replace('{namespace}',data.globalParams.namespace).replace('{paramsNames}',data.paramsNames?data.paramsNames.join(', '):'') ?>
+  <?js= "new {namespace}.{className}({paramsNames});".replace('{className}', data.aliasClass || data.className).replace('{namespace}',data.browserNamespace || data.globalParams.namespace).replace('{paramsNames}',data.paramsNames?data.paramsNames.join(', '):'') ?>
   <?js= data.deprecatedClasses.length > 0 || data.deprecatedClassInstance?'\r  // 弃用的写法\r\n':'' ?><?jsdata.deprecatedClasses.forEach(deprecatedClass => { ?><?js= "  new {deprecatedClass}({paramsNames});\r\n".replace('{deprecatedClass}',deprecatedClass).replace('{paramsNames}',data.paramsNames?data.paramsNames.join(', '):'') ?><?js}); ?><?js if(data.deprecatedClassInstance){ ?><?js= "  {deprecatedClassInstance}({paramsNames});".replace('{deprecatedClassInstance}',data.deprecatedClassInstance).replace('{paramsNames}',data.paramsNames?data.paramsNames.join(', '):'') ?>
   <?js } ?>
 &lt;/script&gt;

build/jsdocs/template/typeLinkExt.js

@@ -30,6 +30,7 @@ var typeLinks = {
     "ol.Object": olapi + "module-ol_Object-BaseObject.html",
     "ol.source.ImageCanvas": olapi + "module-ol_source_ImageCanvas-ImageCanvasSource.html",
     "ol.source.TileImage": olapi + "module-ol_source_TileImage-TileImage.html",
+    "ol.source.Image": olapi + "module-ol_source_Image-ImageSource.html",
     "ol.source.WMTS": olapi + "module-ol_source_WMTS-WMTS.html",
     "ol.source.XYZ": olapi + "module-ol_source_XYZ-XYZ.html",
     "ol.source.Vector": olapi + "module-ol_source_Vector-VectorSource.html",

src/openlayers/mapping/BaiduMap.js

@@ -7,14 +7,16 @@ import TileGrid from 'ol/tilegrid/TileGrid';
 import { Util } from '../core/Util';
 
 /**
- * @class ol.source.BaiduMap
+ * @class BaiduMap
+ * @browsernamespace ol.source
  * @category  ThirdPartyMap
  * @classdesc 百度地图图层源。
  * @param {Object} opt_options - 参数。
  * @param {string} [opt_options.url='http://online1.map.bdimg.com/onlinelabel/?qt=tile&x={x}&y={y}&z={z}&styles={styles}&udt=20170408'] - 服务地址。
  * @param {string} [opt_options.tileProxy] - 代理地址。
  * @param {boolean} [hidpi = false] - 是否使用高分辨率地图。
  * @extends {ol.source.TileImage}
+ * @usage
  */
 export class BaiduMap extends TileImage {
     constructor(opt_options) {
@@ -80,7 +82,7 @@ export class BaiduMap extends TileImage {
 
     // TODO 确认这个方法是否要开出去
     /**
-     * @function ol.source.BaiduMap.defaultTileGrid
+     * @function BaiduMap.defaultTileGrid
      * @description 获取默认瓦片格网。
      * @returns {ol.tilegrid.TileGrid} 返回瓦片格网对象。
      */

src/openlayers/mapping/ImageSuperMapRest.js

@@ -13,22 +13,23 @@ import GeoJSON from 'ol/format/GeoJSON';
 import { containsExtent, getCenter, getHeight, getWidth, getForViewAndSize } from 'ol/extent';
 
 /**
- * @class ol.source.ImageSuperMapRest
+ * @class ImageSuperMapRest
+ * @browsernamespace ol.source
  * @category iServer Map Tile
  * @classdesc SuperMap iServer Image 图层源。
  * @param {Object} options - 参数。
  * @param {string} options.url - 地图服务地址,例如: http://{ip}:{port}/iserver/services/map-world/rest/maps/World。
- * @param {SuperMap.ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务类型 ISERVER|IPORTAL|ONLINE。
+ * @param {ServerType} [options.serverType=SuperMap.ServerType.ISERVER] - 服务类型 ISERVER|IPORTAL|ONLINE。
  * @param {boolean} [options.redirect=false] - 是否重定向。
  * @param {boolean} [options.transparent=true] - 瓦片是否透明。
  * @param {boolean} [options.antialias=false] - 是否反走样地图。
  * @param {boolean} [options.cacheEnabled=true] - 是否使用服务端的缓存，true 表示使用服务端的缓存。
  * @param {Object} [options.prjCoordSys] - 请求的地图的坐标参考系统。当此参数设置的坐标系统不同于地图的原有坐标系统时， 系统会进行动态投影，并返回动态投影后的地图瓦片。例如：{"epsgCode":3857}。
  * @param {string} [options.layersID] - 获取进行切片的地图图层 ID，即指定进行地图切片的图层，可以是临时图层集，也可以是当前地图中图层的组合。
  * @param {boolean} [options.clipRegionEnabled = false] - 是否地图只显示该区域覆盖的部分。true 表示地图只显示该区域覆盖的部分。
- * @param {(ol/geom/Geometry|ol/geom/Geometry)} [options.clipRegion] - 地图显示裁剪的区域。是一个面对象，当 clipRegionEnabled = true 时有效，即地图只显示该区域覆盖的部分。
+ * @param {ol.geom.Geometry} [options.clipRegion] - 地图显示裁剪的区域。是一个面对象，当 clipRegionEnabled = true 时有效，即地图只显示该区域覆盖的部分。
  * @param {boolean} [options.overlapDisplayed=false] - 地图对象在同一范围内时，是否重叠显示。如果为 true，则同一范围内的对象会直接压盖；如果为 false 则通过 overlapDisplayedOptions 控制对象不压盖显示。
- * @param {SuperMap.OverlapDisplayedOptions} [options.overlapDisplayedOptions] - 避免地图对象压盖显示的过滤选项，当 overlapDisplayed 为 false 时有效，用来增强对地图对象压盖时的处理。
+ * @param {OverlapDisplayedOptions} [options.overlapDisplayedOptions] - 避免地图对象压盖显示的过滤选项，当 overlapDisplayed 为 false 时有效，用来增强对地图对象压盖时的处理。
  * @param {boolean} [options.markerAngleFixed=false] - 指定点状符号的角度是否固定。
  * @param {boolean} [options.textAngleFixed=false] - 文本角度是否固定。
  * @param {boolean} [options.textOrientationFixed=false] - 文本朝向是否固定。
@@ -38,11 +39,12 @@ import { containsExtent, getCenter, getHeight, getWidth, getForViewAndSize } fro
  * @param {boolean} [options.minVisibleTextSize] - 文本的最小可见尺寸，单位为像素。
  * @param {string} [options.tileversion] - 切片版本名称，_cache 为 true 时有效。
  * @param {string} [options.tileProxy] - 代理地址。
- * @param {(SuperMap.NDVIParameter|SuperMap.HillshadeParameter)} [options.rasterfunction] - 栅格分析参数。
+ * @param {NDVIParameter|HillshadeParameter} [options.rasterfunction] - 栅格分析参数。
  * @param {string} [options.format = 'png'] - 瓦片表述类型，支持 "png" 、"webp"、"bmp" 、"jpg"、 "gif" 等图片类型。
  * @param {Function} [options.imageLoadFunction] - 加载图片的方法。默认为function(imageTile, src) {imageTile.getImage().src = src;};
  * @param {string} [options.ratio=1.5] - 	请求图片大小比例. 1 表示请求图片大小和地图视窗范围一致, 2 表示请求图片大小是地图视窗范围的2倍，以此类推。
- * @extends {ol.source.TileImage}
+ * @extends {ol.source.Image}
+ * @usage
  */
  export class ImageSuperMapRest extends ImageSource {
   constructor(options) {
@@ -202,7 +204,7 @@ import { containsExtent, getCenter, getHeight, getWidth, getForViewAndSize } fro
     return imageUrl;
   }
   /**
-   * @function ol.source.ImageSuperMapRest.optionsFromMapJSON
+   * @function ImageSuperMapRest.optionsFromMapJSON
    * @param {string} url - 地址。
    * @param {Object} mapJSONObj - 地图 JSON。
    * @description 获取地图 JSON 信息。

src/openlayers/mapping/ImageTileSuperMapRest.js

@@ -7,7 +7,8 @@ import { SecurityManager } from '@supermap/iclient-common/security/SecurityManag
 import { Util as CommonUtil } from '@supermap/iclient-common/commontypes/Util';
 
 /**
- * @class ol.source.ImageTileSuperMapRest
+ * @class ImageTileSuperMapRest
+ * @browsernamespace ol.source
  * @version 10.2.0
  * @category  iServer Image
  * @classdesc iServer影像服务图层源。根据指定的请求参数，返回影像数据栅格瓦片并渲染。
@@ -24,6 +25,7 @@ import { Util as CommonUtil } from '@supermap/iclient-common/commontypes/Util';
  * @param {string} [options.tileProxy] -  代理地址
  * @param {string} [options.attribution='Map Data <span>© <a href='http://support.supermap.com.cn/product/iServer.aspx' title='SuperMap iServer' target='_blank'>SuperMap iServer</a></span>'] - 版权信息。
  * @extends {ol.source.XYZ}
+ * @usage
  */
 export class ImageTileSuperMapRest extends XYZ {
     constructor(options) {

src/openlayers/mapping/SuperMapCloud.js

@@ -5,13 +5,15 @@
 import XYZ from 'ol/source/XYZ';
 
 /**
- * @class ol.source.SuperMapCloud
+ * @class SuperMapCloud
+ * @browsernamespace ol.source
  * @category  ThirdPartyMap
  * @classdesc 超图云地图图层源。
  * @param {Object} opt_options - 参数。
  * @param {string} [opt_options.url='http://t2.dituhui.com/FileService/image?map={mapName}&type={type}&x={x}&y={y}&z={z}'] - 服务地址。
  * @param {string} [opt_options.tileProxy] - 代理地址。
  * @extends {ol.source.XYZ}
+ * @usage
  */
 export class SuperMapCloud extends XYZ {
 

src/openlayers/mapping/Tianditu.js

@@ -6,7 +6,8 @@ import WMTS from 'ol/source/WMTS';
 import WMTSTileGrid from 'ol/tilegrid/WMTS';
 
 /**
- * @class ol.source.Tianditu
+ * @class Tianditu
+ * @browsernamespace ol.source
  * @category  ThirdPartyMap
  * @classdesc 天地图图层源。
  * @param {Object} opt_options - 参数。
@@ -22,6 +23,7 @@ import WMTSTileGrid from 'ol/tilegrid/WMTS';
  * @param {boolean} [opt_options.opaque=true] - 是否透明。
  * @param {string} [opt_options.tileProxy] - 代理地址。
  * @extends {ol.source.WMTS}
+ * @usage
  */
 export class Tianditu extends WMTS {
   constructor(opt_options) {
@@ -91,7 +93,7 @@ export class Tianditu extends WMTS {
   }
 
   /**
-   * @function ol.source.Tianditu.getTileGrid
+   * @function Tianditu.getTileGrid
    * @description 获取瓦片网格。
    * @param {string} projection - 投影参考对象。
    * @returns {ol.tilegrid.WMTS} 返回瓦片网格对象
@@ -104,7 +106,7 @@ export class Tianditu extends WMTS {
   }
 
   /**
-   * @function ol.source.Tianditu.default4326TileGrid
+   * @function Tianditu.default4326TileGrid
    * @description 获取默认 4326 网格瓦片。
    * @returns {ol.tilegrid.WMTS} 返回默认 4326 网格瓦片对象。
    */
@@ -126,7 +128,7 @@ export class Tianditu extends WMTS {
   }
 
   /**
-   * @function ol.source.Tianditu.default3857TileGrid
+   * @function Tianditu.default3857TileGrid
    * @description 获取默认 3857 网格瓦片。
    * @returns {ol.tilegrid.WMTS} 返回默认 3857 网格瓦片对象。
    */

src/openlayers/mapping/TileSuperMapRest.js

@@ -14,7 +14,8 @@ import * as olTilegrid from 'ol/tilegrid';
 import TileGrid from 'ol/tilegrid/TileGrid';
 
 /**
- * @class ol.source.TileSuperMapRest
+ * @class TileSuperMapRest
+ * @browsernamespace ol.source
  * @category iServer Map Tile
  * @classdesc SuperMap iServer TileImage 图层源。
  * @param {Object} options - 参数。
@@ -34,6 +35,7 @@ import TileGrid from 'ol/tilegrid/TileGrid';
  * @param {string} [options.format = 'png'] - 瓦片表述类型，支持 "png" 、"webp"、"bmp" 、"jpg"、 "gif" 等图片类型。
  * @param {(NDVIParameter|HillshadeParameter)} [options.rasterfunction] - 栅格分析参数。
  * @extends {ol.source.TileImage}
+ * @usage
  */
 export class TileSuperMapRest extends TileImage {
     constructor(options) {
@@ -75,7 +77,7 @@ export class TileSuperMapRest extends TileImage {
         var layerUrl = CommonUtil.urlPathAppend(options.url, 'tileImage.' + options.format);
 
         /**
-         * @function  ol.source.TileSuperMapRest.prototype.getAllRequestParams
+         * @function  TileSuperMapRest.prototype.getAllRequestParams
          * @description 获取全部请求参数。
          */
         function getAllRequestParams() {
@@ -134,7 +136,7 @@ export class TileSuperMapRest extends TileImage {
         }
 
         /**
-         * @function  ol.source.TileSuperMapRest.prototype.getFullRequestUrl
+         * @function  TileSuperMapRest.prototype.getFullRequestUrl
          * @description 获取完整的请求地址。
          */
         function getFullRequestUrl() {
@@ -146,7 +148,7 @@ export class TileSuperMapRest extends TileImage {
         }
 
         /**
-         * @function  ol.source.TileSuperMapRest.prototype.createLayerUrl
+         * @function  TileSuperMapRest.prototype.createLayerUrl
          * @description 获取新建图层地址。
          */
         function createLayerUrl() {
@@ -215,7 +217,7 @@ export class TileSuperMapRest extends TileImage {
     }
 
     /**
-     * @function  ol.source.TileSuperMapRest.prototype.setTileSetsInfo
+     * @function  TileSuperMapRest.prototype.setTileSetsInfo
      * @description 设置瓦片集信息。
      * @param {Object} tileSets - 瓦片集合。
      */
@@ -237,7 +239,7 @@ export class TileSuperMapRest extends TileImage {
     }
 
     /**
-     * @function  ol.source.TileSuperMapRest.prototype.lastTilesVersion
+     * @function  TileSuperMapRest.prototype.lastTilesVersion
      * @description 请求上一个版本切片，并重新绘制。
      */
     lastTilesVersion() {
@@ -246,7 +248,7 @@ export class TileSuperMapRest extends TileImage {
     }
 
     /**
-     * @function  ol.source.TileSuperMapRest.prototype.nextTilesVersion
+     * @function  TileSuperMapRest.prototype.nextTilesVersion
      * @description 请求下一个版本切片，并重新绘制。
      */
     nextTilesVersion() {
@@ -255,7 +257,7 @@ export class TileSuperMapRest extends TileImage {
     }
 
     /**
-     * @function  ol.source.TileSuperMapRest.prototype.changeTilesVersion
+     * @function  TileSuperMapRest.prototype.changeTilesVersion
      * @description 切换到某一版本的切片，并重绘。通过 this.tempIndex 保存需要切换的版本索引。
      */
     changeTilesVersion() {
@@ -285,7 +287,7 @@ export class TileSuperMapRest extends TileImage {
     }
 
     /**
-     * @function  ol.source.TileSuperMapRest.prototype.updateCurrentTileSetsIndex
+     * @function  TileSuperMapRest.prototype.updateCurrentTileSetsIndex
      * @description 更新当前切片集索引，目前主要提供给控件使用。
      * @param {number} index - 索引号。
      */
@@ -294,7 +296,7 @@ export class TileSuperMapRest extends TileImage {
     }
 
     /**
-     * @function  ol.source.TileSuperMapRest.prototype.mergeTileVersionParam
+     * @function  TileSuperMapRest.prototype.mergeTileVersionParam
      * @description 更改 URL 请求参数中的切片版本号，并重绘。
      * @param {Object} version - 版本信息。
      * @returns {boolean} 是否成功。
@@ -310,7 +312,7 @@ export class TileSuperMapRest extends TileImage {
     }
 
     /**
-     * @function  ol.source.TileSuperMapRest.optionsFromMapJSON
+     * @function  TileSuperMapRest.optionsFromMapJSON
      * @description 从 MapJSON 中获取参数对象。
      * @param {string} url - 服务地址。
      * @param {Object} mapJSONObj - 地图 JSON 对象。
@@ -364,7 +366,7 @@ export class TileSuperMapRest extends TileImage {
     }
 
     /**
-     * @function  ol.source.TileSuperMapRest.createTileGrid
+     * @function  TileSuperMapRest.createTileGrid
      * @description 创建切片网格。
      * @param {number} extent - 长度。
      * @param {number} maxZoom - 最大的放大级别。