shaoxing-geo-tools 0.0.9 → 0.0.11

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
@@ -56,7 +56,7 @@ _绝大部分情况下无须设置_
56
56
  | ---- | ------- | ------------------ |
57
57
  | geo | GeoJSON | 待检查的点几何对象 |
58
58
 
59
- **用途:** 判断某个坐标点是否在特定区域内、是否合法等。
59
+ **用途:** 判断某个坐标点是否合法。
60
60
 
61
61
  ---
62
62
 
@@ -102,6 +102,9 @@ _绝大部分情况下无须设置_
102
102
 
103
103
  **用途:** 用于展示基站/无人机等设备的信号覆盖范围、服务半径等。 **提示:** distances数组和opacities数组的长度必须一致。
104
104
 
105
+ **返回值:** `data` 为覆盖范围 GeoJSON Feature 数组,每个距离层级对应一个覆盖多边形,元素 `properties`
106
+ 中携带来源标识(`key`),可直接拼入 `FeatureCollection` 用于渲染。
107
+
105
108
  ---
106
109
 
107
110
  ### 7. `batchSimplify(geo_jsons, toleranceMeters)`
@@ -117,6 +120,8 @@ _绝大部分情况下无须设置_
117
120
  | geo_jsons | Array\<GeoJSON\> | — | 需要简化的 GeoJSON 数组 |
118
121
  | toleranceMeters | number | `11` | 简化容差(米),该距离内的相邻点将被合并 |
119
122
 
123
+ **返回值:** `data` 为简化后的 GeoJSON 数组,元素与传入顺序一一对应(不合法数据被剔除后数量减少)。
124
+
120
125
  **用途:** 减少高精度 GeoJSON 的数据量,提升渲染和传输性能。默认值 11 米 ≈ turf 的 `tolerance: 0.0001`。
121
126
 
122
127
  ---
@@ -133,7 +138,7 @@ _绝大部分情况下无须设置_
133
138
  | mapSizes | [number, number] | `[4910, 1311]` | 地图视口尺寸(像素) |
134
139
  | paddingRatio | number | `0.5` | 边距比例,用于计算最佳缩放级别 |
135
140
 
136
- **返回值包含:**
141
+ **返回值为数组:** `data` 中每个元素与 `geo_jsons` 顺序一一对应,元素包含:
137
142
 
138
143
  | 字段 | 类型 | 说明 |
139
144
  | --------- | ---------- | ------------------------------ |
@@ -146,7 +151,37 @@ _绝大部分情况下无须设置_
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
+ > ℹ️ **多边形自动去重:** 多个多边形相互重叠的部分只计算一次(取并集),因此 `area`
163
+ > 为去重后的实际总面积,`center`/`zoom`/`cityCodes` 也基于合并后的整体范围计算。
164
+
165
+ | 参数 | 类型 | 默认值 | 说明 |
166
+ | ------------ | ---------------- | -------------- | ------------------------------ |
167
+ | geo_jsons | Array\<GeoJSON\> | — | 空间 GeoJSON 数组(面要素) |
168
+ | mapSizes | [number, number] | `[4910, 1311]` | 地图视口尺寸(像素) |
169
+ | paddingRatio | number | `0.5` | 边距比例,用于计算最佳缩放级别 |
170
+
171
+ **返回值包含:**
172
+
173
+ | 字段 | 类型 | 说明 |
174
+ | --------- | ---------- | ------------------------------ |
175
+ | area | number | 空间面积(平方米) |
176
+ | center | [lng, lat] | 空间中心点坐标 |
177
+ | zoom | number | 空间在当前视口下的最佳缩放级别 |
178
+ | cityCodes | string[] | 空间覆盖的区县编码列表 |
179
+
180
+ **用途:** 需要对一组空域整体汇总展示面积、中心点、最佳缩放级别等元数据时使用。 **修复了带洞多边形面积计算错误**
181
+
182
+ ---
183
+
184
+ ### 10. `batchGetLineExtra(geo_jsons, mapSizes, paddingRatio)`
150
185
 
151
186
  **批量获取航线额外信息**
152
187
 
@@ -158,7 +193,7 @@ _绝大部分情况下无须设置_
158
193
  | mapSizes | [number, number] | `[4910, 1311]` | 地图视口尺寸(像素) |
159
194
  | paddingRatio | number | `0.5` | 边距比例,用于计算最佳缩放级别 |
160
195
 
161
- **返回值包含:**
196
+ **返回值为数组:** `data` 中每个元素与 `geo_jsons` 顺序一一对应,元素包含:
162
197
 
163
198
  | 字段 | 类型 | 说明 |
164
199
  | --------- | ---------- | ------------------------------ |
@@ -171,7 +206,34 @@ _绝大部分情况下无须设置_
171
206
 
172
207
  ---
173
208
 
