shaoxing-geo-tools 0.0.8 → 0.0.10

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
@@ -17,15 +17,16 @@
17
17
 
18
18
  **设置默认地图视口和边距比例**
19
19
 
20
- *绝大部分情况下无须设置*
20
+ _绝大部分情况下无须设置_
21
21
 
22
- 设置地图视口的默认大小(像素)和边距默认比例,用于 `batchGetSpaceExtra` 和 `batchGetLineExtra` 中的 `zoom` 计算。大部分情况下无需调用,使用默认值即可。
22
+ 设置地图视口的默认大小(像素)和边距默认比例,用于 `batchGetSpaceExtra` 和 `batchGetLineExtra` 中的 `zoom`
23
+ 计算。大部分情况下无需调用,使用默认值即可。
23
24
 
24
- | 参数 | 类型 | 默认值 | 说明 |
25
- |------|------|--------|------|
26
- | width | number | `4910` | 地图视口宽度(像素) |
27
- | height | number | `1311` | 地图视口高度(像素) |
28
- | ratio | number | `0.5` | 边距比例,值越大 `zoom` 越小 |
25
+ | 参数 | 类型 | 默认值 | 说明 |
26
+ | ------ | ------ | ------ | ---------------------------- |
27
+ | width | number | `4910` | 地图视口宽度(像素) |
28
+ | height | number | `1311` | 地图视口高度(像素) |
29
+ | ratio | number | `0.5` | 边距比例,值越大 `zoom` 越小 |
29
30
 
30
31
  **用途:** 当地图容器大小或边距需求变化时,通过此函数同步更新默认参数,以确保后续 `zoom` 计算结果准确。
31
32
 
@@ -37,9 +38,9 @@
37
38
 
38
39
  根据传入的地理范围(GeoJSON),返回该区域覆盖的行政区划数据(仅对绍兴市有效)。
39
40
 
40
- | 参数 | 类型 | 说明 |
41
- |------|------|------|
42
- | geo | GeoJSON | 输入的地理范围 |
41
+ | 参数 | 类型 | 说明 |
42
+ | ---- | ------- | -------------- |
43
+ | geo | GeoJSON | 输入的地理范围 |
43
44
 
44
45
  **用途:** 在地图上选中一个区域后,查询该区域所包含的行政区(区/县),是否跨越绍兴市等信息。
45
46
 
@@ -51,11 +52,11 @@
51
52
 
52
53
  对传入的点(Point)进行空间校验或查询。
53
54
 
54
- | 参数 | 类型 | 说明 |
55
- |------|------|------|
56
- | geo | GeoJSON | 待检查的点几何对象 |
55
+ | 参数 | 类型 | 说明 |
56
+ | ---- | ------- | ------------------ |
57
+ | geo | GeoJSON | 待检查的点几何对象 |
57
58
 
58
- **用途:** 判断某个坐标点是否在特定区域内、是否合法等。
59
+ **用途:** 判断某个坐标点是否合法。
59
60
 
60
61
  ---
61
62
 
@@ -65,9 +66,9 @@
65
66
 
66
67
  对传入的线(LineString)进行空间校验或查询。
67
68
 
68
- | 参数 | 类型 | 说明 |
69
- |------|------|------|
70
- | geo | GeoJSON | 待检查的线几何对象 |
69
+ | 参数 | 类型 | 说明 |
70
+ | ---- | ------- | ------------------ |
71
+ | geo | GeoJSON | 待检查的线几何对象 |
71
72
 
72
73
  **用途:** 检查航线、路径等线状要素是否符合空间约束和geoJson标准。
73
74
 
@@ -79,9 +80,9 @@
79
80
 
80
81
  对传入的多边形(Polygon)进行空间校验或查询。
81
82
 
82
- | 参数 | 类型 | 说明 |
83
- |------|------|------|
84
- | geo | GeoJSON | 待检查的多边形几何对象 |
83
+ | 参数 | 类型 | 说明 |
84
+ | ---- | ------- | ---------------------- |
85
+ | geo | GeoJSON | 待检查的多边形几何对象 |
85
86
 
86
87
  **用途:** 检查空域、区域等面状要素的空间合法性。
87
88
 
@@ -93,14 +94,16 @@
93
94
 
94
95
  计算一组 GeoJSON 在指定距离下的覆盖范围,并支持设置不同透明度。
95
96
 
