chbim-plugins 0.0.104 → 0.0.106

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.
Files changed (2) hide show
  1. package/README.md +149 -3
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,3 @@
1
- ````
2
1
  <br />
3
2
 
4
3
  <p align="center">
@@ -11,14 +10,14 @@
11
10
 
12
11
  ## 使用指南
13
12
 
14
- 1. 此插件和 CHBIM 强绑定
13
+ 1. 此插件和 CHBIM 平台强绑定
15
14
  2. node 版本>=16.14.2
16
15
 
17
16
  #### 安装
18
17
 
19
18
  ```sh
20
19
  npm i chbim-plugins
21
- ````
20
+ ```
22
21
 
23
22
  #### 引入
24
23
 
@@ -66,6 +65,153 @@ window.bimModel.add(id,fn).then((e) => {
66
65
  })
67
66
  ```
68
67
 
68
+ ### API
69
+
70
+ #### window.bimElevationImage `影像`
71
+
72
+ ##### add（ id || xyzParameter，isGisTkone，fn）添加影像
73
+
74
+ | 类参数名 | 类型 | 默认参数 | 描述 |
75
+ | ------------ | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
76
+ | id | String | “ ” | 需要添加的影像 id |
77
+ | xyzParameter | Object | { } | 三方影像数据 `{imageXyzId:影像id，url:影像路由，zIndex:影像层级，minimumLevel:服务支持的最小层级，maximumLevel:服务支持的最大层级，chinaCRS:标识瓦片的国内坐标系（用于自动纠偏或加偏）}` chinaCRS 默认 GCJ02 |
78
+ | isGisTkone | Boolean | true | 是否开启 Tkone 验证，三方影像不需要开启验证 |
79
+ | fn | Object | { } | 例如：绑定 click 事件 `{ click: (e) => { console.log(e) } }` |
80
+
81
+ ##### remove（ id ）添加影像
82
+
83
+ | 类参数名 | 类型 | 默认参数 | 描述 |
84
+ | -------- | ------ | -------- | ----------------- |
85
+ | id | String | “ ” | 需要移除的影像 id |
86
+
87
+ ##### query（ id ）查询影像的数据
88
+
89
+ | 类参数名 | 类型 | 默认参数 | 描述 |
90
+ | -------- | ------ | -------- | ------------------------------- |
91
+ | id | String | “ ” | 需要查询的模型 id，返回模型数据 |
92
+
93
+ <br /><br />
94
+
95
+ #### window.bimModel `模型`
96
+
97
+ ##### add（ id，fn，list ）添加模型
98
+
99
+ | 类参数名 | 类型 | 默认参数 | 描述 |
100
+ | -------- | ------ | -------- | ------------------------------------------------------------ |
101
+ | id | String | “ ” | 需要添加的模型 id |
102
+ | fn | Object | { } | 例如：绑定 click 事件 `{ click: (e) => { console.log(e) } }` |
103
+ | list | Object | { } | 字段目前用于处理分屏数据 `{ isClone:true }` |
104
+
105
+ ##### remove（ id，list ）移除模型
106
+
107
+ | 类参数名 | 类型 | 默认参数 | 描述 |
108
+ | -------- | ------ | -------- | ------------------------------------------- |
109
+ | id | String | “ ” | 需要移除的模型 id |
110
+ | list | Object | { } | 字段目前用于处理分屏数据 `{ isClone:true }` |
111
+
112
+ ##### selected（ id ）选中模型
113
+
114
+ | 类参数名 | 类型 | 默认参数 | 描述 |
115
+ | -------- | ------- | -------- | ------------------------------------------------------------ |
116
+ | id | String | “ ” | 需要选中的模型 id |
117
+ | fn | Object | { } | 例如：绑定 click 事件 `{ click: (e) => { console.log(e) } }` |
118
+ | list | Object | { } | 字段目前用于处理分屏数据 `{ isClone:true }` |
119
+ | flyTo | Boolean | true | 默认会自动飞行，模型选中变红，设置`false`不会飞行 |
120
+
121
+ ##### query（ id ）查询模型的数据
122
+
123
+ | 类参数名 | 类型 | 默认参数 | 描述 |
124
+ | -------- | ------ | -------- | ------------------------------- |
125
+ | id | String | “ ” | 需要查询的模型 id，返回模型数据 |
126
+
127
+ ##### queryModel（ id ）查询 map 上模型的实体
128
+
129
+ | 类参数名 | 类型 | 默认参数 | 描述 |
130
+ | -------- | ------ | -------- | ------------------------------- |
131
+ | id | String | “ ” | 需要查询的模型 id，返回模型实体 |
132
+
133
+ ##### editColor（ id，newColor，list ）模型染色
134
+
135
+ | 类参数名 | 类型 | 默认参数 | 描述 |
136
+ | -------- | ------ | -------- | ------------------------------------------- |
137
+ | id | String | “ ” | 模型 id |
138
+ | newColor | String | “ ” | css 颜色值 |
139
+ | list | Object | { } | 字段目前用于处理分屏数据 `{ isClone:true }` |
140
+
141
+ ##### editOpacity（ id，opacity）模型染色
142
+
143
+ | 类参数名 | 类型 | 默认参数 | 描述 |
144
+ | -------- | ------ | -------- | ------------ |
145
+ | id | String | “ ” | 模型 id |
146
+ | opacity | String | “ ” | 透明度值 0~1 |
147
+
148
+ <br /><br />
149
+
150
+ #### window.bimVector `矢量`
151
+
152
+ ##### add（ id，list ）添加矢量
153
+
154
+ | 类参数名 | 类型 | 默认参数 | 描述 |
155
+ | -------- | ------ | -------- | ------------------------------------------- |
156
+ | id | Object | “ ” | 需要添加的矢量 id |
157
+ | list | Object | { } | 字段目前用于处理分屏数据 `{ isClone:true }` |
158
+
159
+ ##### remove（ id，list ）移除矢量
160
+
161
+ | 类参数名 | 类型 | 默认参数 | 描述 |
162
+ | -------- | ------ | -------- | ------------------------------------------- |
163
+ | id | String | “ ” | 需要移除的矢量 id |
164
+ | list | Object | { } | 字段目前用于处理分屏数据 `{ isClone:true }` |
165
+
166
+ ##### selected（ id ）添加矢量
167
+
168
+ | 类参数名 | 类型 | 默认参数 | 描述 |
169
+ | -------- | ------ | -------- | ------------------------------------------ |
170
+ | id | Object | “ ” | 需要选中的矢量 id ，选中会飞行到选中的矢量 |
171
+
172
+ ##### query（ id ）添加矢量
173
+
174
+ | 类参数名 | 类型 | 默认参数 | 描述 |
175
+ | -------- | ------ | -------- | -------------------------------- |
176
+ | id | Object | “ ” | 需要选中的矢量 id ，返回矢量数据 |
177
+
178
+ ##### queryVector（ id ）添加矢量
179
+
180
+ | 类参数名 | 类型 | 默认参数 | 描述 |
181
+ | -------- | ------ | -------- | -------------------------------- |
182
+ | id | Object | “ ” | 需要选中的矢量 id ，返回矢量实体 |
183
+
184
+ <br /><br />
185
+
186
+ #### window.bimEntity `标绘`
187
+
188
+ ##### add（ id，entityId，list ）添加标绘
189
+
190
+ | 类参数名 | 类型 | 默认参数 | 描述 |
191
+ | -------- | ------ | -------- | ----------------------------------------------- |
192
+ | id | Object | “ ” | 需要添加的标绘 id |
193
+ | entityId | String | null | 临时添加的标绘是不带 id 的，需要自定义的一个 id |
194
+ | list | Object | { } | 字段目前用于处理分屏数据 `{ isClone:true }` |
195
+
196
+ ##### remove（ id，list ）移除标绘
197
+
198
+ | 类参数名 | 类型 | 默认参数 | 描述 |
199
+ | -------- | ------ | -------- | ------------------------------------------- |
200
+ | id | String | “ ” | 需要移除的标绘 id |
201
+ | list | Object | { } | 字段目前用于处理分屏数据 `{ isClone:true }` |
202
+
203
+ ##### query（ id ）添加标绘
204
+
205
+ | 类参数名 | 类型 | 默认参数 | 描述 |
206
+ | -------- | ------ | -------- | -------------------------------- |
207
+ | id | Object | “ ” | 需要选中的矢量 id ，返回矢量数据 |
208
+
209
+ ##### queryEntity（ id ）添加标绘
210
+
211
+ | 类参数名 | 类型 | 默认参数 | 描述 |
212
+ | -------- | ------ | -------- | -------------------------------- |
213
+ | id | Object | “ ” | 需要选中的矢量 id ，返回矢量实体 |
214
+
69
215
  ### 版本控制
70
216
 
71
217
  该项目使用 Git 进行版本管理。
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "chbim-plugins",
3
3
  "private": false,
4
- "version": "0.0.104",
4
+ "version": "0.0.106",
5
5
  "description": "一个简单的组件库",
6
6
  "main": "chbim-plugins.js",
7
7
  "keywords": [