@vsleem-realsee-viewer/dualsee-plugin 2.0.6 → 2.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -8,145 +8,153 @@
8
8
 
9
9
  ### DualseeProps 参数说明
10
10
 
11
- | 参数名 | 类型 | 必填 | 说明 |
12
- | --------------------- | ---------------- | ---- | ---------------- |
13
- | `appSetting` | `AppSetting` | | 全局设置 |
14
- | `dualseeSetting` | `DualseeSetting` | | 双重场景配置 |
15
- | `dualseeLock` | `LockProps` | | 双重场景锁配置 |
16
- | `basicRealsee` | `RealseeProps` | | 基础全景 |
17
- | `referRealsee` | `RealseeProps` | | 对比全景 |
18
- | `referBimsee` | `BimseeProps` | | 对比BIM |
19
- | `dualseeLockVisible` | `boolean` | | 锁是否可见 |
20
- | `referRealseeVisible` | `boolean` | | 对比全景是否可见 |
21
- | `referBimseeVisible` | `boolean` | | 对比BIM是否可见 |
11
+ | 参数名 | 类型 | 默认值 | 说明 |
12
+ | ---------------------- | ---------------- | ------------------------------ | ---------------- |
13
+ | `appSetting` | `AppSetting` | 请查看AppSetting类型默认值 | 全局设置 |
14
+ | `dualseeSetting?` | `DualseeSetting` | 请查看DualseeSetting类型默认值 | 双重场景配置 |
15
+ | `dualseeLock?` | `LockProps` | 请查看LockProps类型默认值 | 双重场景锁配置 |
16
+ | `basicRealsee` | `RealseeProps` | - | 基础全景 |
17
+ | `referRealsee?` | `RealseeProps` | - | 对比全景 |
18
+ | `referBimsee?` | `BimseeProps` | - | 对比BIM |
19
+ | `dualseeLockVisible?` | `boolean` | false | 锁是否可见 |
20
+ | `referRealseeVisible?` | `boolean` | false | 对比全景是否可见 |
21
+ | `referBimseeVisible?` | `boolean` | false | 对比BIM是否可见 |
22
22
 
23
23
  ### DualseeSetting 类型说明
24
24
 
25
- | 参数名 | 类型 | 必填 | 说明 |
26
- | ------------------ | --------- | ---- | -------------------------------- |
27
- | `enableMatchPoint` | `boolean` | | 是否开启点匹配(默认true) |
28
- | `maxMatchDistance` | `number` | | 匹配点最大距离(毫米,默认5000) |
25
+ | 参数名 | 类型 | 默认值 | 说明 |
26
+ | ------------------ | --------- | ------ | -------------------------- |
27
+ | `enableMatchPoint` | `boolean` | true | 是否开启点匹配 |
28
+ | `maxMatchDistance` | `number` | 5000 | 匹配点最大距离(单位毫米) |
29
29
 
30
30
  ### DualseeElement 实例对象
31
31
 
32
- | 方法/属性 | 类型签名 | 说明 |
32
+ | 属性/方法 | 类型/签名 | 说明 |
33
33
  | ---------------------- | --------------------------------------------------- | ------------------------ |
34
34
  | `getState` | `() => UpdatableDualseeProps` | 获取当前配置选项 |
35
35
  | `setState` | `(options: Partial<UpdatableDualseeProps>) => void` | 设置配置选项 |
36
- | `getDualseeLock` | `() => LockElement \| undefined` | 获取锁元素引用 |
37
- | `getBasicRealsee` | `() => RealseeElement \| undefined` | 获取基础全景元素引用 |
38
- | `getReferRealsee` | `() => RealseeElement \| undefined` | 获取对比全景元素引用 |
39
- | `getReferBimsee` | `() => BimseeElement \| undefined` | 获取对比BIM元素引用 |
36
+ | `getDualseeLock` | `() => LockElement \ undefined` | 获取锁元素引用 |
37
+ | `getBasicRealsee` | `() => RealseeElement \ undefined` | 获取基础全景元素引用 |
38
+ | `getReferRealsee` | `() => RealseeElement \ undefined` | 获取对比全景元素引用 |
39
+ | `getReferBimsee` | `() => BimseeElement \ undefined` | 获取对比BIM元素引用 |
40
40
  | `toggleReferRealsee` | `() => void` | 切换对比全景显示状态 |