96
- | 参数 | 类型 | 默认值 | 说明 |
97
- |------|------|--------|------|
98
- | geo_jsons | Array\<GeoJSON\> | — | 需要计算覆盖的 GeoJSON 数组 |
99
- | distances | Array\<number\> | — | 覆盖距离(米),每个层级一个值 |
100
- | opacities | Array\<number\> | `[0.2, 0.2, 0.2]` | 每层覆盖的透明度 |
97
+ | 参数 | 类型 | 默认值 | 说明 |
98
+ | --------- | ---------------- | ----------------- | ------------------------------ |
99
+ | geo_jsons | Array\<GeoJSON\> | — | 需要计算覆盖的 GeoJSON 数组 |
100
+ | distances | Array\<number\> | — | 覆盖距离(米),每个层级一个值 |
101
+ | opacities | Array\<number\> | `[0.2, 0.2, 0.2]` | 每层覆盖的透明度 |
101
102
 
102
- **用途:** 用于展示基站/无人机等设备的信号覆盖范围、服务半径等。
103
- **提示:** distances数组和opacities数组的长度必须一致。
103
+ **用途:** 用于展示基站/无人机等设备的信号覆盖范围、服务半径等。 **提示:** distances数组和opacities数组的长度必须一致。
104
+
105
+ **返回值:** `data` 为覆盖范围 GeoJSON Feature 数组,每个距离层级对应一个覆盖多边形,元素 `properties`
106
+ 中携带来源标识(`key`),可直接拼入 `FeatureCollection` 用于渲染。
104
107
 
105
108
  ---
106
109
 
@@ -112,10 +115,12 @@
112
115
 
113
116
  > ⚠️ **注意:** 返回的数组元素数量 ≤ 传入的数组元素数量(不合法数据会被自动删除)。
114
117
 
115
- | 参数 | 类型 | 默认值 | 说明 |
116
- |------|------|--------|------|
117
- | geo_jsons | Array\<GeoJSON\> | — | 需要简化的 GeoJSON 数组 |
118
- | toleranceMeters | number | `11` | 简化容差(米),该距离内的相邻点将被合并 |
118
+ | 参数 | 类型 | 默认值 | 说明 |
119
+ | --------------- | ---------------- | ------ | ---------------------------------------- |
120
+ | geo_jsons | Array\<GeoJSON\> | — | 需要简化的 GeoJSON 数组 |
121
+ | toleranceMeters | number | `11` | 简化容差(米),该距离内的相邻点将被合并 |
122
+
123
+ **返回值:** `data` 为简化后的 GeoJSON 数组,元素与传入顺序一一对应(不合法数据被剔除后数量减少)。
119
124
 
120
125
  **用途:** 减少高精度 GeoJSON 的数据量,提升渲染和传输性能。默认值 11 米 ≈ turf 的 `tolerance: 0.0001`。
121
126
 
@@ -127,83 +132,174 @@
127
132
 
128
133
  计算一组空间(多边形/面)的额外元信息。
129
134
 
130
- | 参数 | 类型 | 默认值 | 说明 |
131
- |------|------|--------|------|
132
- | geo_jsons | Array\<GeoJSON\> | — | 空间 GeoJSON 数组(面要素) |
133
- | mapSizes | [number, number] | `[4910, 1311]` | 地图视口尺寸(像素) |
134
- | paddingRatio | number | `0.5` | 边距比例,用于计算最佳缩放级别 |
135
+ | 参数 | 类型 | 默认值 | 说明 |
136
+ | ------------ | ---------------- | -------------- | ------------------------------ |
137
+ | geo_jsons | Array\<GeoJSON\> | — | 空间 GeoJSON 数组(面要素) |
138
+ | mapSizes | [number, number] | `[4910, 1311]` | 地图视口尺寸(像素) |
139
+ | paddingRatio | number | `0.5` | 边距比例,用于计算最佳缩放级别 |
135
140
 
136
- **返回值包含:**
141
+ **返回值为数组:** `data` 中每个元素与 `geo_jsons` 顺序一一对应,元素包含:
137
142
 