174
- ### 10. `batchCalcRouteMatch(routes, geoJsons, options)`
209
+ ### 11. `getMultiLineGeneral(geo_jsons, mapSizes, paddingRatio)`
210
+
211
+ **获取多个航线概述信息**
212
+
213
+ 计算一组航线(线)的概述信息,包括长度、中心点、最佳缩放级别、经过的区县编码。
214
+
215
+ 与 `batchGetLineExtra` 不同,返回整组数据汇总的概述信息,而非逐条航线的元信息数组。
216
+
217
+ | 参数 | 类型 | 默认值 | 说明 |
218
+ | ------------ | ---------------- | -------------- | ------------------------------ |
219
+ | geo_jsons | Array\<GeoJSON\> | — | 航线 GeoJSON 数组(线要素) |
220
+ | mapSizes | [number, number] | `[4910, 1311]` | 地图视口尺寸(像素) |
221
+ | paddingRatio | number | `0.5` | 边距比例,用于计算最佳缩放级别 |
222
+
223
+ **返回值包含:**
224
+
225
+ | 字段 | 类型 | 说明 |
226
+ | --------- | ---------- | ------------------------------ |
227
+ | length | number | 航线长度(米) |
228
+ | center | [lng, lat] | 航线中心点坐标 |
229
+ | zoom | number | 航线在当前视口下的最佳缩放级别 |
230
+ | cityCodes | string[] | 航线经过的区县编码列表 |
231
+
232
+ **用途:** 需要对一组航线整体汇总展示长度、中心点、最佳缩放级别等信息时使用。
233
+
234
+ ---
235
+
236
+ ### 12. `batchCalcRouteMatch(routes, geoJsons, options)`
175
237
 
176
238
  **批量计算路线匹配率**
177
239
 
@@ -192,7 +254,7 @@ _绝大部分情况下无须设置_
192
254
  | polygonPerfectDistance | number | `100` | 多边形完全匹配距离阈值(米) |
193
255
  | polygonMaxDistance | number | `300` | 多边形最大匹配距离阈值(米) |
194
256
 
195
- **返回值包含:**
257
+ **返回值为数组:** `data` 中每个元素与 `routes` 顺序一一对应,元素包含:
196
258
 
197
259
  | 字段 | 类型 | 说明 |
198
260
  | ---------------- | ------ | ---------- |
@@ -205,7 +267,7 @@ _绝大部分情况下无须设置_
205
267
 
206
268
  ---
207
269
 
208
- ### 11. `getCityBoundary(toleranceMeters)`
270
+ ### 13. `getCityBoundary(toleranceMeters)`
209
271
 
210
272
  **获取绍兴市边界**
211
273
 
@@ -215,13 +277,14 @@ _绝大部分情况下无须设置_
215
277
  | --------------- | -------------- | ------ | -------------------------------------------- |
216
278
  | toleranceMeters | number \| null | `null` | 简化容差(米),不传或传 `null` 返回完整边界 |
217
279
 
218
- **返回值:** 解析结果为 `{ valid, message, data }`,`data` 为 `FeatureCollection<Polygon>`。
280
+ **返回值:** 解析结果为 `{ valid, message, data }`,`data` 为绍兴市边界 GeoJSON
281
+ Feature 数组(`Feature<Polygon>[]`,可整体作为 `FeatureCollection` 的 `features` 渲染)。
219
282
 
220
283
  **用途:** 在地图上绘制绍兴市行政边界轮廓,或用于空间分析中的边界参考。
221
284
 
222
285
  ---
223
286
 
224
- ### 12. `getDistrictBoundary(toleranceMeters)`
287
+ ### 14. `getDistrictBoundary(toleranceMeters)`
225
288
 
226
289
  **获取绍兴市各区县边界**
227
290
 
@@ -231,7 +294,8 @@ _绝大部分情况下无须设置_
231
294
  | --------------- | -------------- | ------ | -------------------------------------------- |
232
295
  | toleranceMeters | number \| null | `null` | 简化容差(米),不传或传 `null` 返回完整边界 |
233
296
 
234
- **返回值:** 解析结果为 `{ valid, message, data }`,`data` 为 `FeatureCollection<Polygon>`。
297
+ **返回值:** 解析结果为 `{ valid, message, data }`,`data` 为各区县边界 GeoJSON
298
+ Feature 数组(`Feature<Polygon>[]`,每个区县一个 Feature,可整体作为 `FeatureCollection` 的 `features` 渲染)。
235
299
 
236
300
  **用途:** 在地图上绘制各区县边界,或按区县维度进行空间统计与分析。
237
301
 
@@ -259,6 +323,14 @@ geoTools.batchSimplify([complexGeoJson], 11).then(result => {})
259
323
  const extras = await geoTools.batchGetSpaceExtra([polygonGeoJson])
260
324
  geoTools.batchGetSpaceExtra([polygonGeoJson]).then(result => {})
261
325
 
326
+ // 获取多个空间概述信息(整组汇总)
327
+ const spaceGeneral = await geoTools.getMultiSpaceGeneral([polygonGeoJson])
328
+ geoTools.getMultiSpaceGeneral([polygonGeoJson]).then(result => {})
329
+
330
+ // 获取多个航线概述信息(整组汇总)
331
+ const lineGeneral = await geoTools.getMultiLineGeneral([lineGeoJson])
332
+ geoTools.getMultiLineGeneral([lineGeoJson]).then(result => {})
333
+
262
334
  // 获取绍兴市边界
263
335
  const cityBoundary = await geoTools.getCityBoundary()
264
336
  geoTools.getCityBoundary().then(result => {})