csk-gis-frame-work 4.0.0

package/mapgis/js/datalayer/ogc-layer/wmsLayer.js

@@ -0,0 +1,418 @@
+import DataUtils from '../../../../mapboxgl/js/utils/DataUtils';
+import {removeLayerFromManager} from "../";
+
+/**
+ * 定义 MapGIS Common API WMS图层类
+ *
+ * @alias WMSLayer
+ *
+ * @summary <用于加载和管理WMS服务图层,基于 MapGIS Client for JavaScript Common 模块>
+ * @description 该类负责具体的图层操作逻辑,包括图层的加载、显示/隐藏、移除等。
+ *              底层通过 zondy.layer.WMSLayer 与地图进行交互。
+ */
+export default class WMSLayer {
+    /**
+     * 构造函数
+     * @param {Object} options - 图层配置选项
+     * @param {Object} options.map - 地图对象(mapboxgl.Map 实例)
+     * @param {String} options.url - 服务基地址
+     * @param {String} [options.id] - 图层ID(可选,不传则自动生成)
+     * @param {String} [options.title=''] - 图层标题
+     * @param {Object} [options.spatialReference] - 坐标系
+     * @param {Number} [options.opacity=1] - 图层透明度 (0-1)
+     * @param {Boolean} [options.visible=true] - 图层可见性
+     * @param {Number} [options.imageWidth=256] - 图片宽度(px)
+     * @param {Number} [options.imageHeight=256] - 图片高度(px)
+     * @param {Number} [options.minScale=0] - 最小显示比例尺
+     * @param {Number} [options.maxScale=0] - 最大显示比例尺
+     * @param {Boolean} [options.imageTransparency=true] - 图片中没有数据的地方是否透明
+     * @param {Object} [options.clippingArea] - 图层空间裁剪范围
+     * @param {Boolean|null} [options.isReverseXY=null] - 是否翻转出图范围bbox参数的x、y坐标
+     * @param {Array} [options.sublayers=[]] - 子图层参数配置
+     * @param {String} [options.tokenKey='token'] - Token键名
+     * @param {String} [options.tokenValue=''] - Token值
+     * @param {String} [options.renderMode='tile'] - 影像的展现形式('tile'或'image')
+     */
+    constructor(options) {
+        /**
+         * 地图对象
+         * @type {Object}
+         */
+        this._map = options.map;
+
+        /**
+         * 视图对象
+         * @type {Object}
+         */
+        this._view = options.view;
+
+        this._layer = null
+
+        /**
+         * 服务基地址
+         * 支持的服务如下:
+         * 1. MapGIS的WMS服务:
+         *    - IGS1.0: http://{ip}:{port}/igs/rest/ogc/doc/{folder}:{serviceName}/WMSServer
+         *    - IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/WMSServer
+         * 2. ArcGIS的WMS服务:
+         *    - http://{ip}:{port}/arcgis/rest/services/{ServiceName}/WMSServer
+         * @type {String}
+         */
+        this._url = options.url;
+
+        /**
+         * 图层标题
+         * @type {String}
+         */
+        this._title = DataUtils.default(options.title, '');
+
+        /**
+         * 坐标系
+         * 支持4326、3857以及EPSG上的自定义坐标系
+         * 坐标系默认从元信息中获取,也可指定坐标系
+         * @type {Object|null}
+         */
+        this._spatialReference = DataUtils.default(options.spatialReference, null);
+
+        /**
+         * 图层ID
+         * @type {String}
+         */
+        this._layerId = DataUtils.default(options.id, 'wms_layer_' + new Date().getTime());
+
+        /**
+         * 数据源ID
+         * @type {String}
+         */
+        this._sourceId = this._layerId;
+
+        /**
+         * 图片宽度,单位px
+         * @type {Number}
+         */
+        this._imageWidth = DataUtils.default(options.imageWidth, 256);
+
+        /**
+         * 图片高度,单位px
+         * @type {Number}
+         */
+        this._imageHeight = DataUtils.default(options.imageHeight, 256);
+
+        /**
+         * 图层透明度 (0-1),0为完全透明,1为不透明
+         * @type {Number}
+         */
+        this._opacity = DataUtils.default(options.opacity, 1);
+
+        /**
+         * 图层可见性,true则显示,false则隐藏
+         * @type {Boolean}
+         */
+        this._visible = DataUtils.default(options.visible, true);
+
+        /**
+         * 最小显示比例尺,图层在视图中可见的最小比例尺
+         * @type {Number}
+         */
+        this._minScale = DataUtils.default(options.minScale, 0);
+
+        /**
+         * 最大显示比例尺,图层在视图中可见的最大比例尺
+         * @type {Number}
+         */
+        this._maxScale = DataUtils.default(options.maxScale, 0);
+
+        /**
+         * 图片中没有数据的地方是否透明,默认为true
+         * @type {Boolean}
+         */
+        this._imageTransparency = DataUtils.default(options.imageTransparency, true);
+
+        /**
+         * 图层空间裁剪范围,仅支持多多边形裁剪、多边形裁剪、矩形裁剪、圆形裁剪
+         * @type {Object|null}
+         */
+        this._clippingArea = DataUtils.default(options.clippingArea, null);
+
+        /**
+         * 是否翻转出图范围bbox参数的x、y坐标
+         * 默认为null,程序会根据已知服务发布厂商的规则计算该值
+         * @type {Boolean|null}
+         */
+        this._isReverseXY = DataUtils.default(options.isReverseXY, null);
+
+        /**
+         * 子图层参数配置
+         * 可设置子图层是否显示,若不填则显示所有子图层
+         * 若有值则只显示visible为true的子图层
+         * @type {Array}
+         */
+        this._sublayers = DataUtils.default(options.sublayers, []);
+
+        /**
+         * Token键名
+         * @type {String}
+         */
+        this._tokenKey = DataUtils.default(options.tokenKey, 'token');
+
+        /**
+         * Token值,只有当tokenValue存在时,才会绑定token
+         * @type {String}
+         */
+        this._tokenValue = DataUtils.default(options.tokenValue, '');
+
+        /**
+         * 影像的展现形式
+         * 可选 'tile'(瓦片方式平铺)、'image'(请求一张覆盖当前屏幕的图像)
+         * 默认为 'tile'
+         * @type {String}
+         */
+        this._renderMode = DataUtils.default(options.renderMode, 'tile');
+
+        /**
+         * 图层类型
+         * @type {String}
+         */
+        this._type = DataUtils.default(options.type, 'wms');
+
+        /**
+         * 图层加载状态: 'unloaded' | 'loading' | 'loaded' | 'error'
+         * @type {String}
+         */
+        this._loadStatus = 'unloaded';
+
+        /**
+         * 事件监听器集合
+         * @type {Object}
+         */
+        this._eventListeners = {};
+
+        this._isFlyTo = DataUtils.default(options.isFlyTo, true);
+    }
+
+    _buildOptions() {
+        const options = {
+            url: this._url,
+            type: this._type,
+            id: this._layerId,
+            title: this._title,
+            opacity: this._opacity,
+            visible: this._visible,
+            imageWidth: this._imageWidth,
+            imageHeight: this._imageHeight,
+            minScale: this._minScale,
+            maxScale: this._maxScale,
+            imageTransparency: this._imageTransparency,
+            clippingArea: this._clippingArea,
+            isReverseXY: this._isReverseXY,
+            sublayers: this._sublayers,
+            tokenKey: this._tokenKey,
+            tokenValue: this._tokenValue,
+            renderMode: this._renderMode
+        };
+
+        // 如果指定了坐标系,添加到选项中
+        if (this._spatialReference) {
+            options.spatialReference = this._spatialReference;
+        }
+
+        return options;
+    }
+
+    /** ==================== Core Methods ==================== */
+
+    /**
+     * 加载图层资源
+     * @description 不加载图层到地图,仅获取图层信息
+     * @returns {Promise<WMSLayer>} 返回图层实例的 Promise
+     *
+     * @example
+     * const layer = new WMSLayer({
+     *     url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WMSServer'
+     * });
+     * layer.load().then((result) => {
+     *     console.log(result); // 获取完图层信息
+     * });
+     */
+    load() {
+        return new Promise((resolve, reject) => {
+            try {
+                if (!this._layer) {
+                    const opts = this._buildOptions();
+                    this._layer = new zondy.layer.WMSLayer(opts);
+                }
+
+                // 监听图层加载完成事件
+                const handler = (result) => {
+                    // 移除事件监听器
+                    this._layer.off('layerview-created', handler);
+                    resolve(this);
+                };
+
+                this._layer.on('layerview-created', handler);
+
+                // 如果已经加载完成,直接返回
+                if (this._layer.loadStatus === 'loaded') {
+                    resolve(this);
+                }
+            } catch (error) {
+                reject(error);
+            }
+        });
+    }
+
+    /**
+     * 加载图层到地图
+     * @description 调用 zondy.layer.WMSLayer 加载图层数据,并添加到 Mapbox GL 地图中
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const layer = createLayer({
+     *     type: 'wms',
+     *     map: mapboxMap,
+     *     url: 'http://xxx/igs/rest/services/Map/WMSServer'
+     * });
+     * await layer.loadLayer();
+     */
+    loadLayer() {
+        if (this.hasLayer()) return;
+
+        const layer = new zondy.layer.WMSLayer(this._buildOptions())
+        this._layer = layer;
+        // 将图层添加到 MapGIS 地图对象
+        this.addToMapGisMap()
+        // 监听图层加载完成事件
+        layer.on('layerview-created',(result) => {
+            //视点跳转
+            this._isFlyTo && gisView.goTo({
+                layer: result.layer
+            })
+        });
+    }
+
+    addToMapGisMap() {
+        this._map.add(this._layer)
+    }
+
+    /**
+     * 显示/隐藏图层
+     * @param {Boolean} isShow - 是否显示图层(true: 显示,false: 隐藏)
+     */
+    showLayer(isShow) {
+        this._layer.visible = isShow
+    }
+
+    /**
+     * 判断图层是否已加载
+     *
+     * @returns {Boolean}
+     */
+    hasLayer() {
+        // 优先检查底层 zondy.layer.WMSLayer 的加载状态
+        if (this._layer && this._layer.isLoaded) {
+            return true;
+        }
+    }
+
+    /**
+     * 移除图层
+     */
+    removeLayer() {
+        // 移除底层 zondy.layer.WMSLayer
+        if (this._layer) {
+            this._layer.remove();
+            this._layer = null;
+        }
+
+        // 从管理器中移除
+        removeLayerFromManager(this._layer);
+    }
+
+    /**
+     * 根据子图层id查询图层
+     * @param {String|Number} sublayerID - 子图层ID
+     * @returns {Object|null} 子图层对象或null
+     */
+    findSublayerById(sublayerID) {
+        if (!this._layer) {
+            console.warn('WMS图层未加载');
+            return null;
+        }
+    
+        return this._layer.findSublayerById(sublayerID);
+    }
+    
+    /**
+     * 通过传入的json构造并返回一个新的WMSLayer对象
+     * @param {Object} json - JSON对象
+     * @returns {WMSLayer} WMSLayer实例
+     */
+    static fromJSON(json) {
+        const { WMSLayer } = zondy.layer;
+        const instance = WMSLayer.fromJSON(json);
+        return instance;
+    }
+    
+    /**
+     * 通过url创建图层的对象
+     * @param {String} url - 服务基地址
+     * @returns {WMSLayer} 新的图层对象
+     */
+    static fromServerUrl(url) {
+        const { WMSLayer } = zondy.layer;
+        const instance = WMSLayer.fromServerUrl(url);
+        return instance;
+    }
+    
+    /**
+     * 克隆WMSLayer对象
+     * @returns {WMSLayer} 克隆后的WMSLayer实例
+     */
+    clone() {
+        if (!this._layer) {
+            console.warn('WMS图层未加载,无法克隆');
+            return null;
+        }
+    
+        return this._layer.clone();
+    }
+    
+    /**
+     * 导出为json对象
+     * @returns {Object} JSON对象
+     */
+    toJSON() {
+        if (!this._layer) {
+            console.warn('WMS图层未加载');
+            return {};
+        }
+    
+        return this._layer.toJSON();
+    }
+
+    /** ==================== Getter/Setter ==================== */
+
+    /**
+     * 获取图层ID
+     * @returns {String}
+     */
+    get layerId() {
+        return this._layerId;
+    }
+
+    /**
+     * 获取服务URL
+     * @returns {String}
+     */
+    get url() {
+        return this._url;
+    }
+
+    /**
+     * 获取图层实例
+     * @returns {Object}
+     */
+    get instance() {
+        return this._layer;
+    }
+}