tg-map-vue3 3.5.6 → 3.6.0

package/CHANGELOG.md

@@ -1,8 +1,14 @@
 # 更新日志
 
+## 3.6.x
+
+- feat: 添加[MapUrls], 支持打开地图网页
+- ***BREAKING CHANGE***: `placeService` -> `placesService`
+
 ## 3.5.x
 
 - fix: [LatLngBounds]为空时中心点计算问题
+- perf: 废弃`rightclick`事件, 使用`contextmenu`替代
 - ***BREAKING CHANGE***: `useTgMap` -> [useTgMapInner]
 - ***BREAKING CHANGE***: 统一[TgLabel]在google和baidu上的默认显示层级, 都位于overlay上方
 
@@ -44,6 +50,7 @@
 [SymbolIcon]: src/map/map/overlay/icon.ts#L55 "Svg图标"
 [PlacesService]: src/map/map/extra/places-service.ts "位置服务"
 [Autocomplete]: src/map/map/extra/autocomplete.ts "自动完成"
+[MapUrls]: src/map/map/extra/map-urls.ts "地图网页"
 [SearchBox]: src/map/map/extra/search-box.ts "搜索框"
 [useTgMapInner]: src/components/map-hooks.ts
 [LatLngBounds]: src/map/lat-lng.ts#L157

package/dist/src/components/TgMap.vue.d.ts

@@ -60,6 +60,10 @@ declare const _default: import("vue").DefineComponent<{
         type: import("vue").PropType<number>;
         required: true;
     };
+    /**
+     * 该属性不会响应式更新, 要让它立即生效, 请参考{@link file://./../views/map/InfoDemo.vue#L3}
+     * @see MapOptions.infoWindowMode
+     */
     infoWindowMode: {
         type: import("vue").PropType<"single" | "multi">;
     };
@@ -150,6 +154,10 @@ declare const _default: import("vue").DefineComponent<{
         type: import("vue").PropType<number>;
         required: true;
     };
+    /**
+     * 该属性不会响应式更新, 要让它立即生效, 请参考{@link file://./../views/map/InfoDemo.vue#L3}
+     * @see MapOptions.infoWindowMode
+     */
     infoWindowMode: {
         type: import("vue").PropType<"single" | "multi">;
     };
@@ -195,6 +203,7 @@ declare const _default: import("vue").DefineComponent<{
     onClick?: ((event: import("../map/event").Tg.MouseEvent) => any) | undefined;
     onDblclick?: ((event: import("../map/event").Tg.MouseEvent) => any) | undefined;
     onRightclick?: ((event: import("../map/event").Tg.MouseEvent) => any) | undefined;
+    onContextmenu?: ((event: import("../map/event").Tg.MouseEvent) => any) | undefined;
     onMousedown?: ((event: import("../map/event").Tg.MouseEvent) => any) | undefined;
     onMouseup?: ((event: import("../map/event").Tg.MouseEvent) => any) | undefined;
     onMouseout?: ((event: import("../map/event").Tg.MouseEvent) => any) | undefined;

package/dist/src/components/index.d.ts

@@ -15,6 +15,7 @@ export * from '../map/map/controls/map-type.control';
 export * from '../map/map/controls/scale.control';
 export * from '../map/map/controls/zoom.control';
 export * from '../map/map/extra/autocomplete';
+export * from '../map/map/extra/map-urls';
 export * from '../map/map/extra/marker-clusterer';
 export * from '../map/map/extra/places-service';
 export * from '../map/map/extra/search-box';

package/dist/src/components/overlays/TgMarker.vue.d.ts

@@ -57,11 +57,10 @@ declare const TgMarker: import("vue").DefineComponent<{
             readonly offset?: any;
             style?: unknown;
             onClick?: ((event: import("../../map/event").Tg.Event) => any) | undefined;
-            class?: unknown;
             ref?: import("vue").VNodeRef | undefined;
+            class?: unknown;
             ref_for?: boolean | undefined;
             ref_key?: string | undefined;
-            readonly mapPane?: import("../../utils/mapped-types").StringEnumValue<typeof import("../../map/map/overlay/element-overlay").MapPane> | undefined;
             onVnodeBeforeMount?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                 [key: string]: any;
             }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
@@ -100,6 +99,7 @@ declare const TgMarker: import("vue").DefineComponent<{
             }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
                 [key: string]: any;
             }>) => void)[] | undefined;
