qm-map-maplibre-gl 0.0.1 → 0.0.3

package/dist/context/mapContext.d.ts

@@ -1,6 +1,19 @@
 import { default as MapWrapper } from '../maplibregl/MapWrapper';
+/**
+ * 地图上下文类型定义
+ * @property map - 地图包装器实例
+ */
 export interface TMapContext {
     map: MapWrapper | null;
 }
+/**
+ * 地图上下文
+ * 用于在组件树中共享地图实例
+ */
 export declare const MapContext: import('react').Context<TMapContext>;
+/**
+ * 使用地图上下文的 Hook
+ * @returns 返回地图上下文对象
+ * @throws 如果在非函数组件中使用会抛出错误
+ */
 export declare const useMap: () => TMapContext;

package/dist/maplibregl/MapWrapper.d.ts

@@ -34,11 +34,40 @@ declare class MapWrapper extends Map {
     private _layers;
     get layers(): (LayerWrapper | LayerGroupWrapper)[];
     constructor(options: TMapOptions);
+    /**
+     * 根据ID递归查找图层或图层组
+     * @param layers - 图层数组
+     * @param id - 要查找的图层ID
+     * @returns 找到的图层或图层组，未找到返回 undefined
+     */
     getLayerWrapper(layers: Array<LayerWrapper | LayerGroupWrapper>, id: string): LayerWrapper | LayerGroupWrapper | undefined;
+    /**
+     * 添加图层包装器到地图
+     * @param layer - 图层或图层组包装器
+     * @param beforeId - 可选的图层ID，用于指定插入位置
+     */
     addLayerWrapper(layer: LayerWrapper | LayerGroupWrapper, beforeId?: string): void;
+    /**
+     * 从地图移除图层包装器
+     * @param layer - 图层或图层组包装器
+     * @param removeSource - 是否同时移除数据源
+     */
     removeLayerWrapper(layer: LayerWrapper | LayerGroupWrapper, removeSource?: boolean): void;
+    /**
+     * 加载图层配置
+     * 根据配置创建图层或图层组并添加到地图
+     * @param mapLayerSettting - 图层配置数组
+     */
     load(mapLayerSettting: TMapLayerSettting): void;
+    /**
+     * 高亮选中要素
+     * 在地图上显示选中的 GeoJSON 要素
+     * @param geo - GeoJSON 要素或要素集合
+     */
     selectFeature(geo: GeoJSON.Feature<GeoJSON.Geometry> | GeoJSON.FeatureCollection<GeoJSON.Geometry> | string): void;
+    /**
+     * 清除选中要素的高亮显示
+     */
     clearSelect(): void;
     /**
      * 查找有效beforeId

package/dist/maplibregl/layer/BaseLayer.d.ts

@@ -1,11 +1,31 @@
 import { default as MapWrapper } from '../MapWrapper';
 import { TLayerOptions } from '../typings/TLayerOptions';
+/**
+ * 图层基类
+ * 所有图层类型的抽象基类，定义了图层的通用行为和接口
+ */
 declare abstract class BaseLayer {
     protected _options: TLayerOptions;
     get options(): TLayerOptions;
     constructor(options: TLayerOptions);
+    /**
+     * 抽象方法：添加图层到地图
+     * @param map - 地图包装器实例
+     * @param beforeId - 可选的图层ID，用于指定图层插入位置
+     */
     protected abstract add(map: MapWrapper, beforeId?: string): void;
+    /**
+     * 添加图层到地图的公共方法
+     * 处理图层状态检查和插入位置查找
+     * @param map - 地图包装器实例
+     * @param beforeId - 可选的图层ID
+     */
     onAdd(map: MapWrapper, beforeId?: string): void;
+    /**
+     * 从地图移除图层
+     * @param map - 地图包装器实例
+     * @param removeSource - 是否同时移除数据源
+     */
     onRemove(map: MapWrapper, removeSource?: boolean): void;
 }
 export default BaseLayer;

package/dist/maplibregl/layer/LayerGroupWrapper.d.ts

@@ -2,17 +2,37 @@ import { default as MapWrapper } from '../MapWrapper';
 import { TLayerGroupOptions } from '../typings/TLayerOptions';
 import { default as LayerWrapper } from './LayerWrapper';
 /**
- * 图层组
- * @description 多个图层作为一个对象控制
+ * 图层组包装类
+ * 用于将多个图层作为一个整体进行控制
+ * 支持嵌套的图层组结构
  */
 declare class LayerGroupWrapper {
     private _options;
     get options(): TLayerGroupOptions;
     private _layers;
     get layers(): (LayerWrapper | LayerGroupWrapper)[];
+    /**
+     * 创建图层组实例
+     * @param options - 图层组配置选项
+     */
     constructor(options: TLayerGroupOptions);
+    /**
+     * 将图层组添加到地图
+     * 递归添加所有子图层
+     * @param map - 地图包装器实例
+     * @param beforeId - 可选的图层ID，用于指定插入位置
+     */
     onAdd(map: MapWrapper, beforeId?: string): void;
+    /**
+     * 从地图移除图层组
+     * 递归移除所有子图层
+     * @param map - 地图包装器实例
+     */
     onRemove(map: MapWrapper): void;
+    /**
+     * 更新图层组的状态
+     * 根据子图层的添加状态更新组的 isAdd 属性
+     */
     private updateOptions;
 }
 export default LayerGroupWrapper;

package/dist/maplibregl/layer/LayerWrapper.d.ts

@@ -2,11 +2,18 @@ import { default as MapWrapper } from '../MapWrapper';
 import { TLayerOptions } from '../typings/TLayerOptions';
 import { default as BaseLayer } from './BaseLayer';
 /**
- * 图层扩展
- * @description extend BaseLayer
+ * 图层包装类
+ * 继承自 BaseLayer，负责单个图层的添加和管理
+ * 处理数据源的创建和图层添加到地图的逻辑
  */
 declare class LayerWrapper extends BaseLayer {
     constructor(options: TLayerOptions);
+    /**
+     * 添加图层到地图
+     * 如果数据源不存在则创建，然后将图层添加到地图
+     * @param map - 地图包装器实例
+     * @param beforeId - 可选的图层ID，用于指定图层插入位置
+     */
     protected add(map: MapWrapper, beforeId?: string): void;
 }
 export default LayerWrapper;