@summeruse/ol 0.5.1 → 0.6.1

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @summeruse/ol
 
+## 0.6.1
+
+### Patch Changes
+
+- 8b4a43e: fix(utils/layer): 允许刷新函数返回布尔值以控制画布清除
+
+## 0.6.0
+
+### Minor Changes
+
+- 6a8ca7e: feat(composables): 新增 useMapClick 组合式函数处理地图点击事件
+
+### Patch Changes
+
+- d727683: feat(usePointermove): 支持 hitTolerance 并按容差分组优化检测性能
+
 ## 0.5.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -18,15 +18,16 @@ import { Extent } from "ol/extent";
 import * as ol_coordinate0 from "ol/coordinate";
 import { Coordinate } from "ol/coordinate";
 import { ObjectEvent } from "ol/Object";
-import * as ol_Feature0 from "ol/Feature";
+import * as ol_Feature5 from "ol/Feature";
 import { FeatureLike } from "ol/Feature";
-import * as ol_events0 from "ol/events";
-import * as ol_style_Style0 from "ol/style/Style";
-import * as ol_events_Event0 from "ol/events/Event";
+import * as ol_events13 from "ol/events";
+import * as ol_style_Style5 from "ol/style/Style";
+import * as ol_events_Event1 from "ol/events/Event";
 import * as ol_renderer_Layer0 from "ol/renderer/Layer";
 import { FrameState } from "ol/Map";
 import { FlatStyleLike } from "ol/style/flat";
 import proj4 from "proj4";
+import { Pixel } from "ol/pixel";
 import TileLayer from "ol/layer/Tile";
 
 //#region constants/distance.d.ts
