@baidumap/vue-bmap 1.0.0 → 1.0.2

package/dist/composables/useLocalSearch.d.ts

@@ -0,0 +1,92 @@
+import { Ref } from 'vue';
+import { Point, Bounds } from '../types';
+
+export interface LocalSearchRenderOptions {
+    /**
+     * 在地图上渲染结果用的 MapHandle。**非必传**：composable 在 `<Map>` 内部会自动取当前地图；
+     * 在 `<Map>` 外层则需显式传**已就绪**的 handle（用 `useMap`/`useMapReady` 拿）。显式传入优先。
+     */
+    map?: {
+        __brand: string;
+        raw: unknown;
+    };
+    panel?: string | HTMLElement;
+    selectFirstResult?: boolean;
+    autoViewport?: boolean;
+    viewportOptions?: {
+        noAnimation?: boolean;
+        margins?: number[];
+        zoomFactor?: number;
+    };
+}
+export interface LocalSearchOptions {
+    /** 搜索城市/区域，可为字符串、Point 或 Map。**非必传**：缺省时自动回退到当前 `<Map>`（或 `renderOptions.map`），与原生 `new BMap.LocalSearch(map, {...})` 一致 */
+    location?: string | Point | {
+        __brand: string;
+        raw: unknown;
+    };
+    /** 每页结果数（1-100） */
+    pageCapacity?: number;
+    /** 页码（v4+） */
+    pageNum?: number;
+    /**
+     * 是否自动在地图上渲染检索结果（默认 true，与原生一致）。
+     * 传 `false`＝**仅取数据**：不把地图注入 renderOptions.map，且缺省 location 时用地图中心点（而非 Map 实例）
+     * 作检索区域——避免 SDK 因拿到 Map 引用而自动画默认标注。适合"取数据后自绘标注"（如门店选址）。
+     */
+    autoRender?: boolean;
+    /** 渲染选项 */
+    renderOptions?: LocalSearchRenderOptions;
+    /** 搜索完成回调 */
+    onSearchComplete?: (results: unknown) => void;
+    /** 标注设置回调 */
+    onMarkersSet?: (pois: unknown[]) => void;
+    /** 信息窗回调 */
+    onInfoHtmlSet?: (poi: unknown, html: HTMLElement) => void;
+    /** 结果面板回调 */
+    onResultsHtmlSet?: (container: HTMLElement) => void;
+    /** 折线添加完成回调（对应 setPolylinesSetCallback） */
+    onPolylinesSet?: (polylines: unknown[]) => void;
+}
+export interface LocalSearchHookResult<T = unknown> {
+    data: Ref<T | undefined>;
+    loading: Ref<boolean>;
+    error: Ref<Error | null>;
+    supported: Ref<boolean>;
+    /** 搜索（支持多关键词数组） */
+    search: (keyword: string | string[], option?: {
+        forceLocal?: boolean;
+    }) => void;
+    /** 周边搜索 */
+    searchNearby: (keyword: string | string[], center: string | Point, radius: number) => void;
+    /** 范围搜索 */
+    searchInBounds: (keyword: string | string[], bounds: Bounds) => void;
+    /** 翻页 */
+    gotoPage: (page: number) => void;
+    /** 清空结果 */
+    clearResults: () => void;
+    /** 选中/高亮某条结果并打开其信息窗；index 为结果索引 */
+    select: (index: number) => void;
+    /** 取消选中：关掉信息窗 + 清结果列表选中态 */
+    clearSelected: () => void;
+    /** 运行时设置检索城市/区域（字符串 / Point / Map） */
+    setLocation: (location: string | Point | {
+        __brand: string;
+        raw: unknown;
+    }) => void;
+    /** 开启检索后自动调整视野 */
+    enableAutoViewport: () => void;
+    /** 关闭自动调整视野 */
+    disableAutoViewport: () => void;
+    /** 开启「自动选中第一个结果」 */
+    enableFirstResultSelection: () => void;
+    /** 关闭「自动选中第一个结果」 */
+    disableFirstResultSelection: () => void;
+    /** 运行时设置每页结果数（1-100） */
+    setPageCapacity: (n: number) => void;
+    /** 最近一次检索的状态码（BMAP_STATUS_*） */
+    getStatus: () => number | undefined;
+    /** 取消当前请求 */
+    cancel: () => void;
+}
+export declare function useLocalSearch<T = unknown>(opts?: LocalSearchOptions): LocalSearchHookResult<T>;

package/dist/composables/useMapStatus.d.ts

@@ -0,0 +1,12 @@
+import { ShallowRef } from 'vue';
+import { Bounds, Point, Size } from '../types';
+
+export interface MapSnapshot {
+    center: Point | null;
+    zoom: number | null;
+    bounds: Bounds | null;
+    size: Size | null;
+    heading: number | null;
+    tilt: number | null;
+}
+export declare function useMapStatus(): Readonly<ShallowRef<MapSnapshot | null>>;

package/dist/composables/usePanoramaService.d.ts