138
- | 字段 | 类型 | 说明 |
139
- |------|------|------|
140
- | area | number | 空间面积(平方米) |
141
- | center | [lng, lat] | 空间中心点坐标 |
142
- | zoom | number | 空间在当前视口下的最佳缩放级别 |
143
- | cityCodes | string[] | 空间覆盖的区县编码列表 |
143
+ | 字段 | 类型 | 说明 |
144
+ | --------- | ---------- | ------------------------------ |
145
+ | area | number | 空间面积(平方米) |
146
+ | center | [lng, lat] | 空间中心点坐标 |
147
+ | zoom | number | 空间在当前视口下的最佳缩放级别 |
148
+ | cityCodes | string[] | 空间覆盖的区县编码列表 |
144
149
 
145
150
  **用途:** 展示空域信息时,需要面积、中心点、最佳缩放级别等元数据。
146
151
 
147
152
  ---
148
153
 
149
- ### 9. `batchGetLineExtra(geo_jsons, mapSizes, paddingRatio)`
154
+ ### 9. `getMultiSpaceGeneral(geo_jsons, mapSizes, paddingRatio)`
155
+
156
+ **获取多个空间概述信息**
157
+
158
+ 计算一组空间(多边形/面)的概述信息,包括面积、中心点、最佳缩放级别、覆盖的区县编码。
159
+
160
+ 与 `batchGetSpaceExtra` 不同,返回整组数据汇总的概述信息,而非逐个空间的结果数组。
161
+
162
+ | 参数 | 类型 | 默认值 | 说明 |
163
+ | ------------ | ---------------- | -------------- | ------------------------------ |
164
+ | geo_jsons | Array\<GeoJSON\> | — | 空间 GeoJSON 数组(面要素) |
165
+ | mapSizes | [number, number] | `[4910, 1311]` | 地图视口尺寸(像素) |
166
+ | paddingRatio | number | `0.5` | 边距比例,用于计算最佳缩放级别 |
167
+
168
+ **返回值包含:**
169
+
170
+ | 字段 | 类型 | 说明 |
171
+ | --------- | ---------- | ------------------------------ |
172
+ | area | number | 空间面积(平方米) |
173
+ | center | [lng, lat] | 空间中心点坐标 |
174
+ | zoom | number | 空间在当前视口下的最佳缩放级别 |
175
+ | cityCodes | string[] | 空间覆盖的区县编码列表 |
176
+
177
+ **用途:** 需要对一组空域整体汇总展示面积、中心点、最佳缩放级别等元数据时使用。
178
+
179
+ ---
180
+
181
+ ### 10. `batchGetLineExtra(geo_jsons, mapSizes, paddingRatio)`
150
182
 
151
183
  **批量获取航线额外信息**
152
184
 
153
185
  计算一组航线(线)的额外元信息。
154
186
 
155
- | 参数 | 类型 | 默认值 | 说明 |
156
- |------|------|--------|------|
157
- | geo_jsons | Array\<GeoJSON\> | — | 航线 GeoJSON 数组(线要素) |
158
- | mapSizes | [number, number] | `[4910, 1311]` | 地图视口尺寸(像素) |
159
- | paddingRatio | number | `0.5` | 边距比例,用于计算最佳缩放级别 |
187
+ | 参数 | 类型 | 默认值 | 说明 |
188
+ | ------------ | ---------------- | -------------- | ------------------------------ |
189
+ | geo_jsons | Array\<GeoJSON\> | — | 航线 GeoJSON 数组(线要素) |
190
+ | mapSizes | [number, number] | `[4910, 1311]` | 地图视口尺寸(像素) |
191
+ | paddingRatio | number | `0.5` | 边距比例,用于计算最佳缩放级别 |
160
192
 
161
- **返回值包含:**
193
+ **返回值为数组:** `data` 中每个元素与 `geo_jsons` 顺序一一对应,元素包含:
162
194
 
163
- | 字段 | 类型 | 说明 |
164
- |------|------|------|
165
- | length | number | 航线长度(米) |
166
- | center | [lng, lat] | 航线中心点坐标 |
167
- | zoom | number | 航线在当前视口下的最佳缩放级别 |
168
- | cityCodes | string[] | 航线经过的区县编码列表 |
195
+ | 字段 | 类型 | 说明 |
196
+ | --------- | ---------- | ------------------------------ |
197
+ | length | number | 航线长度(米) |
198
+ | center | [lng, lat] | 航线中心点坐标 |
199
+ | zoom | number | 航线在当前视口下的最佳缩放级别 |
200
+ | cityCodes | string[] | 航线经过的区县编码列表 |
169
201
 
170
202
  **用途:** 展示航线时,需要长度、中心点、最佳缩放级别等信息。