41
41
  | `showReferRealsee` | `() => void` | 显示对比全景 |
42
42
  | `hideReferRealsee` | `() => void` | 隐藏对比全景 |
43
43
  | `toggleReferBimsee` | `() => void` | 切换Bimsee面全景显示状态 |
44
44
  | `showReferBimsee` | `() => Promise<void>` | 显示Bimsee面全景 |
45
45
  | `hideReferBimsee` | `() => void` | 隐藏Bimsee面全景 |
46
- | `setReferClosestPoint` | `(current: TrackPoint) => void` | 设置到对比视图最近的点 |
46
+ | `setReferRealseePoint` | `(current: TrackPoint) => void` | 设置对比视图的点 |
47
+ | `setReferBimseePoint` | `(current: TrackPoint) => void` | 设置对比BIM的点 |
47
48
 
48
49
  ### DualseeEvents 事件说明
49
50
 
50
- | 事件名称 | 描述 | 参数类型 |
51
- | -------------------------------- | ---------------------- | ------------------------------- |
52
- | `find-refer-closest-point` | 查找对比最近点 | (point?:TrackPoint)=>void |
53
- | `basic-ready` | 基础场景就绪 | () => void |
54
- | `basic-change-model` | 基础场景切换模型 | (model: Coordinate) => void |
55
- | `basic-change-record` | 基础场景切换记录 | (record: TrackRecord) => void |
56
- | `basic-change-point` | 基础场景切换点位 | (point: TrackPoint) => void |
57
- | `basic-map-ready` | 基础地图就绪 | () => void |
58
- | `basic-map-resize` | 基础地图大小改变 | () => void |
59
- | `basic-map-collapse` | 基础地图折叠状态改变 | (value: number) => void |
60
- | `basic-map-dragger` | 基础地图拖拽 | () => void |
61
- | `basic-map-select-point` | 基础地图选择点位 | (point: TrackPoint) => void |
62
- | `basic-map-angle-updated` | 基础地图角度更新 | (value: number) => void |
63
- | `basic-viewer-ready` | 基础查看器就绪 | () => void |
64
- | `basic-viewer-click` | 基础查看器点击 | (e: any) => void |
65
- | `basic-viewer-mousedown` | 基础查看器鼠标按下 | (e: any) => void |
66
- | `basic-viewer-zoom-updated` | 基础查看器缩放更新 | (e: any) => void |
67
- | `basic-viewer-position-updated` | 基础查看器位置更新 | (e: any) => void |
68
- | `basic-viewer-panorama-loaded` | 基础全景图加载完成 | (e: any) => void |
69
- | `basic-viewer-select-point` | 基础查看器选择点位 | (point: TrackPoint) => void |
70
- | `basic-viewer-select-marker` | 基础查看器选择标记 | (point: TrackPoint) => void |
71
- | `basic-playbar-ready` | 基础播放条就绪 | () => void |
72
- | `basic-playbar-backward` | 基础播放条后退 | (value: number) => void |
73
- | `basic-playbar-pause` | 基础播放条暂停 | (value: number) => void |
74
- | `basic-playbar-play` | 基础播放条播放 | (value: number) => void |
75
- | `basic-playbar-forward` | 基础播放条前进 | (value: number) => void |
76
- | `basic-playbar-slider` | 基础播放条滑块拖动 | (value: number) => void |
77
- | `basic-playbar-speed-updated` | 基础播放条速度更新 | (speed: number) => void |
78
- | `basic-playbar-delay-updated` | 基础播放条延迟更新 | (delay: number) => void |
79
- | `basic-playbar-step-updated` | 基础播放条步进更新 | (step: number) => void |
80
- | `basic-playbar-select-point` | 基础播放条选择点位 | (point: TrackPoint) => void |
81
- | `refer-ready` | 对比场景就绪 | () => void |
82
- | `refer-change-model` | 对比场景切换模型 | (model: Coordinate) => void |
83
- | `refer-change-record` | 对比场景切换记录 | (record: TrackRecord) => void |
84
- | `refer-change-point` | 对比场景切换点位 | (point: TrackPoint) => void |
85
- | `refer-map-ready` | 对比地图就绪 | () => void |
86
- | `refer-map-resize` | 对比地图大小改变 | () => void |
87
- | `refer-map-collapse` | 对比地图折叠状态改变 | (value: number) => void |
88
- | `refer-map-dragger` | 对比地图拖拽 | () => void |
89
- | `refer-map-select-point` | 对比地图选择点位 | (point: TrackPoint) => void |
90
- | `refer-map-angle-updated` | 对比地图角度更新 | (value: number) => void |
91
- | `refer-viewer-ready` | 对比查看器就绪 | () => void |
92
- | `refer-viewer-click` | 对比查看器点击 | (e: any) => void |
93
- | `refer-viewer-mousedown` | 对比查看器鼠标按下 | (e: any) => void |
94
- | `refer-viewer-zoom-updated` | 对比查看器缩放更新 | (e: any) => void |
95
- | `refer-viewer-position-updated` | 对比查看器位置更新 | (e: any) => void |
96
- | `refer-viewer-panorama-loaded` | 对比全景图加载完成 | (e: any) => void |
97
- | `refer-viewer-select-point` | 对比查看器选择点位 | (point: TrackPoint) => void |
98
- | `refer-viewer-select-marker` | 对比查看器选择标记 | (point: TrackPoint) => void |
99
- | `refer-playbar-ready` | 对比播放条就绪 | () => void |
100
- | `refer-playbar-backward` | 对比播放条后退 | (value: number) => void |
101
- | `refer-playbar-pause` | 对比播放条暂停 | (value: number) => void |
102
- | `refer-playbar-play` | 对比播放条播放 | (value: number) => void |
103
- | `refer-playbar-forward` | 对比播放条前进 | (value: number) => void |
104
- | `refer-playbar-slider` | 对比播放条滑块拖动 | (index: number) => void |
105
- | `refer-playbar-speed-updated` | 对比播放条速度更新 | (speed : number) => void |
106
- | `refer-playbar-delay-updated` | 对比播放条延迟更新 | (delay: number) => void |
107
- | `refer-playbar-step-updated` | 对比播放条步进更新 | (step : number) => void |
108
- | `refer-playbar-select-point` | 对比播放条选择点位 | (point: TrackPoint) => void |
109
- | `lock-locked-updated` | 锁定状态更新 | (distance: number)=>void |
110
- | `lock-distance-updated` | 锁定距离更新 | (locked: boolean)=> void |
111
- | `bimsee-ready` | 组件就绪 | () => void |
112
- | `bimsee-change-model` | 切换模型 | (model: Coordinate) => void |
113
- | `bimsee-masker-ready` | BIM查看器就绪 | (e: any) => void |
114
- | `bimsee-masker-click` | BIM查看器点击 | (e: any) => void |
115
- | `bimsee-masker-mousedown` | BIM查看器鼠标按下 | (e: any) => void |
116
- | `bimsee-viewerzoom-updated` | BIM查看器缩放更新 | (e: any) => void |
117
- | `bimsee-masker-position-updated` | BIM查看器位置更新 | (e: any) => void |
118
- | `bimsee-masker-point-updated` | 设置全景图的坐标点事件 | (state?: CameraStatus ) => void |
51
+ | 事件名称 | 参数类型 | 描述 |
52
+ | -------------------------------- | --------------------------------- | -------------------- |
53
+ | `find-refer-realsee-point` | `(point?:TrackPoint)=>void` | 查找对比视图的点 |
54
+ | `find-refer-bimsee-point` | `(point?:TrackPoint)=>void` | 查找BIM视图的点 |
55
+ | `basic-ready` | `() => void` | 基础场景就绪 |
56
+ | `basic-change-model` | `(model: Coordinate) => void` | 基础场景切换模型 |
57
+ | `basic-change-record` | `(record: TrackRecord) => void` | 基础场景切换记录 |
58
+ | `basic-change-point` | `(point: TrackPoint) => void` | 基础场景切换点位 |
59
+ | `basic-map-ready` | `() => void` | 基础地图就绪 |
60
+ | `basic-map-resize` | `() => void` | 基础地图大小改变 |
61
+ | `basic-map-collapse` | `(value: number) => void` | 基础地图折叠状态改变 |
62
+ | `basic-map-dragger` | `() => void` | 基础地图拖拽 |
63
+ | `basic-map-select-point` | `(point: TrackPoint) => void` | 基础地图选择点位 |
64
+ | `basic-map-angle-updated` | `(value: number) => void` | 基础地图角度更新 |
65
+ | `basic-viewer-ready` | `() => void` | 基础查看器就绪 |
66
+ | `basic-viewer-click` | `(e: any) => void` | 基础查看器点击 |
67
+ | `basic-viewer-mousedown` | `(e: any) => void` | 基础查看器鼠标按下 |
68
+ | `basic-viewer-zoom-updated` | `(e: any) => void` | 基础查看器缩放更新 |
69
+ | `basic-viewer-position-updated` | `(e: any) => void` | 基础查看器位置更新 |
70
+ | `basic-viewer-panorama-loaded` | `(e: any) => void` | 基础全景图加载完成 |
71
+ | `basic-viewer-select-point` | `(point: TrackPoint) => void` | 基础查看器选择点位 |
72
+ | `basic-viewer-select-marker` | `(point: TrackPoint) => void` | 基础查看器选择标记 |
73
+ | `basic-playbar-ready` | `() => void` | 基础播放条就绪 |
74
+ | `basic-playbar-backward` | `(value: number) => void` | 基础播放条后退 |
75
+ | `basic-playbar-pause` | `(value: number) => void` | 基础播放条暂停 |
76
+ | `basic-playbar-play` | `(value: number) => void` | 基础播放条播放 |
77
+ | `basic-playbar-forward` | `(value: number) => void` | 基础播放条前进 |
78
+ | `basic-playbar-slider` | `(value: number) => void` | 基础播放条滑块拖动 |
79
+ | `basic-playbar-speed-updated` | `(speed: number) => void` | 基础播放条速度更新 |
80
+ | `basic-playbar-delay-updated` | `(delay: number) => void` | 基础播放条延迟更新 |
81
+ | `basic-playbar-step-updated` | `(step: number) => void` | 基础播放条步进更新 |
82
+ | `basic-playbar-select-point` | `(point: TrackPoint) => void` | 基础播放条选择点位 |
83
+ | `refer-ready` | `() => void` | 对比场景就绪 |
84
+ | `refer-change-model` | `(model: Coordinate) => void` | 对比场景切换模型 |
85
+ | `refer-change-record` | `(record: TrackRecord) => void` | 对比场景切换记录 |
86
+ | `refer-change-point` | `(point: TrackPoint) => void` | 对比场景切换点位 |
87
+ | `refer-map-ready` | `() => void` | 对比地图就绪 |
88
+ | `refer-map-resize` | `() => void` | 对比地图大小改变 |
89
+ | `refer-map-collapse` | `(value: number) => void` | 对比地图折叠状态改变 |
90
+ | `refer-map-dragger` | `() => void` | 对比地图拖拽 |
91
+ | `refer-map-select-point` | `(point: TrackPoint) => void` | 对比地图选择点位 |
92
+ | `refer-map-angle-updated` | `(value: number) => void` | 对比地图角度更新 |
93
+ | `refer-viewer-ready` | `() => void` | 对比查看器就绪 |
94
+ | `refer-viewer-click` | `(e: any) => void` | 对比查看器点击 |
95
+ | `refer-viewer-mousedown` | `(e: any) => void` | 对比查看器鼠标按下 |
96
+ | `refer-viewer-zoom-updated` | `(e: any) => void` | 对比查看器缩放更新 |
97
+ | `refer-viewer-position-updated` | `(e: any) => void` | 对比查看器位置更新 |
98
+ | `refer-viewer-panorama-loaded` | `(e: any) => void` | 对比全景图加载完成 |
99
+ | `refer-viewer-select-point` | `(point: TrackPoint) => void` | 对比查看器选择点位 |
100
+ | `refer-viewer-select-marker` | `(point: TrackPoint) => void` | 对比查看器选择标记 |
101
+ | `refer-playbar-ready` | `() => void` | 对比播放条就绪 |
102
+ | `refer-playbar-backward` | `(value: number) => void` | 对比播放条后退 |
103
+ | `refer-playbar-pause` | `(value: number) => void` | 对比播放条暂停 |
104
+ | `refer-playbar-play` | `(value: number) => void` | 对比播放条播放 |
105
+ | `refer-playbar-forward` | `(value: number) => void` | 对比播放条前进 |
106
+ | `refer-playbar-slider` | `(index: number) => void` | 对比播放条滑块拖动 |
107
+ | `refer-playbar-speed-updated` | `(speed : number) => void` | 对比播放条速度更新 |
108
+ | `refer-playbar-delay-updated` | `(delay: number) => void` | 对比播放条延迟更新 |
109
+ | `refer-playbar-step-updated` | `(step : number) => void` | 对比播放条步进更新 |
110
+ | `refer-playbar-select-point` | `(point: TrackPoint) => void` | 对比播放条选择点位 |
111
+ | `lock-locked-updated` | `(distance: number)=>void` | 锁状态更新 |
112
+ | `lock-distance-updated` | `(locked: boolean)=> void` | 锁距离更新 |
113
+ | `bimsee-ready` | `() => void` | BIM组件就绪 |
114
+ | `bimsee-change-model` | `(model: Coordinate) => void` | BIM切换模型 |
115
+ | `bimsee-masker-ready` | `(e: any) => void` | BIM蒙层就绪 |
116
+ | `bimsee-masker-click` | `(e: any) => void` | BIM蒙层点击 |
117
+ | `bimsee-masker-mousedown` | `(e: any) => void` | BIM蒙层鼠标按下 |
118
+ | `bimsee-viewerzoom-updated` | `(e: any) => void` | BIM蒙层缩放更新 |
119
+ | `bimsee-masker-position-updated` | `(e: any) => void` | BIM蒙层位置更新 |
120
+ | `bimsee-masker-point-loaded` | `(state?: CameraStatus ) => void` | BIM蒙层的坐标点事件 |
119
121
 
