my-openlayer 2.0.0 → 2.1.0

package/core/Line.d.ts

@@ -1,109 +1,130 @@
-import Map from "ol/Map";
-import VectorSource from "ol/source/Vector";
-import VectorLayer from "ol/layer/Vector";
-import { LineOptions, MapJSONData } from "../types";
-/**
- * 河流级别宽度映射配置
- */
-interface RiverLevelWidthMap {
-    [level: number]: number;
-}
-/**
- * 河流图层配置选项
- */
-interface RiverLayerOptions extends LineOptions {
-    /** 河流级别数量，默认为5 */
-    levelCount?: number;
-    /** 缩放级别偏移量，默认为8 */
-    zoomOffset?: number;
-    /** 河流级别宽度映射 */
-    levelWidthMap?: RiverLevelWidthMap;
-    /** 是否删除同名图层 */
-    removeExisting?: boolean;
-}
-/**
- * 线要素管理类
- * 用于在地图上添加和管理线要素，包括普通线要素、河流图层等
- *
- * @example
- * ```typescript
- * const lineManager = new Line(map);
- * const layer = lineManager.addLine(geoJsonData, {
- *   type: 'road',
- *   strokeColor: '#ff0000',
- *   strokeWidth: 3
- * });
- * ```
- */
-export default class Line {
-    /** OpenLayers 地图实例 */
-    private readonly map;
-    /** 事件管理器实例 */
-    private readonly eventManager;
-    /** 河流图层列表 */
-    private riverLayerList;
-    /** 河流图层显示状态 */
-    private riverLayerShow;
-    /** 默认河流级别宽度映射 */
-    private readonly defaultLevelWidthMap;
-    /**
-     * 构造函数
-     * @param map OpenLayers地图实例
-     */
-    constructor(map: Map);
-    /**
-     * 添加线要素
-     * @param data GeoJSON格式的线数据
-     * @param options 配置项
-     * @returns 创建的矢量图层
-     */
-    addLine(data: MapJSONData, options?: LineOptions): VectorLayer<VectorSource>;
-    /**
-     * 添加分级河流图层，根据缩放级别显示不同级别的河流
-     * @param fyRiverJson 河流 GeoJSON 数据
-     * @param options 河流图层配置选项
-     * @throws {Error} 当数据格式无效时抛出错误
-     */
-    addRiverLayersByZoom(fyRiverJson: MapJSONData, options?: RiverLayerOptions): void;
-    /**
-     * 显示或隐藏河流图层
-     * @param show 是否显示河流图层
-     */
-    showRiverLayer(show: boolean): void;
-    /**
-     * 根据缩放级别显示对应的河流图层
-     * 缩放级别越高，显示的河流级别越详细
-     */
-    showRiverLayerByZoom(): void;
-    /**
-     * 添加按级别显示不同宽度的河流图层
-     * @param data 河流 GeoJSON 数据
-     * @param options 河流图层配置选项
-     * @returns 创建的河流图层
-     */
-    addRiverWidthByLevel(data: MapJSONData, options?: RiverLayerOptions): VectorLayer<VectorSource>;
-    /**
-     * 移除线图层
-     * @param layerName 图层名称
-     */
-    removeLineLayer(layerName: string): void;
-    /**
-     * 清除所有河流图层
-     */
-    clearRiverLayers(): void;
-    /**
-     * 获取河流图层显示状态
-     * @returns 河流图层是否显示
-     */
-    getRiverLayerVisibility(): boolean;
-    /**
-     * 获取河流图层列表
-     * @returns 河流图层数组的副本
-     */
-    getRiverLayers(): VectorLayer<VectorSource>[];
-    /**
-     * 销毁线管理器，清理所有资源
-     */
-    destroy(): void;
-}
-export {};
+import Map from "ol/Map";
+import VectorSource from "ol/source/Vector";
+import VectorLayer from "ol/layer/Vector";
+import { LineOptions, MapJSONData } from "../types";
+/**
+ * 河流级别宽度映射配置
+ */
+interface RiverLevelWidthMap {
+    [level: number]: number;
+}
+/**
+ * 河流图层配置选项
+ */
+interface RiverLayerOptions extends LineOptions {
+    /** 河流级别数量，默认为5 */
+    levelCount?: number;
+    /** 缩放级别偏移量，默认为8 */
+    zoomOffset?: number;
+    /** 河流级别宽度映射 */
+    levelWidthMap?: RiverLevelWidthMap;
+    /** 是否删除同名图层 */
+    removeExisting?: boolean;
+}
+/**
+ * 线要素管理类
+ * 用于在地图上添加和管理线要素，包括普通线要素、河流图层等
+ *
+ * @example
+ * ```typescript
+ * const lineManager = new Line(map);
+ * const layer = lineManager.addLine(geoJsonData, {
+ *   type: 'road',
+ *   strokeColor: '#ff0000',
+ *   strokeWidth: 3
+ * });
+ * ```
+ */
+export default class Line {
+    /** OpenLayers 地图实例 */
+    private readonly map;
+    /** 事件管理器实例 */
+    private readonly eventManager;
+    /** 河流图层列表 */
+    private riverLayerList;
+    /** 河流图层显示状态 */
+    private riverLayerShow;
+    /** 默认河流级别宽度映射 */
+    private readonly defaultLevelWidthMap;
+    /**
+     * 构造函数
+     * @param map OpenLayers地图实例
+     */
+    constructor(map: Map);
+    /**
+     * 添加线要素
+     * @param data GeoJSON格式的线数据
+     * @param options 配置项
+     * @returns 创建的矢量图层
+     */
+    addLine(data: MapJSONData, options?: LineOptions): VectorLayer<VectorSource>;
+    /**
+     * 从URL添加线要素
+     * @param url 数据URL
+     * @param options 配置项
+     * @returns 创建的矢量图层
+     */
+    addLineByUrl(url: string, options?: LineOptions): VectorLayer<VectorSource>;
+    /**
+     * 添加分级河流图层，根据缩放级别显示不同级别的河流
+     * @param fyRiverJson 河流 GeoJSON 数据
+     * @param options 河流图层配置选项
+     * @throws {Error} 当数据格式无效时抛出错误
+     */
+    addRiverLayersByZoom(fyRiverJson: MapJSONData, options?: RiverLayerOptions): void;
+    /**
+     * 从URL添加分级河流图层，根据缩放级别显示不同级别的河流
+     * @param url 河流数据URL
+     * @param options 河流图层配置选项
+     * @throws {Error} 当数据格式无效时抛出错误
+     */
+    addRiverLayersByZoomByUrl(url: string, options?: RiverLayerOptions): void;
+    /**
+     * 显示或隐藏河流图层
+     * @param show 是否显示河流图层
+     */
+    showRiverLayer(show: boolean): void;
+    /**
+     * 根据缩放级别显示对应的河流图层
+     * 缩放级别越高，显示的河流级别越详细
+     */
+    showRiverLayerByZoom(): void;
+    /**
+     * 添加按级别显示不同宽度的河流图层
+     * @param data 河流 GeoJSON 数据
+     * @param options 河流图层配置选项
+     * @returns 创建的河流图层
+     */
+    addRiverWidthByLevel(data: MapJSONData, options?: RiverLayerOptions): VectorLayer<VectorSource>;
+    /**
+     * 从URL添加按级别显示不同宽度的河流图层
+     * @param url 河流数据URL
+     * @param options 河流图层配置选项
+     * @returns 创建的河流图层
+     */
+    addRiverWidthByLevelByUrl(url: string, options?: RiverLayerOptions): VectorLayer<VectorSource>;
+    /**
+     * 移除线图层
+     * @param layerName 图层名称
+     */
+    removeLineLayer(layerName: string): void;
+    /**
+     * 清除所有河流图层
+     */
+    clearRiverLayers(): void;
+    /**
+     * 获取河流图层显示状态
+     * @returns 河流图层是否显示
+     */
+    getRiverLayerVisibility(): boolean;
+    /**
+     * 获取河流图层列表
+     * @returns 河流图层数组的副本
+     */
+    getRiverLayers(): VectorLayer<VectorSource>[];
+    /**
+     * 销毁线管理器，清理所有资源
+     */
+    destroy(): void;
+}
+export {};