@xingm/vmap-cesium-toolbar 0.0.6 → 1.0.0

package/README.md

@@ -1,17 +1,6 @@
 # @xingm/vmap-cesium-toolbar
 
-一个功能强大的 Cesium 地图工具栏组件，提供搜索、测量、绘制、2D/3D切换、图层管理等功能。
-
-## 特性
-
-- 🗺️ **完整的地图工具栏** - 搜索、测量、绘制、图层切换等功能
-- 📏 **精确测量工具** - 支持距离、面积、高度测量
-- ✏️ **绘制功能** - 支持点、线、面绘制和编辑
-- 🔄 **2D/3D切换** - 无缝切换2D和3D视图模式
-- 🎨 **可定制样式** - 支持自定义按钮样式和布局
-- 📱 **响应式设计** - 适配不同屏幕尺寸
-- 🚀 **TypeScript支持** - 完整的类型定义
-- ⚡ **Vue 3兼容** - 原生支持Vue 3项目
+一个以 MapPlugin 为中心的 Cesium 地图工具库，重构后将 Viewer 生命周期、工具栏、覆盖物和绘制能力统一收敛到插件内核与服务层，并保留一层兼容适配器用于平滑迁移旧 API。
 
 ## 安装
 
@@ -19,258 +8,165 @@
 npm install @xingm/vmap-cesium-toolbar cesium
 ```
 
-## 快速开始
-
-### 基本使用
-
-```javascript
-import { CesiumMapToolbar, initCesium } from '@xingm/vmap-cesium-toolbar';
-import '@xingm/vmap-cesium-toolbar/style';
-
-// 初始化Cesium
-(async () => {
-  const { viewer } = await initCesium('cesiumContainer', {
-    terrainProvider: Cesium.createWorldTerrain(),
-  });
-
-  // 创建工具栏
-  const toolbar = new CesiumMapToolbar(viewer, document.getElementById('toolbar'));
-})();
-```
-
-### Vue 3 项目中使用
-
-```vue
-<template>
-  <div id="cesiumContainer"></div>
-  <div id="toolbar"></div>
-</template>
-
-<script setup>
-import { onMounted } from 'vue';
-import { CesiumMapToolbar, initCesium } from '@xingm/vmap-cesium-toolbar';
-import '@xingm/vmap-cesium-toolbar/style';
-
-let viewer;
-let toolbar;
-
-onMounted(async () => {
-  // 初始化Cesium
-  const result = await initCesium('cesiumContainer', {
-    terrainProvider: Cesium.createWorldTerrain(),
-  });
-  viewer = result.viewer;
-
-  // 创建工具栏
-  toolbar = new CesiumMapToolbar(viewer, document.getElementById('toolbar'));
+## 推荐入口
+
+新项目只推荐使用 createMapPlugin、MapPlugin 和服务层 API。
+
+```ts
+import { createMapPlugin } from '@xingm/vmap-cesium-toolbar';
+
+const mapPlugin = createMapPlugin('cesiumContainer', {
+  cesiumToken: 'your-cesium-ion-token',
+  camera: {
+    center: [116.3974, 39.9093, 1000],
+    pitch: -45,
+    heading: 0,
+  },
+  layers: {
+    type: 'tdt',
+    tdt: {
+      mapTypeId: 'img',
+      token: 'your-tianditu-token',
+      showLabel: true,
+    },
+  },
+  viewerOptions: {
+    animation: false,
+    timeline: false,
+    navigationHelpButton: false,
+  },
+  services: {
+    overlay: true,
+    draw: true,
+    toolbar: {
+      enabled: true,
+      callbacks: {
+        onSearch: async () => [],
+      },
+    },
+  },
 });
-</script>
-```
-
-## 主要组件
 
-### CesiumMapToolbar
+const viewer = await mapPlugin.initialize();
+const toolbarService = mapPlugin.getToolbarService();
+const overlayService = mapPlugin.getOverlayService();
+const drawService = mapPlugin.getDrawService();
 
-主要工具栏组件，提供完整的地图操作功能。
+drawService.startDrawing('polygon');
 
-```typescript
-const toolbar = new CesiumMapToolbar(
-  viewer,                    // Cesium Viewer实例
-  container,                 // 工具栏容器元素
-  config,                    // 配置选项（可选）
-  callbacks,                 // 回调函数（可选）
-  initialCenter              // 初始中心点（可选）
-);
+mapPlugin.updateLayers({
+  type: 'tdt',
+  tdt: {
+    mapTypeId: 'vec',
+    token: 'your-tianditu-token',
+    showLabel: true,
+  },
+});
 ```
 
-### DrawHelper
+## 重构后的公开层次
 
-绘制工具类（包的默认导出），提供线/面/矩形/圆等交互绘制能力。
+### 1. 新 API
 
-```typescript
-import DrawHelper from '@xingm/vmap-cesium-toolbar';
+- createMapPlugin
+- MapPlugin
+- ToolbarService
+- OverlayService
+- DrawService
+- Marker、Label、Icon、SVG、InfoWindow、Polyline、Polygon、Rectangle、Circle、Ring
+- HeatmapLayer、PointClusterLayer
 
-const drawHelper = new DrawHelper(viewer);
-drawHelper.startDrawingPolygon();
-```
+### 2. 类型与样式能力
 
-### initCesium
+- MapPluginOptions、ToolbarConfig、LayersConfig 等统一从顶层导出
+- i18n 与样式系统继续保留顶层导出，供组件与业务侧接入
 
-Cesium 初始化函数，简化 Viewer 创建、底图/地形与初始视角配置。
+### 3. 兼容 API
 
-```typescript
-import { initCesium } from '@xingm/vmap-cesium-toolbar';
-
-const { viewer } = await initCesium('cesiumContainer', {
-  cesiumToken: 'your_cesium_ion_token',
-});
-
-// 使用天地图时可指定底图类型（默认 imagery）
-const { viewer: tdtViewer } = await initCesium('cesiumContainer', {
-  mapType: 'tiandi',
-  tdtMapTypeId: 'terrain',
-  token: 'your_tianditu_token',
-});
-```
-
-## 配置选项
-
-### 工具栏配置
-
-```typescript
-interface ToolbarConfig {
-  position?: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left';
-  buttonSize?: number;           // 按钮大小 (默认40px)
-  buttonSpacing?: number;        // 按钮间距 (默认8px)
-  backgroundColor?: string;      // 背景色
-  borderColor?: string;          // 边框色
-  borderRadius?: number;         // 圆角半径
-  showSearch?: boolean;          // 显示搜索框
-  showMeasurement?: boolean;     // 显示测量工具
-  showDrawing?: boolean;         // 显示绘制工具
-  showLayerControl?: boolean;    // 显示图层控制
-  show2D3DToggle?: boolean;      // 显示2D/3D切换
-}
-```
+以下导出仍保留，但定位是迁移适配层，不再是推荐入口：
 
-### 回调函数
+- initCesium
+- CesiumMapToolbar
+- CesiumOverlayService
+- DrawHelper
 
-```typescript
-interface ToolbarCallbacks {
-  search?: (query: string) => void;
-  measurement?: (type: string, result: any) => void;
-  drawing?: (type: string, entity: Entity) => void;
-  zoom?: (level: number) => void;
-}
-```
+## 迁移建议
 
-## 功能说明
+建议按下面顺序逐步迁移旧业务。
 
-### 搜索功能
+1. 用 createMapPlugin(...).initialize() 替代 initCesium(...)
+2. 用 services.toolbar 或 mapPlugin.getToolbarService() 替代直接构造 CesiumMapToolbar
+3. 用 mapPlugin.getOverlayService() 替代直接维护 CesiumOverlayService 生命周期
+4. 用 mapPlugin.getDrawService() 替代 DrawHelper 的直接持有
+5. 仅在过渡窗口内保留 compat 导出
 
-支持路网搜索和坐标定位：
+### 旧写法
 
-```javascript
-// 搜索回调
-const callbacks = {
-  search: (query) => {
-    console.log('搜索:', query);
-    // 实现搜索逻辑
-  }
-};
+```ts
+import { initCesium, CesiumMapToolbar } from '@xingm/vmap-cesium-toolbar';
 ```
 
-### 测量工具
-
-支持多种测量类型：
+### 新写法
 
-- **距离测量** - 测量两点间距离
-- **面积测量** - 测量多边形面积
-- **高度测量** - 测量点的高度信息
-
-```javascript
-// 测量回调
-const callbacks = {
-  measurement: (type, result) => {
-    console.log('测量结果:', type, result);
-  }
-};
+```ts
+import { createMapPlugin } from '@xingm/vmap-cesium-toolbar';
 ```
 
-### 绘制功能
+## Vue 3 示例
 
-支持多种绘制类型：
+```vue
+<template>
+  <div id="cesiumContainer" style="width: 100%; height: 100vh"></div>
+</template>
 
-- **点绘制** - 在地图上标记点
-- **线绘制** - 绘制线条
-- **面绘制** - 绘制多边形区域
+<script setup lang="ts">
+import { onMounted, onBeforeUnmount } from 'vue';
+import { createMapPlugin } from '@xingm/vmap-cesium-toolbar';
 
-```javascript
-// 绘制回调
-const callbacks = {
-  drawing: (type, entity) => {
-    console.log('绘制完成:', type, entity);
-  }
-};
-```
+let mapPlugin: ReturnType<typeof createMapPlugin> | null = null;
 
-## 样式定制
+onMounted(async () => {
+  mapPlugin = createMapPlugin('cesiumContainer', {
+    camera: {
+      center: [116.3974, 39.9093, 1000],
+      pitch: -45,
+    },
+    layers: {
+      type: 'tdt',
+      tdt: {
+        mapTypeId: 'img',
+        token: 'your-tianditu-token',
+      },
+    },
+    services: {
+      toolbar: { enabled: true },
+      overlay: true,
+      draw: true,
+    },
+  });
 
-组件提供了完整的CSS变量支持，可以轻松定制样式：
+  await mapPlugin.initialize();
+});
 
-```css
-:root {
-  --toolbar-bg-color: #ffffff;
-  --toolbar-border-color: #e0e0e0;
-  --toolbar-button-size: 40px;
-  --toolbar-button-spacing: 8px;
-  --toolbar-border-radius: 4px;
-}
+onBeforeUnmount(() => {
+  mapPlugin?.destroy();
+});
+</script>
 ```
 
-## 示例项目
+## 文档入口
 
-### 基本使用示例
+- 架构说明：doc/guide/Architecture.md
+- 迁移指南：doc/guide/Migration_Guide.md
+- API 目录：doc/api/index.md
 
-```bash
-# 克隆项目
-git clone https://github.com/your-username/vmap-cesium-toolbar.git
-cd vmap-cesium-toolbar
-
-# 查看基本示例
-cd examples/basic-usage
-# 在浏览器中打开 index.html
-```
+说明：当前文档站已优先切换为“新架构说明 + 兼容 API 参考”的组织方式，新的逐个 API 页面会继续补齐。
 
-### Vue 3 示例
+## 开发命令
 
 ```bash
-cd examples/vue3-usage
-npm install
-npm run dev
+pnpm run build:plugin
+pnpm run type-check
+pnpm run docs:dev
+pnpm run docs:build
 ```
-
-## API 文档
-
-详细的API文档请参考：
-
-- [CesiumMapToolbar API](./doc/CesiumMapToolbar_API.md)
-- [CesiumMapHelper API](./doc/CesiumMapHelper_API.md)
-- [CesiumMapLoader API](./doc/CesiumMapLoader_API.md)
-- [CesiumOverlayService API](./doc/CesiumOverlayService_API.md)
-
-## 依赖要求
-
-- **Cesium**: ^1.100.0
-- **Vue**: ^3.0.0 (可选，用于Vue项目)
-
-## 浏览器支持
-
-- Chrome 60+
-- Firefox 55+
-- Safari 12+
-- Edge 79+
-
-## 许可证
-
-MIT License
-
-## 贡献
-
-欢迎提交 Issue 和 Pull Request！
-
-## 更新日志
-
-### v0.0.1-beta.2
-
-- 新增高度测量功能
-- 优化标签显示逻辑
-- 修复3D模式下标签位置问题
-- 改进绘制工具的用户体验
-
-### v0.0.1-beta.1
-
-- 初始版本发布
-- 基础工具栏功能
-- 搜索、测量、绘制功能
-- Vue 3 支持

package/dist/README.md

@@ -0,0 +1,172 @@
+# @xingm/vmap-cesium-toolbar
+
+一个以 MapPlugin 为中心的 Cesium 地图工具库，重构后将 Viewer 生命周期、工具栏、覆盖物和绘制能力统一收敛到插件内核与服务层，并保留一层兼容适配器用于平滑迁移旧 API。
+
+## 安装
+
+```bash
+npm install @xingm/vmap-cesium-toolbar cesium
+```
+
+## 推荐入口
+
+新项目只推荐使用 createMapPlugin、MapPlugin 和服务层 API。
+
+```ts
+import { createMapPlugin } from '@xingm/vmap-cesium-toolbar';
+
+const mapPlugin = createMapPlugin('cesiumContainer', {
+  cesiumToken: 'your-cesium-ion-token',
+  camera: {
+    center: [116.3974, 39.9093, 1000],
+    pitch: -45,
+    heading: 0,
+  },
+  layers: {
+    type: 'tdt',
+    tdt: {
+      mapTypeId: 'img',
+      token: 'your-tianditu-token',
+      showLabel: true,
+    },
+  },
+  viewerOptions: {
+    animation: false,
+    timeline: false,
+    navigationHelpButton: false,
+  },
+  services: {
+    overlay: true,
+    draw: true,
+    toolbar: {
+      enabled: true,
+      callbacks: {
+        onSearch: async () => [],
+      },
+    },
+  },
+});
+
+const viewer = await mapPlugin.initialize();
+const toolbarService = mapPlugin.getToolbarService();
+const overlayService = mapPlugin.getOverlayService();
+const drawService = mapPlugin.getDrawService();
+
+drawService.startDrawing('polygon');
+
+mapPlugin.updateLayers({
+  type: 'tdt',
+  tdt: {
+    mapTypeId: 'vec',
+    token: 'your-tianditu-token',
+    showLabel: true,
+  },
+});
+```
+
+## 重构后的公开层次
+
+### 1. 新 API
+
+- createMapPlugin
+- MapPlugin
+- ToolbarService
+- OverlayService
+- DrawService
+- Marker、Label、Icon、SVG、InfoWindow、Polyline、Polygon、Rectangle、Circle、Ring
+- HeatmapLayer、PointClusterLayer
+
+### 2. 类型与样式能力
+
+- MapPluginOptions、ToolbarConfig、LayersConfig 等统一从顶层导出
+- i18n 与样式系统继续保留顶层导出，供组件与业务侧接入
+
+### 3. 兼容 API
+
+以下导出仍保留，但定位是迁移适配层，不再是推荐入口：
+
+- initCesium
+- CesiumMapToolbar
+- CesiumOverlayService
+- DrawHelper
+
+## 迁移建议
+
+建议按下面顺序逐步迁移旧业务。
+
+1. 用 createMapPlugin(...).initialize() 替代 initCesium(...)
+2. 用 services.toolbar 或 mapPlugin.getToolbarService() 替代直接构造 CesiumMapToolbar
+3. 用 mapPlugin.getOverlayService() 替代直接维护 CesiumOverlayService 生命周期
+4. 用 mapPlugin.getDrawService() 替代 DrawHelper 的直接持有
+5. 仅在过渡窗口内保留 compat 导出
+
+### 旧写法
+
+```ts
+import { initCesium, CesiumMapToolbar } from '@xingm/vmap-cesium-toolbar';
+```
+
+### 新写法
+
+```ts
+import { createMapPlugin } from '@xingm/vmap-cesium-toolbar';
+```
+
+## Vue 3 示例
+
+```vue
+<template>
+  <div id="cesiumContainer" style="width: 100%; height: 100vh"></div>
+</template>
+
+<script setup lang="ts">
+import { onMounted, onBeforeUnmount } from 'vue';
+import { createMapPlugin } from '@xingm/vmap-cesium-toolbar';
+
+let mapPlugin: ReturnType<typeof createMapPlugin> | null = null;
+
+onMounted(async () => {
+  mapPlugin = createMapPlugin('cesiumContainer', {
+    camera: {
+      center: [116.3974, 39.9093, 1000],
+      pitch: -45,
+    },
+    layers: {
+      type: 'tdt',
+      tdt: {
+        mapTypeId: 'img',
+        token: 'your-tianditu-token',
+      },
+    },
+    services: {
+      toolbar: { enabled: true },
+      overlay: true,
+      draw: true,
+    },
+  });
+
+  await mapPlugin.initialize();
+});
+
+onBeforeUnmount(() => {
+  mapPlugin?.destroy();
+});
+</script>
+```
+
+## 文档入口
+
+- 架构说明：doc/guide/Architecture.md
+- 迁移指南：doc/guide/Migration_Guide.md
+- API 目录：doc/api/index.md
+
+说明：当前文档站已优先切换为“新架构说明 + 兼容 API 参考”的组织方式，新的逐个 API 页面会继续补齐。
+
+## 开发命令
+
+```bash
+pnpm run build:plugin
+pnpm run type-check
+pnpm run docs:dev
+pnpm run docs:build
+```