120
122
  ### Dualsee Slot 插槽说明
121
123
 
122
- | 插槽名称 | 描述 | 参数类型 |
123
- | --------------------- | ---------------------- | -------------- |
124
- | `lockButton` | 同步锁按钮插槽 | (slot) => void |
125
- | `lockDistance` | 同步锁距离显示插槽 | (slot) => void |
126
- | `basicDefault` | 主视图默认插槽 | (slot) => void |
127
- | `basicMapDefault` | 主视图地图默认插槽 | (slot) => void |
128
- | `basicMapExtra` | 主视图地图额外插槽 | (slot) => void |
129
- | `basicMapLeft` | 主视图地图左侧插槽 | (slot) => void |
130
- | `basicMapRight` | 主视图地图右侧插槽 | (slot) => void |
131
- | `basicPlaybarDefault` | 主视图播放条默认插槽 | (slot) => void |
132
- | `basicPlaybarBox` | 主视图播放条容器插槽 | (slot) => void |
133
- | `basicPlaybarButton` | 主视图播放条按钮插槽 | (slot) => void |
134
- | `basicPlaybarCaption` | 主视图播放条标题插槽 | (slot) => void |
135
- | `basicPlaybarSlider` | 主视图播放条滑块插槽 | (slot) => void |
136
- | `referDefault` | 对比视图默认插槽 | (slot) => void |
137
- | `referMapDefault` | 对比视图地图默认插槽 | (slot) => void |
138
- | `referMapExtra` | 对比视图地图额外插槽 | (slot) => void |
139
- | `referMapLeft` | 对比视图地图左侧插槽 | (slot) => void |
140
- | `referMapRight` | 对比视图地图右侧插槽 | (slot) => void |
141
- | `referPlaybarDefault` | 对比视图播放条默认插槽 | (slot) => void |
142
- | `referPlaybarBox` | 对比视图播放条容器插槽 | (slot) => void |
143
- | `referPlaybarButton` | 对比视图播放条按钮插槽 | (slot) => void |
144
- | `referPlaybarCaption` | 对比视图播放条标题插槽 | (slot) => void |
145
- | `referPlaybarSlider` | 对比视图播放条滑块插槽 | (slot) => void |
146
- | `bimseeDefault` | 对比BIM视图默认插槽 | (slot) => void |
147
- | `default` | 组件默认插槽 | (slot) => void |
124
+ | 插槽名称 | 参数类型 | 描述 |
125
+ | --------------------- | ---------------- | ---------------------- |
126
+ | `lockButton` | `(slot) => void` | 同步锁按钮插槽 |
127
+ | `lockDistance` | `(slot) => void` | 同步锁距离显示插槽 |
128
+ | `basicDefault` | `(slot) => void` | 主视图默认插槽 |
129
+ | `basicMapDefault` | `(slot) => void` | 主视图地图默认插槽 |
130
+ | `basicMapExtra` | `(slot) => void` | 主视图地图额外插槽 |
131
+ | `basicMapLeft` | `(slot) => void` | 主视图地图左侧插槽 |
132
+ | `basicMapRight` | `(slot) => void` | 主视图地图右侧插槽 |
133
+ | `basicPlaybarDefault` | `(slot) => void` | 主视图播放条默认插槽 |
134
+ | `basicPlaybarBox` | `(slot) => void` | 主视图播放条容器插槽 |
135
+ | `basicPlaybarButton` | `(slot) => void` | 主视图播放条按钮插槽 |
136
+ | `basicPlaybarCaption` | `(slot) => void` | 主视图播放条标题插槽 |
137
+ | `basicPlaybarSlider` | `(slot) => void` | 主视图播放条滑块插槽 |
138
+ | `referDefault` | `(slot) => void` | 对比视图默认插槽 |
139
+ | `referMapDefault` | `(slot) => void` | 对比视图地图默认插槽 |
140
+ | `referMapExtra` | `(slot) => void` | 对比视图地图额外插槽 |
141
+ | `referMapLeft` | `(slot) => void` | 对比视图地图左侧插槽 |
142
+ | `referMapRight` | `(slot) => void` | 对比视图地图右侧插槽 |
143
+ | `referPlaybarDefault` | `(slot) => void` | 对比视图播放条默认插槽 |
144
+ | `referPlaybarBox` | `(slot) => void` | 对比视图播放条容器插槽 |
145
+ | `referPlaybarButton` | `(slot) => void` | 对比视图播放条按钮插槽 |
146
+ | `referPlaybarCaption` | `(slot) => void` | 对比视图播放条标题插槽 |
147
+ | `referPlaybarSlider` | `(slot) => void` | 对比视图播放条滑块插槽 |
148
+ | `bimseeDefault` | `(slot) => void` | BIM默认插槽 |
149
+ | `bimseeMasker` | `(slot) => void` | BIM蒙层默认插槽 |
150
+ | `default` | `(slot) => void` | 组件默认插槽 |
148
151
 