171
203
 
172
204
  ---
173
205
 
174
- ### 10. `getCityBoundary(toleranceMeters)`
206
+ ### 11. `getMultiLineGeneral(geo_jsons, mapSizes, paddingRatio)`
207
+
208
+ **获取多个航线概述信息**
209
+
210
+ 计算一组航线(线)的概述信息,包括长度、中心点、最佳缩放级别、经过的区县编码。
211
+
212
+ 与 `batchGetLineExtra` 不同,返回整组数据汇总的概述信息,而非逐条航线的元信息数组。
213
+
214
+ | 参数 | 类型 | 默认值 | 说明 |
215
+ | ------------ | ---------------- | -------------- | ------------------------------ |
216
+ | geo_jsons | Array\<GeoJSON\> | — | 航线 GeoJSON 数组(线要素) |
217
+ | mapSizes | [number, number] | `[4910, 1311]` | 地图视口尺寸(像素) |
218
+ | paddingRatio | number | `0.5` | 边距比例,用于计算最佳缩放级别 |
219
+
220
+ **返回值包含:**
221
+
222
+ | 字段 | 类型 | 说明 |
223
+ | --------- | ---------- | ------------------------------ |
224
+ | length | number | 航线长度(米) |
225
+ | center | [lng, lat] | 航线中心点坐标 |
226
+ | zoom | number | 航线在当前视口下的最佳缩放级别 |
227
+ | cityCodes | string[] | 航线经过的区县编码列表 |
228
+
229
+ **用途:** 需要对一组航线整体汇总展示长度、中心点、最佳缩放级别等信息时使用。
230
+
231
+ ---
232
+
233
+ ### 12. `batchCalcRouteMatch(routes, geoJsons, options)`
234
+
235
+ **批量计算路线匹配率**
236
+
237
+ 计算当前飞行路线与预定航线或空域的匹配率(全部匹配率和部分匹配率)。
238
+
239
+ | 参数 | 类型 | 默认值 | 说明 |
240
+ | -------- | ---------------- | ------ | --------------------------- |
241
+ | routes | Array\<GeoJSON\> | — | 当前飞行路线(线要素) |
242
+ | geoJsons | Array\<GeoJSON\> | — | 预定航线或空域(线/面要素) |
243
+ | options | object | `{}` | 距离阈值配置 |
244
+
245
+ **`options` 参数:**
246
+
247
+ | 字段 | 类型 | 默认值 | 说明 |
248
+ | ---------------------- | ------ | ------ | ---------------------------- |
249
+ | linePerfectDistance | number | `15` | 线路完全匹配距离阈值(米) |
250
+ | lineMaxDistance | number | `60` | 线路最大匹配距离阈值(米) |
251
+ | polygonPerfectDistance | number | `100` | 多边形完全匹配距离阈值(米) |
252
+ | polygonMaxDistance | number | `300` | 多边形最大匹配距离阈值(米) |
253
+
254
+ **返回值为数组:** `data` 中每个元素与 `routes` 顺序一一对应,元素包含:
255
+
256
+ | 字段 | 类型 | 说明 |
257
+ | ---------------- | ------ | ---------- |
258
+ | fullMatchRate | number | 全部匹配率 |
259
+ | partialMatchRate | number | 部分匹配率 |
260
+
261
+ **部分匹配率:** 是指在符合匹配的平均值(即剔除0%匹配率外的数据平均值)
262
+
263
+ **用途:** 计算无人机飞行路线与预定航线/空域的吻合程度,用于飞行合规性检查、航迹评估等场景。
264
+
265
+ ---
266
+
267
+ ### 13. `getCityBoundary(toleranceMeters)`
175
268
 
176
269
  **获取绍兴市边界**
177
270
 
178
271
  从 WASM 中读取绍兴市行政边界 GeoJSON(`FeatureCollection`),可按米为单位设置简化容差来减少数据量。
179
272
 
180
- | 参数 | 类型 | 默认值 | 说明 |
181
- |------|------|--------|------|
273
+ | 参数 | 类型 | 默认值 | 说明 |
274
+ | --------------- | -------------- | ------ | -------------------------------------------- |
182
275
  | toleranceMeters | number \| null | `null` | 简化容差(米),不传或传 `null` 返回完整边界 |
183
276
 