@@ -107,9 +108,9 @@ declare const __VLS_component: vue20.DefineComponent<OlMapProps, {
   onMoveend?: ((args_0: MapEvent) => any) | undefined;
   onMovestart?: ((args_0: MapEvent) => any) | undefined;
 }>, {
-  rotation: number;
   maxZoom: number;
   minZoom: number;
+  rotation: number;
   olMap: Map;
   center: ol_coordinate0.Coordinate;
   zoom: number;
@@ -137,6 +138,9 @@ type OlMapInst = InstanceType<typeof _default>;
 //#region types/index.d.ts
 type ForEachFeatureAtPixelCallbackOptions = Parameters<Parameters<OLMap['forEachFeatureAtPixel']>[1]>;
 type LayerLike = ForEachFeatureAtPixelCallbackOptions[1];
+interface Option {
+  [key: string]: any;
+}
 //#endregion
 //#region composables/useContextmenu/index.d.ts
 interface ContextmenuPosition {
@@ -344,7 +348,7 @@ type CanvasLayerOptions = ConstructorParameters<typeof Layer>[0];
 declare function createCanvasLayer(olMap: OLMap, refresh: (frameState: FrameState) => {
   imageBitmap: ImageBitmap;
   dpi: number;
-} | undefined, options?: CanvasLayerOptions): {
+} | boolean | undefined, options?: CanvasLayerOptions): {
   layer: Layer<Source, ol_renderer_Layer0.default<any>>;
   source: Source;
 };
@@ -391,17 +395,17 @@ declare function useDrawLineString(olMap: OLMap, options: DrawLineStringOptions)
   setFeatures: (coordinates: Coordinate[][]) => void;
   reset: () => void;
   features: vue20.Ref<{
-    on: ol_Feature0.FeatureOnSignature<ol_events0.EventsKey>;
-    once: ol_Feature0.FeatureOnSignature<ol_events0.EventsKey>;
-    un: ol_Feature0.FeatureOnSignature<void>;
+    on: ol_Feature5.FeatureOnSignature<ol_events13.EventsKey>;
+    once: ol_Feature5.FeatureOnSignature<ol_events13.EventsKey>;
+    un: ol_Feature5.FeatureOnSignature<void>;
     clone: () => Feature<LineString>;
     getGeometry: () => LineString | undefined;
     getId: () => number | string | undefined;
     getGeometryName: () => string;
-    getStyle: () => ol_style_Style0.StyleLike | undefined;
-    getStyleFunction: () => ol_style_Style0.StyleFunction | undefined;
+    getStyle: () => ol_style_Style5.StyleLike | undefined;
+    getStyleFunction: () => ol_style_Style5.StyleFunction | undefined;
     setGeometry: (geometry: LineString | undefined) => void;
-    setStyle: (style?: ol_style_Style0.StyleLike) => void;
+    setStyle: (style?: ol_style_Style5.StyleLike) => void;
     setId: (id: number | string | undefined) => void;
     setGeometryName: (name: string) => void;
     get: (key: string) => any;
@@ -414,8 +418,8 @@ declare function useDrawLineString(olMap: OLMap, options: DrawLineStringOptions)
     } | null;
     hasProperties: () => boolean;
     notify: (key: string, oldValue: any) => void;
-    addChangeListener: (key: string, listener: ol_events0.Listener) => void;
-    removeChangeListener: (key: string, listener: ol_events0.Listener) => void;
+    addChangeListener: (key: string, listener: ol_events13.Listener) => void;
+    removeChangeListener: (key: string, listener: ol_events13.Listener) => void;
     set: (key: string, value: any, silent?: boolean) => void;
     setProperties: (values: {
       [x: string]: any;
@@ -423,24 +427,24 @@ declare function useDrawLineString(olMap: OLMap, options: DrawLineStringOptions)
     unset: (key: string, silent?: boolean) => void;
     changed: () => void;
     getRevision: () => number;
-    addEventListener: (type: string, listener: ol_events0.Listener) => void;
-    dispatchEvent: (event: ol_events_Event0.default | string) => boolean | undefined;
-    getListeners: (type: string) => Array<ol_events0.Listener> | undefined;
+    addEventListener: (type: string, listener: ol_events13.Listener) => void;
+    dispatchEvent: (event: ol_events_Event1.default | string) => boolean | undefined;
+    getListeners: (type: string) => Array<ol_events13.Listener> | undefined;
     hasListener: (type?: string) => boolean;
-    removeEventListener: (type: string, listener: ol_events0.Listener) => void;
+    removeEventListener: (type: string, listener: ol_events13.Listener) => void;
     dispose: () => void;
   }[], Feature<LineString>[] | {
-    on: ol_Feature0.FeatureOnSignature<ol_events0.EventsKey>;
-    once: ol_Feature0.FeatureOnSignature<ol_events0.EventsKey>;
-    un: ol_Feature0.FeatureOnSignature<void>;
+    on: ol_Feature5.FeatureOnSignature<ol_events13.EventsKey>;
+    once: ol_Feature5.FeatureOnSignature<ol_events13.EventsKey>;
+    un: ol_Feature5.FeatureOnSignature<void>;
     clone: () => Feature<LineString>;
     getGeometry: () => LineString | undefined;
     getId: () => number | string | undefined;
     getGeometryName: () => string;
-    getStyle: () => ol_style_Style0.StyleLike | undefined;
-    getStyleFunction: () => ol_style_Style0.StyleFunction | undefined;
+    getStyle: () => ol_style_Style5.StyleLike | undefined;
+    getStyleFunction: () => ol_style_Style5.StyleFunction | undefined;
     setGeometry: (geometry: LineString | undefined) => void;
-    setStyle: (style?: ol_style_Style0.StyleLike) => void;
+    setStyle: (style?: ol_style_Style5.StyleLike) => void;
     setId: (id: number | string | undefined) => void;
     setGeometryName: (name: string) => void;
     get: (key: string) => any;
@@ -453,8 +457,8 @@ declare function useDrawLineString(olMap: OLMap, options: DrawLineStringOptions)
     } | null;
     hasProperties: () => boolean;
     notify: (key: string, oldValue: any) => void;
-    addChangeListener: (key: string, listener: ol_events0.Listener) => void;
-    removeChangeListener: (key: string, listener: ol_events0.Listener) => void;
+    addChangeListener: (key: string, listener: ol_events13.Listener) => void;
+    removeChangeListener: (key: string, listener: ol_events13.Listener) => void;
     set: (key: string, value: any, silent?: boolean) => void;
     setProperties: (values: {
       [x: string]: any;
@@ -462,11 +466,11 @@ declare function useDrawLineString(olMap: OLMap, options: DrawLineStringOptions)
     unset: (key: string, silent?: boolean) => void;
     changed: () => void;
     getRevision: () => number;
-    addEventListener: (type: string, listener: ol_events0.Listener) => void;
-    dispatchEvent: (event: ol_events_Event0.default | string) => boolean | undefined;
-    getListeners: (type: string) => Array<ol_events0.Listener> | undefined;
+    addEventListener: (type: string, listener: ol_events13.Listener) => void;
+    dispatchEvent: (event: ol_events_Event1.default | string) => boolean | undefined;
+    getListeners: (type: string) => Array<ol_events13.Listener> | undefined;
     hasListener: (type?: string) => boolean;
-    removeEventListener: (type: string, listener: ol_events0.Listener) => void;
+    removeEventListener: (type: string, listener: ol_events13.Listener) => void;
     dispose: () => void;
   }[]>;
   coordinates: vue20.ComputedRef<Coordinate[][]>;
@@ -495,17 +499,17 @@ declare function useDrawPolygon(olMap: OLMap, options: DrawPolygonOptions): {
   setFeatures: (coordinates?: Coordinate[][][]) => void;
   reset: () => void;
   features: vue20.Ref<{
-    on: ol_Feature0.FeatureOnSignature<ol_events0.EventsKey>;
-    once: ol_Feature0.FeatureOnSignature<ol_events0.EventsKey>;
-    un: ol_Feature0.FeatureOnSignature<void>;
+    on: ol_Feature5.FeatureOnSignature<ol_events13.EventsKey>;
+    once: ol_Feature5.FeatureOnSignature<ol_events13.EventsKey>;
+    un: ol_Feature5.FeatureOnSignature<void>;
     clone: () => Feature<Polygon>;
     getGeometry: () => Polygon | undefined;
     getId: () => number | string | undefined;
     getGeometryName: () => string;
-    getStyle: () => ol_style_Style0.StyleLike | undefined;
-    getStyleFunction: () => ol_style_Style0.StyleFunction | undefined;
+    getStyle: () => ol_style_Style5.StyleLike | undefined;
+    getStyleFunction: () => ol_style_Style5.StyleFunction | undefined;
     setGeometry: (geometry: Polygon | undefined) => void;
-    setStyle: (style?: ol_style_Style0.StyleLike) => void;
+    setStyle: (style?: ol_style_Style5.StyleLike) => void;
     setId: (id: number | string | undefined) => void;
     setGeometryName: (name: string) => void;
     get: (key: string) => any;
@@ -518,8 +522,8 @@ declare function useDrawPolygon(olMap: OLMap, options: DrawPolygonOptions): {
     } | null;
     hasProperties: () => boolean;
     notify: (key: string, oldValue: any) => void;
-    addChangeListener: (key: string, listener: ol_events0.Listener) => void;
-    removeChangeListener: (key: string, listener: ol_events0.Listener) => void;
+    addChangeListener: (key: string, listener: ol_events13.Listener) => void;
+    removeChangeListener: (key: string, listener: ol_events13.Listener) => void;
     set: (key: string, value: any, silent?: boolean) => void;
     setProperties: (values: {
       [x: string]: any;
@@ -527,24 +531,24 @@ declare function useDrawPolygon(olMap: OLMap, options: DrawPolygonOptions): {
     unset: (key: string, silent?: boolean) => void;
     changed: () => void;
     getRevision: () => number;
-    addEventListener: (type: string, listener: ol_events0.Listener) => void;
-    dispatchEvent: (event: ol_events_Event0.default | string) => boolean | undefined;
-    getListeners: (type: string) => Array<ol_events0.Listener> | undefined;
+    addEventListener: (type: string, listener: ol_events13.Listener) => void;
+    dispatchEvent: (event: ol_events_Event1.default | string) => boolean | undefined;
+    getListeners: (type: string) => Array<ol_events13.Listener> | undefined;
     hasListener: (type?: string) => boolean;
-    removeEventListener: (type: string, listener: ol_events0.Listener) => void;
+    removeEventListener: (type: string, listener: ol_events13.Listener) => void;
     dispose: () => void;
   }[], Feature<Polygon>[] | {
-    on: ol_Feature0.FeatureOnSignature<ol_events0.EventsKey>;
-    once: ol_Feature0.FeatureOnSignature<ol_events0.EventsKey>;
-    un: ol_Feature0.FeatureOnSignature<void>;
+    on: ol_Feature5.FeatureOnSignature<ol_events13.EventsKey>;
+    once: ol_Feature5.FeatureOnSignature<ol_events13.EventsKey>;
+    un: ol_Feature5.FeatureOnSignature<void>;
     clone: () => Feature<Polygon>;
     getGeometry: () => Polygon | undefined;
     getId: () => number | string | undefined;
     getGeometryName: () => string;
-    getStyle: () => ol_style_Style0.StyleLike | undefined;
-    getStyleFunction: () => ol_style_Style0.StyleFunction | undefined;
+    getStyle: () => ol_style_Style5.StyleLike | undefined;
+    getStyleFunction: () => ol_style_Style5.StyleFunction | undefined;
     setGeometry: (geometry: Polygon | undefined) => void;
-    setStyle: (style?: ol_style_Style0.StyleLike) => void;
+    setStyle: (style?: ol_style_Style5.StyleLike) => void;
     setId: (id: number | string | undefined) => void;
     setGeometryName: (name: string) => void;
     get: (key: string) => any;
@@ -557,8 +561,8 @@ declare function useDrawPolygon(olMap: OLMap, options: DrawPolygonOptions): {
     } | null;
     hasProperties: () => boolean;
     notify: (key: string, oldValue: any) => void;
-    addChangeListener: (key: string, listener: ol_events0.Listener) => void;
-    removeChangeListener: (key: string, listener: ol_events0.Listener) => void;
+    addChangeListener: (key: string, listener: ol_events13.Listener) => void;
+    removeChangeListener: (key: string, listener: ol_events13.Listener) => void;
     set: (key: string, value: any, silent?: boolean) => void;
     setProperties: (values: {
       [x: string]: any;
@@ -566,11 +570,11 @@ declare function useDrawPolygon(olMap: OLMap, options: DrawPolygonOptions): {
     unset: (key: string, silent?: boolean) => void;
     changed: () => void;
     getRevision: () => number;
-    addEventListener: (type: string, listener: ol_events0.Listener) => void;
-    dispatchEvent: (event: ol_events_Event0.default | string) => boolean | undefined;
-    getListeners: (type: string) => Array<ol_events0.Listener> | undefined;
+    addEventListener: (type: string, listener: ol_events13.Listener) => void;
+    dispatchEvent: (event: ol_events_Event1.default | string) => boolean | undefined;
+    getListeners: (type: string) => Array<ol_events13.Listener> | undefined;
     hasListener: (type?: string) => boolean;
-    removeEventListener: (type: string, listener: ol_events0.Listener) => void;
+    removeEventListener: (type: string, listener: ol_events13.Listener) => void;
     dispose: () => void;
   }[]>;
   coordinates: vue20.ComputedRef<Coordinate[][][]>;
@@ -595,6 +599,52 @@ declare function useGraticule(options: UseGraticuleOptions): {
 };
 type UseGraticuleReturn = ReturnType<typeof useGraticule>;
 //#endregion
+//#region composables/useMapClick/index.d.ts
+/** 点击事件类型 */
+type ClickEventType = 'click' | 'dblclick' | 'singleclick';
+/**
+ * 点击事件处理的上下文参数
+ */
+interface ClickContext {
+  map: OLMap;
+  coordinate: Coordinate;
+  pixel: Pixel;
+  feature?: FeatureLike;
+  layer: LayerLike;
+}
+/**
+ * 点击配置
+ */
+type ClickConfig<T extends Option> = {
+  /** Hit-detection 容差（css像素） */
+  hitTolerance?: number;
+  /** 优先级，数字越大越优先 */
+  priority?: number;
+  /** 是否处理这个点击 */
+  visible?: (context: ClickContext) => boolean | undefined | void;
+  /** 点击回调 */
+  handler: (context: ClickContext) => void;
+} & T;
+type ClickConfigList<T extends Option> = ClickConfig<T>[];
+interface UseClickHandlerOptions<T extends Option = Option> {
+  /** 地图实例 */
+  mapRef: MaybeRefOrGetter<OLMap | undefined>;
+  /** 提示配置列表 */
+  items: MaybeRefOrGetter<ClickConfigList<T>>;
+  /** 事件类型 */
+  type: ClickEventType;
+}
+/**
+ * 通用的点击处理 Hook
+ */
+declare function useMapClickHandler<T extends Option = Option>(options: UseClickHandlerOptions<T>): void;
+type UseMapClickHandlerReturn = ReturnType<typeof useMapClickHandler>;
+declare function useMapClick<T extends Option = Option>(mapRef: MaybeRefOrGetter<OLMap | undefined>, type: ClickEventType): {
+  add: (key: string, items: ClickConfigList<T>) => void;
+  remove: (key: string) => void;
+};
+type UseMapClickReturn = ReturnType<typeof useMapClick>;
+//#endregion
 //#region composables/usePointermove/index.d.ts
 interface PointermovePosition {
   x: number;
@@ -605,7 +655,7 @@ interface PointermoveContentParams {
   coordinate: Coordinate;
   position: PointermovePosition;
   feature: FeatureLike;
-  layer?: LayerLike;
+  layer: LayerLike;
 }
 type Cursor = CSSProperties['cursor'];
 type PointermoveItem<T extends Option = Option> = {
@@ -624,11 +674,10 @@ type PointermoveItem<T extends Option = Option> = {
   cursor?: Cursor | ((params: PointermoveContentParams) => Cursor);
   /** 固定在feature center 默认启用，若要关闭需要同时开启强制更新 */
   fixedFeatureCenter?: boolean;
+  /** Hit-detection 容差（css像素），用于扩大检测范围 */
+  hitTolerance?: number;
 } & T;
 type PointermoveList<T extends Option = Option> = PointermoveItem<T>[];
-interface Option {
-  [key: string]: any;
-}
 interface UsePointermoveOptions<T extends Option = Option> {
   /** 地图实例 */
   mapRef: MaybeRefOrGetter<OLMap | undefined>;
@@ -677,4 +726,4 @@ declare function useSwitchBaseLayer(data: {
   visibleLayerName: vue20.Ref<string, string>;
 };
 //#endregion
-export { BingMapsSourceOptions, CanvasLayerOptions, CircleOptions, ContextmenuItem, ContextmenuItemBase, ContextmenuList, ContextmenuOption, ContextmenuOptionBase, ContextmenuOptions, ContextmenuPosition, CreateBingLayerOptions, CreateOpenStreetMapLayerOptions, CreateTianDiTuLayerOptions, CreateTianDiTuUrlOptions, DrawLineStringOptions, DrawPolygonOptions, EPSG_3395, EPSG_3857, EPSG_3857ExtentToEPSG_4326, EPSG_3857ToEPSG_4326, EPSG_4326, EPSG_4326ExtentToEPSG_3857, EPSG_4326ToEPSG_3857, FeatureOptions, FillOptions, GraticuleOptions, HeatmapLayerOptions, IconOptions, ImageTileSourceOptions, ONE_NM, _default as OlMap, OlMapEmits, OlMapInst, OlMapProps, OpenStreetMapSourceOptions, Option, PMTilesLayerOptions, PointermoveItem, PointermoveList, PointermovePosition, ProjectionLike, StrokeOptions, StyleOptions, T_MAP_TYPE, TextOptions, TileLayerOptions, UseContextmenuFn, UseContextmenuParams, UseContextmenuReturn, UseGraticuleOptions, UseGraticuleReturn, UsePointermoveFn, UsePointermoveOptions, UsePointermoveParams, UsePointermoveReturn, VectorLayerOptions, VectorSourceOptions, WebGLVectorLayerOptions, XYZLayerOptions, XYZ_SourceOptions, _CircleOptions, _GraticuleOptions, _StyleOptions, _TextOptions, _VectorLayerOptions, _VectorSourceOptions, _WebGLVectorLayerOptions, angleToRotation, createBingLayer, createCanvasLayer, createCircle, createCircleFeature, createCircleStyle, createFeature, createHeatmapLayer, createHeatmapLayerOptions, createLineString, createLineStringFeature, createMultiLineString, createMultiLineStringFeature, createMultiPoint, createMultiPointFeature, createMultiPolygon, createMultiPolygonFeature, createOpenStreetMapLayer, createPMTilesLayer, createPoint, createPointFeature, createPolygon, createPolygonFeature, createStyle, createTextStyle, createTianDiTuLayer, createTianDiTuUrl, createTileGrid, createVectorLayer, createVectorSource, createWebGLVectorLayer, createXYZLayer, formatAngle, formatRotation, kmToNauticalMiles, nauticalMilesToKm, olMapInjectionKey, proj4, registerEPSG_3395, rotationToAngle, useContextmenu, useDrawLineString, useDrawPolygon, useGraticule, useOlMap, usePointermove, useSwitchBaseLayer };
+export { BingMapsSourceOptions, CanvasLayerOptions, CircleOptions, ClickConfig, ClickConfigList, ClickContext, ClickEventType, ContextmenuItem, ContextmenuItemBase, ContextmenuList, ContextmenuOption, ContextmenuOptionBase, ContextmenuOptions, ContextmenuPosition, CreateBingLayerOptions, CreateOpenStreetMapLayerOptions, CreateTianDiTuLayerOptions, CreateTianDiTuUrlOptions, DrawLineStringOptions, DrawPolygonOptions, EPSG_3395, EPSG_3857, EPSG_3857ExtentToEPSG_4326, EPSG_3857ToEPSG_4326, EPSG_4326, EPSG_4326ExtentToEPSG_3857, EPSG_4326ToEPSG_3857, FeatureOptions, FillOptions, GraticuleOptions, HeatmapLayerOptions, IconOptions, ImageTileSourceOptions, ONE_NM, _default as OlMap, OlMapEmits, OlMapInst, OlMapProps, OpenStreetMapSourceOptions, PMTilesLayerOptions, PointermoveItem, PointermoveList, PointermovePosition, ProjectionLike, StrokeOptions, StyleOptions, T_MAP_TYPE, TextOptions, TileLayerOptions, UseClickHandlerOptions, UseContextmenuFn, UseContextmenuParams, UseContextmenuReturn, UseGraticuleOptions, UseGraticuleReturn, UseMapClickHandlerReturn, UseMapClickReturn, UsePointermoveFn, UsePointermoveOptions, UsePointermoveParams, UsePointermoveReturn, VectorLayerOptions, VectorSourceOptions, WebGLVectorLayerOptions, XYZLayerOptions, XYZ_SourceOptions, _CircleOptions, _GraticuleOptions, _StyleOptions, _TextOptions, _VectorLayerOptions, _VectorSourceOptions, _WebGLVectorLayerOptions, angleToRotation, createBingLayer, createCanvasLayer, createCircle, createCircleFeature, createCircleStyle, createFeature, createHeatmapLayer, createHeatmapLayerOptions, createLineString, createLineStringFeature, createMultiLineString, createMultiLineStringFeature, createMultiPoint, createMultiPointFeature, createMultiPolygon, createMultiPolygonFeature, createOpenStreetMapLayer, createPMTilesLayer, createPoint, createPointFeature, createPolygon, createPolygonFeature, createStyle, createTextStyle, createTianDiTuLayer, createTianDiTuUrl, createTileGrid, createVectorLayer, createVectorSource, createWebGLVectorLayer, createXYZLayer, formatAngle, formatRotation, kmToNauticalMiles, nauticalMilesToKm, olMapInjectionKey, proj4, registerEPSG_3395, rotationToAngle, useContextmenu, useDrawLineString, useDrawPolygon, useGraticule, useMapClick, useMapClickHandler, useOlMap, usePointermove, useSwitchBaseLayer };