149
- #
152
+ ```
153
+ basic相关插槽请参考RealseePlugin组件插槽说明
154
+ refer相关插槽请参考RealseePlugin组件插槽说明
155
+ bimse相关插槽请参考BimseePlugin组件插槽说明
156
+ lock相关插槽请参考Lock组件插槽说明
157
+ ```
150
158
 
151
159
  # Lock 同步锁组件
152
160
 
@@ -154,17 +162,17 @@
154
162
 
155
163
  ### LockProps 类型说明
156
164
 
157
- | 参数名 | 类型 | 必填 | 说明 |
158
- | --------------------------- | --------- | ---- | -------------------------------- |
159
- | `locked` | `boolean` | | 锁状态 |
160
- | `distance` | `number` | | 两点之间的距离 |
161
- | `showDistance` | `boolean` | | 是否显示距离 |
162
- | `readonly enableMatchPoint` | `boolean` | | 是否开启点匹配(默认true) |
163
- | `readonly maxMatchDistance` | `number` | | 匹配点最大距离(毫米,默认5000) |
165
+ | 参数名 | 类型 | 默认值 | 说明 |
166
+ | --------------------------- | --------- | ------ | -------------- |
167
+ | `locked` | `boolean` | true | 锁状态 |
168
+ | `distance` | `number` | 0 | 两点之间的距离 |
169
+ | `showDistance` | `boolean` | true | 是否显示距离 |
170
+ | `readonly enableMatchPoint` | `boolean` | - | 是否开启点匹配 |
171
+ | `readonly maxMatchDistance` | `number` | - | 匹配点最大距离 |
164
172
 