+            readonly mapPane?: import("../../utils/mapped-types").StringEnumValue<typeof import("../../map/map/overlay/element-overlay").MapPane> | undefined;
         };
         $attrs: {
             [x: string]: unknown;
@@ -238,6 +238,7 @@ declare const TgMarker: import("vue").DefineComponent<{
     onClick?: ((event: import("../../map/event").Tg.MouseEvent) => any) | undefined;
     onDblclick?: ((event: import("../../map/event").Tg.MouseEvent) => any) | undefined;
     onRightclick?: ((event: import("../../map/event").Tg.MouseEvent) => any) | undefined;
+    onContextmenu?: ((event: import("../../map/event").Tg.MouseEvent) => any) | undefined;
     onMousedown?: ((event: import("../../map/event").Tg.MouseEvent) => any) | undefined;
     onMouseup?: ((event: import("../../map/event").Tg.MouseEvent) => any) | undefined;
     onMouseout?: ((event: import("../../map/event").Tg.MouseEvent) => any) | undefined;

package/dist/src/map/lat-lng.d.ts

@@ -121,3 +121,9 @@ export declare namespace LatLngBounds {
         private delta;
     }
 }
+/** 在导航/搜索等接口中使用的 位置 */
+export type Location = string | LatLng;
+export declare namespace Location {
+    function toString(place: Location | undefined, coordType: CoordType): string | undefined;
+    function getCoordType(place: Location | undefined): CoordType | undefined;
+}

package/dist/src/map/map/baidu-map.d.ts

@@ -5,8 +5,9 @@ import { BaiduMapTypeControl } from './controls/map-type.control';
 import { BaiduScaleControl } from './controls/scale.control';
 import { BaiduZoomControl } from './controls/zoom.control';
 import { type Autocomplete, type AutocompleteOptions } from './extra/autocomplete';
+import { type MapUrls, type MapUrlsOptions } from './extra/map-urls';
 import { BaiduMarkerClusterer, type MarkerClustererOptions } from './extra/marker-clusterer';
-import { type PlaceServiceOptions, type PlacesService } from './extra/places-service';
+import { type PlacesService, type PlacesServiceOptions } from './extra/places-service';
 import { type SearchBox, type SearchBoxOptions } from './extra/search-box';
 import { AbstractMap, type AbstractMapEventMap } from './map';
 import { GestureHandlingOptions, MapOptions, type MapStyle } from './map-options';
@@ -72,5 +73,6 @@ export declare class BaiduMap extends AbstractMap {
     createMarkerClusterer(options: MarkerClustererOptions): BaiduMarkerClusterer;
     createAutocomplete(options: AutocompleteOptions): Autocomplete;
     createSearchBox(options: SearchBoxOptions): SearchBox;
-    createPlaceService(options: PlaceServiceOptions): PlacesService;
+    createPlacesService(options: PlacesServiceOptions): PlacesService;
+    createMapUrlsService(options: MapUrlsOptions): MapUrls;
 }

package/dist/src/map/map/extra/map-urls.d.ts

@@ -0,0 +1,35 @@
+import { Location } from '../../lat-lng';
+export type DirectionMode = 'transit' | 'driving' | 'walking';
+/** google多支持一种导航模式 */
+type GoogleDirectionMode = DirectionMode | 'bicycling';
+export interface MapUrlsOptions {
+}
+export declare abstract class MapUrls {
+    protected options: MapUrlsOptions;
+    constructor(options: MapUrlsOptions);
+    /**
+     * 导航
+     *
+     * ## {@link origin}为空时的行为差异
+     * - google: 用我的位置当做起点
+     * - baidu: 用{@link destination}当作起点
+     */
+    abstract directions(origin: Location | undefined, destination: Location, mode?: DirectionMode): URL;
+}
+/**
+ * @see https://developers.google.com/maps/documentation/urls/get-started
+ */
+export declare class GoogleMapUrls extends MapUrls {
+    static BASE_URL: string;
+    /** @see https://developers.google.com/maps/documentation/urls/get-started#directions-action */
+    directions(origin: Location | undefined, destination: Location, mode?: GoogleDirectionMode): URL;
+}
+/**
+ * @see https://lbsyun.baidu.com/faq/api?title=webapi/uri
+ */
+export declare class BaiduMapUrls extends MapUrls {
+    static BASE_URL: string;
+    /** @see https://lbsyun.baidu.com/faq/api?title=webapi/uri/web#:~:text=%E6%9C%8D%E5%8A%A1%E5%9C%B0%E5%9D%80-,http%3A//api.map.baidu.com/direction,-//PC%26Webapp%E6%9C%8D%E5%8A%A1 */
+    directions(origin: Location | undefined, destination: Location, mode?: DirectionMode): URL;
+}
+export {};

package/dist/src/map/map/extra/places-service.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="google.maps" />
 /// <reference types="baidumap-web-sdk" />
-import { LatLng, LatLngBounds, type AbstractMap } from '../../../components';
+import { LatLng, LatLngBounds, Location, type AbstractMap } from '../../../components';
 import type { UnionPlacesService } from '../../unions';
 import type { BaiduMap } from '../baidu-map';
 import type { GoogleMap } from '../google-map';
@@ -13,14 +13,14 @@ export interface Place {
     title: string;
     address: string;
 }
-export interface PlaceServiceOptions {
+export interface PlacesServiceOptions {
 }
 export declare abstract class PlacesService {
     abstract inner: UnionPlacesService;
     abstract map: AbstractMap;
     constructor();
     /** 指定{@link location}搜索, 若不指定, 则默认使用地图的中心点 */
-    abstract search(query: string, location?: string | LatLng): Promise<Place[]>;
+    abstract search(query: string, location?: Location): Promise<Place[]>;
     /** 在指定的bounds范围内搜索 */
     abstract searchInBounds(query: string, bounds: LatLngBounds): Promise<Place[]>;
     /** 在指定的center+radius范围内搜索 */
@@ -29,8 +29,8 @@ export declare abstract class PlacesService {
 export declare class GooglePlacesService extends PlacesService {
     map: GoogleMap;
     inner: google.maps.places.PlacesService;
-    constructor(map: GoogleMap, _options: PlaceServiceOptions);
-    search(query: string, location?: string | LatLng): Promise<Place[]>;
+    constructor(map: GoogleMap, _options: PlacesServiceOptions);
+    search(query: string, location?: Location): Promise<Place[]>;
     searchInBounds(query: string, bounds: LatLngBounds): Promise<Place[]>;
     searchNearBy(query: string, center: LatLng, radius: number): Promise<Place[]>;
     private searchImpl;
@@ -40,8 +40,8 @@ export declare class BaiduPlacesService extends PlacesService {
     private searchRequestMap;
     get inner(): BMap.LocalSearch;
     currentSearch: BMap.LocalSearch | undefined;
-    constructor(map: BaiduMap, _options: PlaceServiceOptions);
-    search(query: string, location?: string | LatLng): Promise<Place[]>;
+    constructor(map: BaiduMap, _options: PlacesServiceOptions);
+    search(query: string, location?: Location): Promise<Place[]>;
     searchInBounds(query: string, bounds: LatLngBounds): Promise<Place[]>;
     searchNearBy(query: string, center: LatLng, radius: number): Promise<Place[]>;
     private newSearch;

package/dist/src/map/map/extra/search-box.d.ts

@@ -30,7 +30,7 @@ export declare class GoogleSearchBox extends SearchBox {
 }
 export declare class BaiduSearchBox extends SearchBox {
     private autocomplete;
-    private placeService;
+    private placesService;
     constructor(map: BaiduMap, options: SearchBoxOptions);
     setSearchListener(onData: EventCallback<Place[]>, onError?: (e: any) => void): RemoveEventListenerFunction;
     search(): void;

package/dist/src/map/map/google-map.d.ts

@@ -6,8 +6,9 @@ import { GoogleMapTypeControl } from './controls/map-type.control';
 import { GoogleScaleControl } from './controls/scale.control';
 import { GoogleZoomControl } from './controls/zoom.control';
 import { Autocomplete, type AutocompleteOptions } from './extra/autocomplete';
+import { type MapUrls, type MapUrlsOptions } from './extra/map-urls';
 import { GoogleMarkerClusterer, type MarkerClustererOptions } from './extra/marker-clusterer';
-import { type PlaceServiceOptions, type PlacesService } from './extra/places-service';
+import { type PlacesService, type PlacesServiceOptions } from './extra/places-service';
 import { SearchBox, type SearchBoxOptions } from './extra/search-box';
 import { AbstractMap } from './map';
 import type { GestureHandlingOptions, MapOptions, MapStyle } from './map-options';
@@ -72,5 +73,6 @@ export declare class GoogleMap extends AbstractMap {
     createMarkerClusterer(options: MarkerClustererOptions): GoogleMarkerClusterer;
     createAutocomplete(options: AutocompleteOptions): Autocomplete;
     createSearchBox(options: SearchBoxOptions): SearchBox;
-    createPlaceService(options: PlaceServiceOptions): PlacesService;
+    createPlacesService(options: PlacesServiceOptions): PlacesService;
+    createMapUrlsService(options: MapUrlsOptions): MapUrls;
 }

package/dist/src/map/map/here-map.d.ts

@@ -6,8 +6,9 @@ import type { MapTypeControl, MapTypeControlOptions } from './controls/map-type.
 import type { ScaleControlOptions } from './controls/scale.control';
 import type { ZoomControl, ZoomControlOptions } from './controls/zoom.control';
 import type { Autocomplete, AutocompleteOptions } from './extra/autocomplete';
+import type { MapUrls, MapUrlsOptions } from './extra/map-urls';
 import type { MarkerClusterer, MarkerClustererOptions } from './extra/marker-clusterer';
-import type { PlaceServiceOptions, PlacesService } from './extra/places-service';
+import type { PlacesService, PlacesServiceOptions } from './extra/places-service';
 import type { SearchBox, SearchBoxOptions } from './extra/search-box';
 import { AbstractMap } from './map';
 import type { GestureHandlingOptions, MapOptions, MapStyle } from './map-options';
@@ -57,7 +58,8 @@ export declare class HereMap extends AbstractMap {
     createMarkerClusterer(options: MarkerClustererOptions): MarkerClusterer;
     createAutocomplete(options: AutocompleteOptions): Autocomplete;
     createSearchBox(options: SearchBoxOptions): SearchBox;
-    createPlaceService(options: PlaceServiceOptions): PlacesService;
+    createPlacesService(options: PlacesServiceOptions): PlacesService;
+    createMapUrlsService(options: MapUrlsOptions): MapUrls;
     createInfoWindow(options: InfoWindowOptions): InfoWindowOverlay;
     createInfoBox(options: InfoBoxOptions): InfoBoxOverlay;
     createPolyline(options: PolylineOptions): PolylineOverlay;

package/dist/src/map/map/map-options.d.ts

@@ -24,6 +24,15 @@ export interface MapOptions {
     center: LatLng;
     /** 缩放等级, 必须是整数 */
     zoom: number;
+    /**
+     * ## 不同行为
+     * - baidu: 只支持单窗口
+     * - google: 支持单窗口或多窗口, 默认多窗口
+     *
+     * 要显示多个弹窗, 推荐使用InfoBox替代
+     *
+     * {@macros info_window_vs_box}
+     */
     infoWindowMode?: InfoWindowMode;
     gestureHandling?: GestureHandlingOptions;
     minZoom?: number;

package/dist/src/map/map/map.d.ts

@@ -9,8 +9,9 @@ import type { MapTypeControl, MapTypeControlOptions } from './controls/map-type.
 import type { ScaleControlOptions } from './controls/scale.control';
 import type { ZoomControl, ZoomControlOptions } from './controls/zoom.control';
 import type { Autocomplete, AutocompleteOptions } from './extra/autocomplete';
+import type { MapUrls, MapUrlsOptions } from './extra/map-urls';
 import type { MarkerClusterer, MarkerClustererOptions } from './extra/marker-clusterer';
-import type { PlaceServiceOptions, PlacesService } from './extra/places-service';
+import type { PlacesService, PlacesServiceOptions } from './extra/places-service';
 import type { SearchBox, SearchBoxOptions } from './extra/search-box';
 import type { GestureHandlingOptions, MapStyle } from './map-options';
 import type { BuildInMapTypeId, Layer, MapType, OverlayMapType } from './map-type';
@@ -27,7 +28,9 @@ import type { RectangleOptions, RectangleOverlay } from './overlay/rectangle';
 export type AbstractMapEventMap = {
     click: Tg.MouseEvent;
     dblclick: Tg.MouseEvent;
+    /** @deprecated 使用`contextmenu`替代 */
     rightclick: Tg.MouseEvent;
+    contextmenu: Tg.MouseEvent;
     dragstart: Tg.Event;
     drag: Tg.Event;
     dragend: Tg.Event;
@@ -134,7 +137,8 @@ export declare abstract class AbstractMap implements CoordTypeSupplier, Tg.Event
     abstract createMarkerClusterer(options: MarkerClustererOptions): MarkerClusterer;
     abstract createAutocomplete(options: AutocompleteOptions): Autocomplete;
     abstract createSearchBox(options: SearchBoxOptions): SearchBox;
-    abstract createPlaceService(options: PlaceServiceOptions): PlacesService;
+    abstract createPlacesService(options: PlacesServiceOptions): PlacesService;
+    abstract createMapUrlsService(options: MapUrlsOptions): MapUrls;
     abstract createInfoWindow(options: InfoWindowOptions): InfoWindowOverlay;
     abstract createInfoBox(options: InfoBoxOptions): InfoBoxOverlay;
     abstract createPolyline(options: PolylineOptions): PolylineOverlay;

package/dist/src/map/map/overlay/baidu-info-box.d.ts

@@ -36,10 +36,15 @@ export declare function createBaiduInfoBox(content: HTMLElement, position?: BMap
     }): void;
 };
 /**
+ * {@template info_window_vs_box}
  * baidu自带的InfoWindow有如下问题:
  * 1. 窗体不可自定义, 默认的窗体有点丑
  * 2. 一次只能显示一个
  * 3. 和MarkerClusterer的配合并不好, 重建聚合时会使InfoWindow消失
+ *
+ * 故重新实现了一个InfoBox, 解决上述问题, 用来替代InfoWindow, 但Info也点问题...:
+ * 1. 未实现InfoWindow的autoPan功能
+ * {@endtemplate }
  */
 declare function createBaiduInfoBoxClass(): {
     new (content: HTMLElement, position?: BMap.Point, offset?: Point, zIndex?: number, maxWidth?: number, borderClass?: string): {

package/dist/src/map/map/overlay/info-box.d.ts

@@ -21,6 +21,7 @@ export interface InfoBoxOptions {
     maxWidth?: number;
     borderClass?: string;
 }
+/** {@macros info_window_vs_box} */
 export interface InfoBox extends Tg.EventTarget {
     open(anchor?: Marker): void;
     close(): void;

package/dist/src/map/map/overlay/marker.d.ts

@@ -36,7 +36,9 @@ export interface MarkerOptions extends OverlayOptions {
 export type MarkerEventMap = {
     click: Tg.MouseEvent;
     dblclick: Tg.MouseEvent;
+    /** @deprecated 使用`contextmenu`替代 */
     rightclick: Tg.MouseEvent;
+    contextmenu: Tg.MouseEvent;
     mousedown: Tg.MouseEvent;
     mouseup: Tg.MouseEvent;
     mouseout: Tg.MouseEvent;

package/dist/src/utils/utils.d.ts

@@ -7,3 +7,10 @@ export declare function debug(msg?: any): any;
 export declare function noop(...args: any[]): void;
 /** 可以用在Array.filter(isDef)中, 用来过滤为空的值 */
 export declare function isDef<T>(v: T | undefined | null): v is T;
+/**
+ * entry的value是否定义了
+ *
+ * 可以用在Array.filter(isEntryValueDef)中, 用来过滤值为空的元素
+ * @see isDef
+ */
+export declare function isEntryValueDef<K, V>(entry: [K, V]): entry is [K, NonNullable<V>];