This commit is contained in:
@@ -1,6 +1,8 @@
|
||||
# SGS Map SDK 快速接入指南
|
||||
|
||||
> 版本: V2.3.0 | 支持终端: H5 浏览器、大屏终端、微信小程序
|
||||
> 本项目同步版本: V2.5.0 | 支持终端: H5 浏览器、大屏终端、微信小程序
|
||||
|
||||
> 发布源保留了 V2.3.0 文档标题和历史 API 注释;实际发行版本以 `package.json` 与 `dist` 产物自报的 2.5.0 为准。本文只同步其公开接入资料,不声明未经本项目验证的 iframe renderer 能力。
|
||||
|
||||
## 1. 引入方式
|
||||
|
||||
@@ -18,7 +20,7 @@ SDK 提供多种模块规范的产出文件,适配不同的应用场景:
|
||||
如果 SDK 已由 `sgs-frontend-map` 发布到前端静态目录,也可以直接使用浏览器发布文件:
|
||||
|
||||
```html
|
||||
<script src="/sdk/sgs-map-sdk.min.js?v=2.3.0"></script>
|
||||
<script src="/sdk/sgs-map-sdk.min.js?v=2.5.0"></script>
|
||||
```
|
||||
|
||||
### 1.2 ESM Import (Webpack / Vite / Next.js)
|
||||
@@ -33,7 +35,7 @@ const sdk = new SGSMapSDK({ ... });
|
||||
在微信小程序中,无需引入外壳 SDK,直接通过 `web-view` 组件加载地图基座,并通过 URL 传递参数。
|
||||
```html
|
||||
<!-- 小程序 WXML -->
|
||||
<web-view src="https://map.museum.com/h5-sdk?floorId=1&mode=miniapp"></web-view>
|
||||
<web-view src="https://map.museum.com/engine/index.html?floorId=1&mode=miniapp"></web-view>
|
||||
```
|
||||
|
||||
### 1.4 渲染基座地址
|
||||
@@ -41,7 +43,7 @@ const sdk = new SGSMapSDK({ ... });
|
||||
SDK 通过 `sdkUrl` 连接独立渲染基座。正式接入时请使用地图服务平台管理员提供的基座地址,例如:
|
||||
|
||||
```text
|
||||
https://map.museum.com/h5-sdk
|
||||
https://map.museum.com/engine/index.html
|
||||
```
|
||||
|
||||
发布包内附带 `demo/` 目录,是一个完整的 SDK 能力展示页面。运行方式:
|
||||
@@ -61,7 +63,7 @@ npx -y serve . -l 5555
|
||||
```javascript
|
||||
const map = new SGSMapSDK({
|
||||
container: 'map-container', // 挂载的 DOM 容器 ID
|
||||
sdkUrl: 'https://map.museum.com/h5-sdk', // 渲染基座的 URL
|
||||
sdkUrl: 'https://map.museum.com/engine/index.html', // 独立渲染引擎 URL
|
||||
targetOrigin: 'https://map.museum.com', // [重要] 安全防范,配置只允许该域名通信
|
||||
floorId: 1, // 初始楼层 ID
|
||||
timeout: 5000 // API 调用的默认超时时间(毫秒)
|
||||
|
||||
Reference in New Issue
Block a user