165
173
  ### LockElement 实例对象
166
174
 
167
- | 方法/属性 | 类型签名 | 说明 |
175
+ | 属性/方法 | 类型/签名 | 说明 |
168
176
  | ------------- | --------------------------------------- | ---------- |
169
177
  | `getState` | `() => LockProps` | 获取锁参数 |
170
178
  | `setState` | `(options: UpdatableLockProps) => void` | 设置锁参数 |
@@ -173,19 +181,27 @@
173
181
 
174
182
  ### LockEvents 事件说明
175
183
 
176
- | 事件名称 | 描述 | 参数类型 |
177
- | ----------------------- | ------------ | ------------------------ |
178
- | `lock-locked-updated` | 锁定状态更新 | (distance: number)=>void |
179
- | `lock-distance-updated` | 锁定距离更新 | (locked: boolean)=> void |
184
+ | 事件名称 | 参数类型 | 说明 |
185
+ | ------------------ | -------------------------- | ---------- |
186
+ | `locked-updated` | `(distance: number)=>void` | 锁状态更新 |
187
+ | `distance-updated` | `(locked: boolean)=> void` | 锁距离更新 |
180
188
 
181
189
  ### Lock Slot 插槽说明
182
190
 
183
- | 插槽名称 | 描述 | 参数类型 |
184
- | -------- | ------------ | -------------- |
185
- | button | 锁按钮插槽 | (slot) => void |
186
- | distance | 距离文本插槽 | (slot) => void |
191
+ | 插槽名称 | 参数类型 | 说明 |
192
+ | ---------- | ---------------- | ------------ |
193
+ | `button` | `(slot) => void` | 锁按钮插槽 |
194
+ | `distance` | `(slot) => void` | 距离文本插槽 |
187
195
 