@@ -0,0 +1,16 @@
+import { Ref } from 'vue';
+import { Point } from '../types';
+
+export interface PanoramaServiceHookResult {
+    data: Ref<unknown>;
+    loading: Ref<boolean>;
+    error: Ref<Error | null>;
+    supported: Ref<boolean>;
+    getPanoramaById: (id: string) => void;
+    /** radius 可选，缺省走 SDK 默认（约 50 米） */
+    getPanoramaByLocation: (point: Point, radius?: number) => void;
+    /** 按 POI id 查询全景（部分版本 SDK 支持；运行时不支持时置 error） */
+    getPanoramaByPOIId: (poiId: string) => void;
+    cancel: () => void;
+}
+export declare function usePanoramaService(): PanoramaServiceHookResult;

package/dist/composables/usePlaceDetail.d.ts

@@ -0,0 +1,19 @@
+import { Ref } from 'vue';
+
+export interface PlaceDetailOptions {
+    container?: HTMLElement;
+    compact?: boolean;
+    renderOptions?: unknown;
+    /** 必须传**已就绪**的 MapHandle（非 null）；见 `useMap`/`useMapReady` 时序说明。 */
+    map?: unknown;
+}
+export interface PlaceDetailHookResult {
+    data: Ref<unknown>;
+    loading: Ref<boolean>;
+    error: Ref<Error | null>;
+    supported: Ref<boolean>;
+    render: (uid: string) => void;
+    rerender: () => void;
+    dispose: () => void;
+}
+export declare function usePlaceDetail(opts?: PlaceDetailOptions): PlaceDetailHookResult;

package/dist/composables/useRawControl.d.ts

@@ -0,0 +1,3 @@
+import { MaybeRefOrGetter, ShallowRef } from 'vue';
+
+export declare function useRawControl<T = unknown>(create: () => T, deps?: MaybeRefOrGetter<unknown>, onCreate?: (instance: T) => void): ShallowRef<T | null>;

package/dist/composables/useRawOverlay.d.ts

@@ -0,0 +1,3 @@
+import { MaybeRefOrGetter, ShallowRef } from 'vue';
+
+export declare function useRawOverlay<T = unknown>(create: () => T, deps?: MaybeRefOrGetter<unknown>, onCreate?: (instance: T) => void): ShallowRef<T | null>;

package/dist/composables/useRenderMap.d.ts

@@ -0,0 +1,4 @@
+import { ComputedRef } from 'vue';
+import { MapHandle } from '../types';
+
+export declare function useRenderMap(explicit?: unknown): ComputedRef<MapHandle | undefined>;

package/dist/composables/useRidingRoute.d.ts

@@ -0,0 +1,7 @@
+import { DrivingRouteOptions, DrivingRouteHookResult } from './useDrivingRoute';
+
+export type RidingRouteOptions = Omit<DrivingRouteOptions, 'policy' | 'alternatives'>;
+export type RidingRouteHookResult = Omit<DrivingRouteHookResult, 'setPolicy'> & {
+    setPolicy?: never;
+};
+export declare function useRidingRoute(opts?: RidingRouteOptions): RidingRouteHookResult;

package/dist/composables/useTransitRoute.d.ts

@@ -0,0 +1,16 @@
+import { DrivingRouteOptions, DrivingRouteHookResult } from './useDrivingRoute';
+
+export type TransitRouteOptions = Omit<DrivingRouteOptions, 'alternatives'> & {
+    /** 跨城公交换乘策略（BMAP_INTERCITY_POLICY_*） */
+    intercityPolicy?: number;
+    /** 跨城公交交通方式（BMAP_TRANSIT_TYPE_POLICY_*：火车/飞机/大巴） */
+    transitTypePolicy?: number;
+};
+export type TransitRouteHookResult = DrivingRouteHookResult & {
+    setPageCapacity: (n: number) => void;
+    /** 设置跨城换乘策略 */
+    setIntercityPolicy: (policy: number) => void;
+    /** 设置跨城交通方式（火车/飞机/大巴） */
+    setTransitTypePolicy: (policy: number) => void;
+};
+export declare function useTransitRoute(opts?: TransitRouteOptions): TransitRouteHookResult;

package/dist/composables/useTruckRoute.d.ts

@@ -0,0 +1,7 @@
+import { DrivingRouteOptions, DrivingRouteHookResult } from './useDrivingRoute';
+
+export type TruckRouteOptions = Omit<DrivingRouteOptions, 'alternatives'>;
+export type TruckRouteHookResult = DrivingRouteHookResult & {
+    setPageCapacity: (n: number) => void;
+};
+export declare function useTruckRoute(opts?: TruckRouteOptions): TruckRouteHookResult;

package/dist/composables/useWalkingRoute.d.ts

@@ -0,0 +1,7 @@
+import { DrivingRouteOptions, DrivingRouteHookResult } from './useDrivingRoute';
+
+export type WalkingRouteOptions = Omit<DrivingRouteOptions, 'policy' | 'alternatives'>;
+export type WalkingRouteHookResult = Omit<DrivingRouteHookResult, 'setPolicy'> & {
+    setPolicy?: never;
+};
+export declare function useWalkingRoute(opts?: WalkingRouteOptions): WalkingRouteHookResult;