【update】 视频地图相关api文档优化； review by qiwei

zhangjiangqiu · zhangjiangqiu · commit 2f6789618876 · 2022-03-24T19:30:15.000+08:00
diff --git a/src/mapboxgl/mapping/VideoMap.js b/src/mapboxgl/mapping/VideoMap.js
@@ -4,7 +4,7 @@ import Coordtransfer from './coordTransfer';
 import GeojsonLayer from './layers/GeojsonLayer';
 import VideoMarker from './VideoMarker';
 import GeojsonSource from './GeojsonSource';
-import VideoPopup from './VideoPopup';
+import VideoMapPopup from './VideoMapPopup';
 import VideoLayer from './layers/VideoLayer';
 import { coordEach } from '@turf/meta';
 import { transformCoordReverse } from './util';
@@ -73,7 +73,6 @@ const MAP_DRAW_EVENTS = [
 /**
  * @class SuperMap.VideoMap
  * @classdesc 视频地图
- * @category iServer VideoMap
  * @param {Object} options - 参数
  * @param {string} [options.container='map'] - 地图容器id
  * @param {string} [options.src] - 视频地址
@@ -274,7 +273,7 @@ export class VideoMap extends mapboxgl.Evented {
     if (!this._mapExisted()) {
       return;
     }
-    return new VideoPopup(this, options);
+    return new VideoMapPopup(this, options);
   }
   /**
    * @function SuperMap.VideoMap.prototype.addLayer
diff --git a/src/mapboxgl/mapping/VideoMapDraw.js b/src/mapboxgl/mapping/VideoMapDraw.js
@@ -5,7 +5,6 @@ import '@mapbox/mapbox-gl-draw/dist/mapbox-gl-draw.css';
 /**
  * @class SuperMap.VideoMapDraw
  * @classdesc 视频地图标绘。
- * @category iServer VideoMap
  * @param {Object} options - 标绘配置 详见：{@link https://github.com/mapbox/mapbox-gl-draw/blob/main/docs/API.md}。
  */
 
diff --git a/src/mapboxgl/mapping/VideoMapPopup.js b/src/mapboxgl/mapping/VideoMapPopup.js
@@ -5,7 +5,7 @@ import { SuperMap } from '@supermap/iclient-common';
 const POPUP_EVENTS = ['open', 'close'];
 
 /**
- * @class SuperMap.VideoPupup
+ * @class SuperMap.VideoMapPopup
  * @classdesc  视频地图 popup
  * @param {Object} videoMap - 视频地图实例。
  * @param {Object} options - Marker 配置 详见：{@link https://docs.mapbox.com/mapbox-gl-js/api/markers/#popup-parameters}。
diff --git a/src/mapboxgl/mapping/VideoMarker.js b/src/mapboxgl/mapping/VideoMarker.js
@@ -1,6 +1,6 @@
 import mapboxgl from 'mapbox-gl';
 import { transformCoord } from './util';
-import VideoPopup from './VideoPopup';
+import VideoMapPopup from './VideoMapPopup';
 import { SuperMap } from '@supermap/iclient-common';
 
 const MARKER_EVENTS = ['drag', 'dragstart', 'dragend'];
@@ -50,7 +50,7 @@ export default class VideoMarker extends mapboxgl.Evented {
    * @returns {Marker} Marker 实例。
    */
   setPopup(popup) {
-    if (popup instanceof VideoPopup) {
+    if (popup instanceof VideoMapPopup) {
       this.marker.setPopup(popup.popup);
       return this;
     }
diff --git a/src/mapboxgl/mapping/index.js b/src/mapboxgl/mapping/index.js
@@ -6,4 +6,4 @@ export { WebMap } from './WebMap';
 export { VideoMapDraw } from './VideoMapDraw';
 export { VideoMap } from './VideoMap';
 export { default as VideoMarker } from './VideoMarker';
-export { default as VideoPopup } from './VideoPopup';
+export { default as VideoMapPopup } from './VideoMapPopup';