188
- #
196
+ ```
197
+ type slot = {
198
+ locked?: boolean | undefined;
199
+ distance?: number | undefined;
200
+ showDistance?: boolean | undefined;
201
+ enableMatchPoint?: boolean | undefined;
202
+ maxMatchDistance?: number | undefined;
203
+ }
204
+ ```
189
205
 
190
206
  # 导出的类型声明对象
191
207
 
@@ -210,11 +226,18 @@ export {
210
226
 
211
227
  ```
212
228
 
213
- #
229
+ # 示例
214
230
 
215
- ## 示例
231
+ 通过以下方式来注册组件
216
232
 
217
- ```
233
+ ### 安装
218
234
 
219
- 通过以下方式来注册组件
220
- ```
235
+ `npm install @vsleem-realsee-viewer/realsee-plugin @vsleem-realsee-viewer/bimsee-plugin @vsleem-realsee-viewer/shared`
236
+
237
+ `pnpm add @vsleem-realsee-viewer/realsee-plugin @vsleem-realsee-viewer/bimsee-plugin @vsleem-realsee-viewer/shared`
238
+
239
+ ### 例子
240
+
241
+ `vsleem-realsee-demo仓库下的DualseePlugin.vue`
242
+
243
+ 仓库地址:https://gitee.com/yangleistudio/vsleem-realsee-demo