Skip to content

安装方式

BicMap 提供两种集成方式,根据你的项目类型选择合适的方案。

方式一:NPM 包(推荐)

适用于使用 Vite / Webpack 等构建工具的现代前端项目。

bash
pnpm add @x-humanoid-cloud/bic-map

安装后,依赖关系如下:

@x-humanoid-cloud/bic-map
├── maplibre-gl@3.6.2   (锁定版本)
├── three@0.149.0        (锁定版本)
└── @turf/turf@7.3.5     (锁定版本)

TIP

以上依赖已精确锁定版本并打包,无需单独安装,直接导入 BicMap 即可使用。

Vite 项目配置

vite.config.js 中无需特殊配置,开箱即用:

js
// vite.config.js
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

export default defineConfig({
  plugins: [vue()]
})

导入方式

js
// ESM 导入(推荐)
import bicMap from '@x-humanoid-cloud/bic-map'

// 按需导入工具函数
import { MapUtils } from '@x-humanoid-cloud/bic-map'

方式二:CDN Script

适用于无构建工具的传统项目,或需要快速原型验证的场景。

html
<!-- 在 </body> 前引入 -->
<script src="https://cdn.bic-map.com/bicMap.ext.min.js"></script>

CDN 包已打包所有依赖(maplibre-gl + three.js + turf),加载后全局变量 bicMap 即可使用:

js
// 全局变量直接使用
await bicMap.init()
const map = bicMap.createMap({ container: 'map', center: [116.4, 39.9], zoom: 13 })

注意事项

  • CDN 方式请勿重复引入 maplibre-gl / three.js,避免版本冲突
  • CDN 包体积较大(约 2.5 MB gzipped),建议配合 HTTP 缓存使用

版本说明

包名最新版本注册表
@x-humanoid-cloud/bic-map0.0.1私有 NPM
bash
# 配置私有 registry(仅内网环境需要)
pnpm config set @x-humanoid-cloud:registry https://maven.x-humanoid-cloud.com/repository/pnpm-hosted/