184
- **返回值:** 解析结果为 `{ valid, message, data }`,`data` 为 `FeatureCollection<Polygon>`。
277
+ **返回值:** 解析结果为 `{ valid, message, data }`,`data` 为绍兴市边界 GeoJSON
278
+ Feature 数组(`Feature<Polygon>[]`,可整体作为 `FeatureCollection` 的 `features` 渲染)。
185
279
 
186
280
  **用途:** 在地图上绘制绍兴市行政边界轮廓,或用于空间分析中的边界参考。
187
281
 
188
282
  ---
189
283
 
190
- ### 11. `getDistrictBoundary(toleranceMeters)`
284
+ ### 14. `getDistrictBoundary(toleranceMeters)`
191
285
 
192
286
  **获取绍兴市各区县边界**
193
287
 
194
288
  从 WASM 中读取绍兴市各区县行政边界 GeoJSON(`FeatureCollection`),每个区县为一个 Feature,可按米为单位设置简化容差。
195
289
 
196
- | 参数 | 类型 | 默认值 | 说明 |
197
- |------|------|--------|------|
290
+ | 参数 | 类型 | 默认值 | 说明 |
291
+ | --------------- | -------------- | ------ | -------------------------------------------- |
198
292
  | toleranceMeters | number \| null | `null` | 简化容差(米),不传或传 `null` 返回完整边界 |
199
293
 
200
- **返回值:** 解析结果为 `{ valid, message, data }`,`data` 为 `FeatureCollection<Polygon>`。
294
+ **返回值:** 解析结果为 `{ valid, message, data }`,`data` 为各区县边界 GeoJSON
295
+ Feature 数组(`Feature<Polygon>[]`,每个区县一个 Feature,可整体作为 `FeatureCollection` 的 `features` 渲染)。
201
296
 
202
297
  **用途:** 在地图上绘制各区县边界,或按区县维度进行空间统计与分析。
203
298
 
204
299
  ---
205
300
 
206
301
  ## 使用示例
302
+
207
303
  ```javascript
208
304
  import geoTools from 'shaoxing-geo-tools'
209
305
 
@@ -224,6 +320,14 @@ geoTools.batchSimplify([complexGeoJson], 11).then(result => {})
224
320
  const extras = await geoTools.batchGetSpaceExtra([polygonGeoJson])
225
321
  geoTools.batchGetSpaceExtra([polygonGeoJson]).then(result => {})
226
322
 
323
+ // 获取多个空间概述信息(整组汇总)
324
+ const spaceGeneral = await geoTools.getMultiSpaceGeneral([polygonGeoJson])
325
+ geoTools.getMultiSpaceGeneral([polygonGeoJson]).then(result => {})
326
+
327
+ // 获取多个航线概述信息(整组汇总)
328
+ const lineGeneral = await geoTools.getMultiLineGeneral([lineGeoJson])
329
+ geoTools.getMultiLineGeneral([lineGeoJson]).then(result => {})
330
+
227
331
  // 获取绍兴市边界
228
332
  const cityBoundary = await geoTools.getCityBoundary()
229
333
  geoTools.getCityBoundary().then(result => {})
@@ -231,14 +335,20 @@ geoTools.getCityBoundary().then(result => {})
231
335
  const simplifiedCityBoundary = await geoTools.getCityBoundary(50)
232
336
  geoTools.getCityBoundary(50).then(result => {})
233
337
 
338
+ // 线路匹配率计算
339
+ // option可不传,默认:航线为 15米内100%匹配,60米外0%匹配, 空域100米内100%匹配,300米外0%匹配
340
+ const matchResult = await geoTools.batchCalcRouteMatch([routeLineGeoJson], [presetRouteGeoJson], {
341
+ linePerfectDistance: 15,
342
+ lineMaxDistance: 60,
343
+ })
344
+ geoTools.batchCalcRouteMatch([routeLineGeoJson], [presetRouteGeoJson]).then(result => {})
345
+
234
346
  // 获取各区县边界
235
347
  const districtBoundary = await geoTools.getDistrictBoundary()
236
348
  geoTools.getDistrictBoundary(50).then(result => {})
237
349
  ```
238
350
 
239
351
  ## 架构说明
352
+
240
353
  - 通信采用 `encode/decode` 进行二进制序列化,使用 `Transferable` 传输避免内存拷贝
241
354
  - 请求通过 `requestId` 匹配,利用 `pendingRequests` Map 管理异步 Promise
242
-
243
-
244
-