@summeruse/ol 0.5.0 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @summeruse/ol
 
+## 0.6.0
+
+### Minor Changes
+
+- 6a8ca7e: feat(composables): 新增 useMapClick 组合式函数处理地图点击事件
+
+### Patch Changes
+
+- d727683: feat(usePointermove): 支持 hitTolerance 并按容差分组优化检测性能
+
+## 0.5.1
+
+### Patch Changes
+
+- 774051c: feat(utils): 添加弧度与角度转换函数
+- 112feb2: feat(ol-map): 添加地图旋转支持
+
 ## 0.5.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -2,19 +2,19 @@ import * as vue20 from "vue";
 import { CSSProperties, InjectionKey, MaybeRef, MaybeRefOrGetter, Ref, VNode, VNodeChild } from "vue";
 import * as ol0 from "ol";
 import { Feature, Map, Map as OLMap, MapEvent } from "ol";
-import { Extent } from "ol/extent";
 import { Circle, Geometry, LineString, MultiLineString, MultiPoint, MultiPolygon, Point, Polygon } from "ol/geom";
-import VectorLayer from "ol/layer/Vector";
-import VectorSource from "ol/source/Vector";
 import { Circle as Circle$1, Fill, Icon, Stroke, Style, Text } from "ol/style";
 import { Graticule, Layer, Tile } from "ol/layer";
 import HeatmapLayer from "ol/layer/Heatmap";
+import VectorLayer from "ol/layer/Vector";
 import WebGLVectorLayer from "ol/layer/WebGLVector";
 import * as ol_source0 from "ol/source";
 import { BingMaps, OSM, Source, XYZ } from "ol/source";
 import ImageTileSource from "ol/source/ImageTile";
+import VectorSource from "ol/source/Vector";
 import { Projection } from "ol/proj";
 import * as ol_tilegrid0 from "ol/tilegrid";
+import { Extent } from "ol/extent";
 import * as ol_coordinate0 from "ol/coordinate";
 import { Coordinate } from "ol/coordinate";
 import { ObjectEvent } from "ol/Object";
@@ -27,8 +27,12 @@ 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
+declare const ONE_NM = 1852;
+//#endregion
 //#region constants/projection.d.ts
 /** 3857坐标系 球面墨卡托投影坐标系 */
 declare const EPSG_3857 = "EPSG:3857";
@@ -42,6 +46,7 @@ type ProjectionLike = 'EPSG:3857' | 'EPSG:4326' | 'EPSG:3395';
 interface OlMapProps {
   olMap?: Map;
   center?: Coordinate;
+  rotation?: number;
   zoom?: number;
   minZoom?: number;
   maxZoom?: number;
@@ -66,7 +71,9 @@ declare function useOlMap(): Map | undefined;
 interface OlMapEmits {
   'update:zoom': [number];
   'update:center': [Coordinate];
+  'update:rotation': [number];
   'changeResolution': [ObjectEvent];
+  'changeRotation': [ObjectEvent];
   'changeCenter': [ObjectEvent];
   'moveend': [MapEvent];
   'movestart': [MapEvent];
@@ -85,18 +92,23 @@ declare const __VLS_component: vue20.DefineComponent<OlMapProps, {
 }, {}, {}, {}, vue20.ComponentOptionsMixin, vue20.ComponentOptionsMixin, {
   "update:zoom": (args_0: number) => any;
   "update:center": (args_0: ol_coordinate0.Coordinate) => any;
+  "update:rotation": (args_0: number) => any;
   changeResolution: (args_0: ObjectEvent) => any;
+  changeRotation: (args_0: ObjectEvent) => any;
   changeCenter: (args_0: ObjectEvent) => any;
   moveend: (args_0: MapEvent) => any;
   movestart: (args_0: MapEvent) => any;
 }, string, vue20.PublicProps, Readonly<OlMapProps> & Readonly<{
   "onUpdate:zoom"?: ((args_0: number) => any) | undefined;
   "onUpdate:center"?: ((args_0: ol_coordinate0.Coordinate) => any) | undefined;
+  "onUpdate:rotation"?: ((args_0: number) => any) | undefined;
   onChangeResolution?: ((args_0: ObjectEvent) => any) | undefined;
+  onChangeRotation?: ((args_0: ObjectEvent) => any) | undefined;
   onChangeCenter?: ((args_0: ObjectEvent) => any) | undefined;
   onMoveend?: ((args_0: MapEvent) => any) | undefined;
   onMovestart?: ((args_0: MapEvent) => any) | undefined;
 }>, {
+  rotation: number;
   maxZoom: number;
   minZoom: number;
   olMap: Map;
@@ -126,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 {
@@ -200,6 +215,10 @@ type UseContextmenuFn = (...args: UseContextmenuParams) => UseContextmenuReturn;
 declare function kmToNauticalMiles(km: number): number;
 /** 海里转公里 */
 declare function nauticalMilesToKm(nauticalMiles: number): number;
+/** 弧度转角度 */
+declare function rotationToAngle(rotation: number): number;
+/** 角度转弧度 */
+declare function angleToRotation(angle: number): number;
 /** 格式化Rotation */
 declare function formatRotation(rotation: number): number;
 /** 格式化角度 */
@@ -580,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;
@@ -590,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> = {
@@ -609,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>;
@@ -662,7 +726,4 @@ declare function useSwitchBaseLayer(data: {
   visibleLayerName: vue20.Ref<string, string>;
 };
 //#endregion
-//#region constants/distance.d.ts
-declare const ONE_NM = 1852;
-//#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, 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, 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 };