update docs

This commit is contained in:
ethan 2024-03-06 11:24:05 +08:00
parent 9c7bed51c8
commit f81cc61e4b
2 changed files with 32 additions and 15 deletions

View File

@ -1,12 +1,11 @@
# CesiumDraw
cesium绘制插件
cesium 绘制插件
![image](https://github.com/ethan-zf/CesiumDraw/assets/19545189/75b93c62-dd10-4c92-825c-c4ab01b454a7)
在线示例:[demo](https://ethan-zf.github.io/CesiumDraw/examples/index.html)
### 类
| 类名 | 类型 | 描述 |
@ -30,16 +29,20 @@ cesium绘制插件
| Ellipse | 'polygon' | 椭圆 |
| Lune | 'polygon' | 半月面 |
```
const geometry = new CesiumPlot.Polygon(Cesium, viewer);
```
### 类的实例方法
| 方法名 | 参数 | 描述 |
| ----------- | -------------------------------------- | -------- |
| hide | | 隐藏 |
| show | | 显示 |
| remove | | 删除 |
| addEvent | (event: EventType, listener: Function) | 绑定事件 |
| removeEvent | (event: EventType) | 解绑事件 |
| 方法名 | 参数 | 描述 |
| ------ | ------------------------------------------------------- | -------- |
| hide | | 隐藏 |
| show | | 显示 |
| remove | | 删除 |
| on | (event: EventType, listener: (eventData?: any) => void) | 绑定事件 |
| off | (event: EventType) | 解绑事件 |
### 事件
@ -47,13 +50,27 @@ cesium绘制插件
绘制开始
```
geometry.on('drawStart', () => {
console.log('draw start');
});
```
- 'drawUpdate'
绘制过程中点位更新
绘制过程中点位更新,回调事件返回更新的 Cartesian3 点位
```
geometry.on('drawUpdate', () => {
console.log('draw start');
});
```
- 'drawEnd'
绘制结束
绘制结束,回调事件返回图形的关键点位
- 'editStart'
@ -61,4 +78,4 @@ cesium绘制插件
- 'editEnd'
编辑结束
编辑结束,回调事件返回图形的关键点位

View File

@ -110,7 +110,7 @@ export default class Base {
this.removeControlPoints();
this.disableDrag();
// Trigger 'drawEnd' and return the geometry shape points when exiting the edit mode.
this.eventDispatcher.dispatchEvent('drawEnd', this.getPoints());
this.eventDispatcher.dispatchEvent('editEnd', this.getPoints());
}
} else if (this.state === 'static') {
//When drawing multiple shapes, the click events for all shapes are triggered. Only when hitting a completed shape should it enter editing mode.