my-openlayer 2.0.0 → 2.0.1

package/core/Polygon.d.ts

@@ -1,139 +1,157 @@
-import Map from "ol/Map";
-import VectorLayer from "ol/layer/Vector";
-import VectorSource from "ol/source/Vector";
-import { Image as ImageLayer, Heatmap } from "ol/layer";
-import { PolygonOptions, MapJSONData, PointData, HeatMapOptions, ImageLayerData, MaskLayerOptions, FeatureColorUpdateOptions } from '../types';
-/**
- * Polygon 类用于处理地图上的面要素操作
- * 包括添加多边形、边框、图片图层、热力图等功能
- */
-export default class Polygon {
-    private map;
-    private colorMap;
-    [key: string]: any;
-    /**
-     * 构造函数
-     * @param map OpenLayers 地图实例
-     */
-    constructor(map: Map);
-    /**
-     * 获取等级颜色
-     * @param lev 等级值，支持字符串或数字
-     * @returns 对应等级的颜色值，如果等级不存在则返回默认颜色
-     */
-    getLevColor(lev: string | number): string;
-    /**
-     * 添加地图边框图层
-     * @param data 图层数据，必须是有效的 GeoJSON 格式
-     * @param options 图层配置选项
-     * @returns 创建的图层实例
-     * @throws 当数据格式无效时抛出错误
-     */
-    addBorderPolygon(data: MapJSONData, options?: PolygonOptions): VectorLayer<VectorSource>;
-    /**
-     * 添加多边形图层
-     * @param dataJSON GeoJSON 数据
-     * @param options 图层配置选项
-     * @returns 创建的矢量图层
-     * @throws 当数据格式无效时抛出错误
-     */
-    addPolygon(dataJSON: MapJSONData, options?: PolygonOptions): VectorLayer<VectorSource>;
-    /**
-     * 设置要素样式
-     * @param features 要素数组
-     * @param options 样式配置选项
-     */
-    private setFeatureStyles;
-    /**
-     * 获取要素文本
-     * @param feature 要素对象
-     * @param options 配置选项
-     * @returns 文本内容
-     */
-    private getFeatureText;
-    /**
-     * 适应图层视图
-     * @param layer 图层对象
-     */
-    private fitViewToLayer;
-    /**
-     * 根据数据数组更新某个面颜色
-     * @param layerName 图层名称
-     * @param colorObj 颜色映射对象，键为要素属性值，值为颜色字符串
-     * @param options 配置项
-     * @throws 当图层不存在时抛出错误
-     */
-    updateFeatureColor(layerName: string, colorObj?: {
-        [propName: string]: string;
-    }, options?: FeatureColorUpdateOptions): void;
-    /**
-     * 更新单个要素的颜色
-     * @param feature 要素对象
-     * @param colorObj 颜色映射对象
-     * @param options 配置选项
-     */
-    private updateSingleFeatureColor;
-    /**
-     * 设置外围蒙版图层
-     *
-     * 详细文档参考 https_blog.csdn.net/?url=https%3A%2F%2Fblog.csdn.net%2Fu012413551%2Farticle%2Fdetails%2F122739501
-     *
-     * @param data
-     * @param options
-     */
-    setOutLayer(data: MapJSONData, options?: {
-        extent?: any;
-        fillColor?: string;
-        strokeWidth?: number;
-        strokeColor?: string;
-        zIndex?: number;
-    }): void;
-    /**
-     * 添加图片图层
-     * @param imageData 图片数据，包含url和extent
-     * @param options 配置项
-     * @returns 创建的图片图层
-     * @throws 当数据格式无效时抛出错误
-     */
-    addImageLayer(imageData: ImageLayerData, options?: PolygonOptions): ImageLayer<any>;
-    /**
-     * 尝试更新现有图层
-     * @private
-     */
-    private tryUpdateExistingImageLayer;
-    /**
-     * 创建新的图像图层
-     * @private
-     */
-    private createNewImageLayer;
-    /**
-     * 更新图层属性
-     * @private
-     */
-    private updateImageLayerProperties;
-    /**
-     * 配置图层基本属性
-     * @private
-     */
-    private configureImageLayer;
-    /**
-     * 添加图层到地图并应用裁剪
-     * @private
-     */
-    private addImageLayerToMap;
-    /**
-     * 添加热力图图层
-     * @param pointData 点数据数组
-     * @param options 热力图配置
-     */
-    addHeatmap(pointData: PointData[], options?: HeatMapOptions): Heatmap;
-    /**
-     * 添加遮罩图层
-     * @param data GeoJSON格式的遮罩数据
-     * @param options 配置项
-     * @returns 创建的遮罩图层
-     * @throws 当数据格式无效时抛出错误
-     */
-    addMaskLayer(data: any, options?: MaskLayerOptions): VectorLayer<VectorSource>;
-    removePolygonLayer(layerName: string): void;
-}
+import Map from "ol/Map";
+import VectorLayer from "ol/layer/Vector";
+import VectorSource from "ol/source/Vector";
+import { Image as ImageLayer, Heatmap } from "ol/layer";
+import { Geometry } from "ol/geom";
+import Feature from "ol/Feature";
+import { PolygonOptions, MapJSONData, PointData, HeatMapOptions, ImageLayerData, MaskLayerOptions, FeatureColorUpdateOptions } from '../types';
+/**
+ * Polygon 类用于处理地图上的面要素操作
+ * 包括添加多边形、边框、图片图层、热力图等功能
+ */
+export default class Polygon {
+    private map;
+    private colorMap;
+    [key: string]: any;
+    /**
+     * 构造函数
+     * @param map OpenLayers 地图实例
+     */
+    constructor(map: Map);
+    /**
+     * 获取等级颜色
+     * @param lev 等级值，支持字符串或数字
+     * @returns 对应等级的颜色值，如果等级不存在则返回默认颜色
+     */
+    getLevColor(lev: string | number): string;
+    /**
+     * 添加地图边框图层（使用GeoJSON数据）
+     * @param data 图层数据，必须是有效的 GeoJSON 格式
+     * @param options 图层配置选项
+     * @returns 创建的图层实例
+     * @throws 当数据格式无效时抛出错误
+     */
+    addBorderPolygon(data: MapJSONData, options?: PolygonOptions): VectorLayer<VectorSource>;
+    /**
+     * 添加地图边框图层（从URL加载）
+     * @param url 数据URL
+     * @param options 图层配置选项
+     * @returns 创建的图层实例
+     * @throws 当数据格式无效时抛出错误
+     */
+    addBorderPolygon(url: string, options?: PolygonOptions): VectorLayer<VectorSource>;
+    /**
+     * 添加多边形图层（使用GeoJSON数据）
+     * @param dataJSON GeoJSON 数据
+     * @param options 图层配置选项
+     * @returns 创建的矢量图层
+     * @throws 当数据格式无效时抛出错误
+     */
+    addPolygon(dataJSON: MapJSONData, options?: PolygonOptions): VectorLayer<VectorSource>;
+    /**
+     * 添加多边形图层（从URL加载）
+     * @param url 数据URL
+     * @param options 图层配置选项
+     * @returns 创建的矢量图层
+     * @throws 当数据格式无效时抛出错误
+     */
+    addPolygon(url: string, options?: PolygonOptions): VectorLayer<VectorSource>;
+    /**
+     * 设置要素样式
+     * @param features 要素数组
+     * @param options 样式配置选项
+     */
+    private setFeatureStyles;
+    /**
+     * 获取要素文本
+     * @param feature 要素对象
+     * @param options 配置选项
+     * @returns 文本内容
+     */
+    private getFeatureText;
+    /**
+     * 适应图层视图
+     * @param layer 图层对象
+     */
+    private fitViewToLayer;
+    /**
+     * 根据数据数组更新某个面颜色
+     * @param layerName 图层名称
+     * @param colorObj 颜色映射对象，键为要素属性值，值为颜色字符串
+     * @param options 配置项
+     * @throws 当图层不存在时抛出错误
+     */
+    updateFeatureColor(layerName: string, colorObj?: {
+        [propName: string]: string;
+    }, options?: FeatureColorUpdateOptions): void;
+    /**
+     * 更新单个要素的颜色
+     * @param feature 要素对象
+     * @param colorObj 颜色映射对象
+     * @param options 配置选项
+     */
+    private updateSingleFeatureColor;
+    /**
+     * 设置外围蒙版图层
+     *
+     * 详细文档参考 https_blog.csdn.net/?url=https%3A%2F%2Fblog.csdn.net%2Fu012413551%2Farticle%2Fdetails%2F122739501
+     *
+     * @param data
+     * @param options
+     */
+    setOutLayer(data: MapJSONData, options?: {
+        extent?: any;
+        fillColor?: string;
+        strokeWidth?: number;
+        strokeColor?: string;
+        zIndex?: number;
+    }): void;
+    /**
+     * 添加图片图层
+     * @param imageData 图片数据，包含url和extent
+     * @param options 配置项
+     * @returns 创建的图片图层
+     * @throws 当数据格式无效时抛出错误
+     */
+    addImageLayer(imageData: ImageLayerData, options?: PolygonOptions): ImageLayer<any>;
+    /**
+     * 尝试更新现有图层
+     * @private
+     */
+    private tryUpdateExistingImageLayer;
+    /**
+     * 创建新的图像图层
+     * @private
+     */
+    private createNewImageLayer;
+    /**
+     * 更新图层属性
+     * @private
+     */
+    private updateImageLayerProperties;
+    /**
+     * 配置图层基本属性
+     * @private
+     */
+    private configureImageLayer;
+    /**
+     * 添加图层到地图并应用裁剪
+     * @private
+     */
+    private addImageLayerToMap;
+    /**
+     * 添加热力图图层
+     * @param pointData 点数据数组
+     * @param options 热力图配置
+     */
+    addHeatmap(pointData: PointData[], options?: HeatMapOptions): Heatmap<Feature<Geometry>, VectorSource<Feature<Geometry>>>;
+    /**
+     * 添加遮罩图层
+     * @param data GeoJSON格式的遮罩数据
+     * @param options 配置项
+     * @returns 创建的遮罩图层
+     * @throws 当数据格式无效时抛出错误
+     */
+    addMaskLayer(data: any, options?: MaskLayerOptions): VectorLayer<VectorSource>;
+    removePolygonLayer(layerName: string): void;
+}