diff --git a/docs/zh/base/com-events.md b/docs/zh/base/com-events.md index 37d85ee6..c51fa2fc 100644 --- a/docs/zh/base/com-events.md +++ b/docs/zh/base/com-events.md @@ -2,7 +2,7 @@ 每个组件都有这两个事件。如果该组件库提供的功能不能满足开发需求,则可以通过`initd`事件暴露百度地图实例来自由的使用。 -| 事件名 | 说明 | 类型 | -| ------ | ------------------------------------------ | ----------------- | +| 事件名 | 说明 | 类型 | +| ------ | ------------------------------------------ | --------------------------- | | initd | 组件初始化后会触发此事件,返回一个地图实例 | `{ map, BmapGL, instance }` | -| unload | 组件卸载时会触发此事件 | - | +| unload | 组件卸载时会触发此事件 | - | diff --git a/docs/zh/base/index.md b/docs/zh/base/index.md index 0022c1e0..7da171ef 100644 --- a/docs/zh/base/index.md +++ b/docs/zh/base/index.md @@ -177,16 +177,16 @@ import { Map } from 'vue3-baidu-map-gl' ## 静态组件 props -| 属性 | 说明 | 类型 | 可选值 | 默认值 | -| ----------------- | ------------------------------------------------------ | ------------------------------------------------------------------------- | ------ | ------- | +| 属性 | 说明 | 类型 | 可选值 | 默认值 | +| ----------------- | -------------------------------------------------------- | ------------------------------------------------------------------------- | ------ | ------- | | ak | 百度地图 ak [申请 ak](../guide/quick-start#申请-ak-密钥) | `string` | - | - | -| width | 地图显示宽度 | `string / number` | - | `100%` | -| height | 地图显示高度 | `string / number` | - | `550px` | -| minZoom | 地图允许展示的最小级别 | `number` | `0-21` | `0` | -| maxZoom | 地图允许展示的最大级别 | `number` | `0-21` | `21` | -| showControls | 是否显示室内图 | `boolean` | - | `false` | -| plugins | 需要注册的插件 | `['TrackAnimation', 'Mapvgl', 'Mapv', 'MapvglThree']` | - | - | -| pluginsSourceLink | 自定义插件资源地址 | `Record<'TrackAnimation' \| 'Mapvgl' \| 'Mapv' \| 'MapvglThree', string>` | - | - | +| width | 地图显示宽度 | `string / number` | - | `100%` | +| height | 地图显示高度 | `string / number` | - | `550px` | +| minZoom | 地图允许展示的最小级别 | `number` | `0-21` | `0` | +| maxZoom | 地图允许展示的最大级别 | `number` | `0-21` | `21` | +| showControls | 是否显示室内图 | `boolean` | - | `false` | +| plugins | 需要注册的插件 | `['TrackAnimation', 'Mapvgl', 'Mapv', 'MapvglThree']` | - | - | +| pluginsSourceLink | 自定义插件资源地址 | `Record<'TrackAnimation' \| 'Mapvgl' \| 'Mapv' \| 'MapvglThree', string>` | - | - | ## 动态组件 Props @@ -237,6 +237,15 @@ import { Map } from 'vue3-baidu-map-gl' | street | 是否显示路网(只对卫星图和地球模式有效) | `boolean` | `true` | | skyColors | 是否显示路网(只对卫星图和地球模式有效) | `[string, string]` | - | +## 组件方法 + +| 方法 | 说明 | 类型 | +| ----------------- | -------------------------------- | ---------------------------------- | +| getMapInstance | 父组件获取 map 实例方法 | `() => void` | +| getBaseMapOptions | 父组件/外部获取 map 组件 options | `() => void` | +| resetCenter | 重置地图中心 | `() => void` | +| setDragging | 设置地图是否可拖动 | `(nableDragging: boolean) => void` | + ## 组件事件 | 事件名 | 说明 | 类型 | diff --git a/docs/zh/context-menu/index.md b/docs/zh/context-menu/index.md index 3e2396f1..0d604681 100644 --- a/docs/zh/context-menu/index.md +++ b/docs/zh/context-menu/index.md @@ -108,9 +108,9 @@ import { ContextMenu } from 'vue3-baidu-map-gl' ## 组件事件 -| 事件名 | 说明 | 类型 | -| ------ | -------------------------------------------------------------------------------- | -------------------- | -| initd | 组件初始化后,调用的方法,返回一个地图实例 | `{ map, BmapGL, instance }` | -| unload | 组件卸载时会调用此方法 | - | -| open | 右键菜单打开时触发,事件参数 point 和 pixel 分别表示菜单开启时的地理和像素坐标点 | ((e: Event) => void) | -| close | 右键菜单关闭时触发,事件参数 point 和 pixel 分别表示菜单开启时的地理和像素坐标点 | ((e: Event) => void) | +| 事件名 | 说明 | 类型 | +| ------ | -------------------------------------------------------------------------------- | --------------------------- | +| initd | 组件初始化后,调用的方法,返回一个地图实例 | `{ map, BmapGL, instance }` | +| unload | 组件卸载时会调用此方法 | - | +| open | 右键菜单打开时触发,事件参数 point 和 pixel 分别表示菜单开启时的地理和像素坐标点 | ((e: Event) => void) | +| close | 右键菜单关闭时触发,事件参数 point 和 pixel 分别表示菜单开启时的地理和像素坐标点 | ((e: Event) => void) | diff --git a/docs/zh/control/citylist.md b/docs/zh/control/citylist.md index 28679141..7a235b74 100644 --- a/docs/zh/control/citylist.md +++ b/docs/zh/control/citylist.md @@ -55,7 +55,7 @@ https://lbs.baidu.com/jsdemo.htm#cCityList ## 组件事件 -| 事件名 | 说明 | 类型 | -| ------ | ------------------------------------------ | ----------------- | +| 事件名 | 说明 | 类型 | +| ------ | ------------------------------------------ | --------------------------- | | initd | 组件初始化后,调用的方法,返回一个地图实例 | `{ map, BmapGL, instance }` | -| unload | 组件卸载时会调用此方法 | - | +| unload | 组件卸载时会调用此方法 | - | diff --git a/docs/zh/control/copyright.md b/docs/zh/control/copyright.md index 1fc35fa0..f5703e03 100644 --- a/docs/zh/control/copyright.md +++ b/docs/zh/control/copyright.md @@ -100,7 +100,7 @@ if(typeof window !== 'undefined'){ ## 组件事件 -| 事件名 | 说明 | 类型 | -| ------ | ------------------------------------------ | ----------------- | +| 事件名 | 说明 | 类型 | +| ------ | ------------------------------------------ | --------------------------- | | initd | 组件初始化后,调用的方法,返回一个地图实例 | `{ map, BmapGL, instance }` | -| unload | 组件卸载时会调用此方法 | - | +| unload | 组件卸载时会调用此方法 | - | diff --git a/docs/zh/control/custom.md b/docs/zh/control/custom.md index e8cc83dd..1bcc5d8f 100644 --- a/docs/zh/control/custom.md +++ b/docs/zh/control/custom.md @@ -105,7 +105,7 @@ button{ ## 组件事件 -| 事件名 | 说明 | 类型 | -| ------ | ------------------------------------------ | ----------------- | +| 事件名 | 说明 | 类型 | +| ------ | ------------------------------------------ | --------------------------- | | initd | 组件初始化后,调用的方法,返回一个地图实例 | `{ map, BmapGL, instance }` | -| unload | 组件卸载时会调用此方法 | - | +| unload | 组件卸载时会调用此方法 | - | diff --git a/docs/zh/control/location.md b/docs/zh/control/location.md index fa2785e3..b57d4cad 100644 --- a/docs/zh/control/location.md +++ b/docs/zh/control/location.md @@ -47,7 +47,7 @@ import { Location } from 'vue3-baidu-map-gl' ## 组件事件 -| 事件名 | 说明 | 类型 | -| ------ | ------------------------------------------ | ----------------- | +| 事件名 | 说明 | 类型 | +| ------ | ------------------------------------------ | --------------------------- | | initd | 组件初始化后,调用的方法,返回一个地图实例 | `{ map, BmapGL, instance }` | -| unload | 组件卸载时会调用此方法 | - | +| unload | 组件卸载时会调用此方法 | - | diff --git a/docs/zh/control/navigation3d.md b/docs/zh/control/navigation3d.md index 81f0ce9b..c95c99f2 100644 --- a/docs/zh/control/navigation3d.md +++ b/docs/zh/control/navigation3d.md @@ -49,7 +49,7 @@ import { Navigation3d } from 'vue3-baidu-map-gl' ## 组件事件 -| 事件名 | 说明 | 类型 | -| ------ | ------------------------------------------ | ----------------- | +| 事件名 | 说明 | 类型 | +| ------ | ------------------------------------------ | --------------------------- | | initd | 组件初始化后,调用的方法,返回一个地图实例 | `{ map, BmapGL, instance }` | -| unload | 组件卸载时会调用此方法 | - | +| unload | 组件卸载时会调用此方法 | - | diff --git a/docs/zh/control/panorama-control.md b/docs/zh/control/panorama-control.md index 6c65bc81..2e3f96b1 100644 --- a/docs/zh/control/panorama-control.md +++ b/docs/zh/control/panorama-control.md @@ -1,6 +1,6 @@ # 全景控件 -全景地图服务,360°全景地图刻画真实世界,将街道场景带入到地图产品中,用户可以拖拽地图从不同的角度浏览真实的街景效果 +全景地图服务,360° 全景地图刻画真实世界,将街道场景带入到地图产品中,用户可以拖拽地图从不同的角度浏览真实的街景效果 ```ts import { PanoramaControl } from 'vue3-baidu-map-gl' @@ -11,7 +11,9 @@ import { PanoramaControl } from 'vue3-baidu-map-gl' ::: ## 组件示例 + 单独使用该组件不会显示全景地图覆盖情况,还需要搭配`PanoramaCoverageLayer`组件使用。 +
@@ -38,7 +40,7 @@ import { PanoramaControl } from 'vue3-baidu-map-gl' ## 组件事件 -| 事件名 | 说明 | 类型 | -| ------ | ------------------------------------------ | ----------------- | +| 事件名 | 说明 | 类型 | +| ------ | ------------------------------------------ | --------------------------- | | initd | 组件初始化后,调用的方法,返回一个地图实例 | `{ map, BmapGL, instance }` | -| unload | 组件卸载时会调用此方法 | - | +| unload | 组件卸载时会调用此方法 | - | diff --git a/docs/zh/control/scale.md b/docs/zh/control/scale.md index 54cd9507..9a8bd1f3 100644 --- a/docs/zh/control/scale.md +++ b/docs/zh/control/scale.md @@ -64,7 +64,7 @@ import { Scale } from 'vue3-baidu-map-gl' ## 组件事件 -| 事件名 | 说明 | 类型 | -| ------ | ------------------------------------------ | ----------------- | +| 事件名 | 说明 | 类型 | +| ------ | ------------------------------------------ | --------------------------- | | initd | 组件初始化后,调用的方法,返回一个地图实例 | `{ map, BmapGL, instance }` | -| unload | 组件卸载时会调用此方法 | - | +| unload | 组件卸载时会调用此方法 | - | diff --git a/docs/zh/control/zoom.md b/docs/zh/control/zoom.md index e2fb9ab6..2a87c949 100644 --- a/docs/zh/control/zoom.md +++ b/docs/zh/control/zoom.md @@ -49,7 +49,7 @@ import { Zoom } from 'vue3-baidu-map-gl' ## 组件事件 -| 事件名 | 说明 | 类型 | -| ------ | ------------------------------------------ | ----------------- | +| 事件名 | 说明 | 类型 | +| ------ | ------------------------------------------ | --------------------------- | | initd | 组件初始化后,调用的方法,返回一个地图实例 | `{ map, BmapGL, instance }` | -| unload | 组件卸载时会调用此方法 | - | +| unload | 组件卸载时会调用此方法 | - | diff --git a/docs/zh/guide/quick-start.md b/docs/zh/guide/quick-start.md index edd02e29..d4441b75 100644 --- a/docs/zh/guide/quick-start.md +++ b/docs/zh/guide/quick-start.md @@ -18,7 +18,6 @@ - 🖇️ 组件同时兼容纯净式大驼峰命名(`Map`)和短横线命名(`b-map`) - 🚀 支持 volar,组件提供完善的代码提示 - ## 安装 ### npm @@ -33,6 +32,7 @@ yarn add vue3-baidu-map-gl # or with pnpm pnpm add vue3-baidu-map-gl ``` + ### CDN 参考 [使用 CDN](/zh/guide/usage-cdn)。 diff --git a/docs/zh/hooks/useBrowserLocation.md b/docs/zh/hooks/useBrowserLocation.md index eb107a17..27824315 100644 --- a/docs/zh/hooks/useBrowserLocation.md +++ b/docs/zh/hooks/useBrowserLocation.md @@ -12,14 +12,15 @@ ## 用法 ```ts -const { get, location, isLoading, isError, status } = useBrowserLocation(options) +const { get, location, isLoading, isError, status } = useBrowserLocation(options, cal) ``` ### 参数 -| 参数 | 描述 | 类型 | 默认值 | -| ------- | ---------------- | --------------------------------------------------- | ------ | -| options | 浏览器定位配置项 | [`BrowserLocationOptions`](#browserlocationoptions) | - | +| 参数 | 描述 | 类型 | 默认值 | +| ------- | -------------------- | --------------------------------------------------- | ------ | +| options | 浏览器定位配置项 | [`BrowserLocationOptions`](#browserlocationoptions) | - | +| cal | 定位成功后的回调函数 | `(location: Ref) => void` | - | #### BrowserLocationOptions @@ -100,7 +101,9 @@ const { get, location, isLoading, isError, status } = useBrowserLocation(options import { ref } from 'vue' import { useBrowserLocation } from '../../../packages' const map = ref() - const { get, location, isLoading, isError, status } = useBrowserLocation() + const { get, location, isLoading, isError, status } = useBrowserLocation(null, () => { + map.value.resetCenter() + })