shaoxing-geo-tools 0.0.3 → 0.0.4

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 (3) hide show
  1. package/README.md +23 -35
  2. package/dist/index.js +4 -10
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  基于 Web Worker + WASM 的地理空间计算工具集,提供异步、高性能的 GeoJSON 空间运算能力。
4
4
 
5
+ **<span style="color:red">不要在worker中调用!</span>**
6
+
5
7
  ## 通用说明
6
8
 
7
9
  - 所有函数均返回 `Promise`,通过 Worker 异步计算,不阻塞主线程
@@ -13,36 +15,25 @@
13
15
 
14
16
  ## 功能列表
15
17
 
16
- ### 1. `setMapSize(width, height)`
18
+ ### 1. `setDefault(width, height, ratio)`
19
+
20
+ **设置默认地图视口和边距比例**
17
21
 
18
- **设置地图视口默认尺寸**
22
+ *大部分情况下无须设置*
19
23
 
20
- 设置地图视口的默认大小(像素),用于 `batchGetSpaceExtra` 和 `batchGetLineExtra` 中的 `bestZoom` 计算。
24
+ 设置地图视口的默认大小(像素)和边距默认比例,用于 `batchGetSpaceExtra` 和 `batchGetLineExtra` 中的 `zoom` 计算。大部分情况下无需调用,使用默认值即可。
21
25
 
22
26
  | 参数 | 类型 | 默认值 | 说明 |
23
27
  |------|------|--------|------|
24
28
  | width | number | `4910` | 地图视口宽度(像素) |
25
29
  | height | number | `1311` | 地图视口高度(像素) |
30
+ | ratio | number | `0.5` | 边距比例,值越大 `zoom` 越小 |
26
31
 
27
- **用途:** 当地图容器大小变化时,通过此函数同步更新视口尺寸,以确保 `bestZoom` 计算结果准确。
28
-
29
- ---
30
-
31
- ### 2. `setPaddingRatio(ratio)`
32
-
33
- **设置边距默认比例**
34
-
35
- 设置用于计算最佳缩放级别的边距默认比例,值越大则缩放级别越小(视野更宽)。
36
-
37
- | 参数 | 类型 | 默认值 | 说明 |
38
- |------|------|--------|------|
39
- | ratio | number | `0.5` | 边距比例,值越大 `bestZoom` 越小 |
40
-
41
- **用途:** 调整空间/航线在视口中的边距,控制最佳缩放级别的计算结果。
32
+ **用途:** 当地图容器大小或边距需求变化时,通过此函数同步更新默认参数,以确保后续 `zoom` 计算结果准确。
42
33
 
43
34
  ---
44
35
 
45
- ### 3. `getDistricts(geo)`
36
+ ### 2. `getDistricts(geo)`
46
37
 
47
38
  **获取行政区划信息**
48
39
 
@@ -56,7 +47,7 @@
56
47
 
57
48
  ---
58
49
 
59
- ### 4. `checkPoint(geo)`
50
+ ### 3. `checkPoint(geo)`
60
51
 
61
52
  **检查点**
62
53
 
@@ -70,7 +61,7 @@
70
61
 
71
62
  ---
72
63
 
73
- ### 5. `checkLine(geo)`
64
+ ### 4. `checkLine(geo)`
74
65
 
75
66
  **检查线**
76
67
 
@@ -80,11 +71,11 @@
80
71
  |------|------|------|
81
72
  | geo | GeoJSON | 待检查的线几何对象 |
82
73
 
83
- **用途:** 检查航线、路径等线状要素是否符合空间约束(如是否穿越禁飞区)。
74
+ **用途:** 检查航线、路径等线状要素是否符合空间约束和geoJson标准。
84
75
 
85
76
  ---
86
77
 
87
- ### 6. `checkPolygon(geo)`
78
+ ### 5. `checkPolygon(geo)`
88
79
 
89
80
  **检查多边形**
90
81
 
@@ -98,7 +89,7 @@
98
89
 
99
90
  ---
100
91
 
101
- ### 7. `batchGetCovers(geo_jsons, distances, opacities)`
92
+ ### 6. `batchGetCovers(geo_jsons, distances, opacities)`
102
93
 
103
94
  **批量获取覆盖信息**
104
95
 
@@ -114,7 +105,7 @@
114
105
 
115
106
  ---
116
107
 
117
- ### 8. `batchSimplify(geo_jsons, toleranceMeters)`
108
+ ### 7. `batchSimplify(geo_jsons, toleranceMeters)`
118
109
 
119
110
  **批量简化 GeoJSON 数据**
120
111
 
@@ -131,7 +122,7 @@
131
122
 
132
123
  ---
133
124
 
134
- ### 9. `batchGetSpaceExtra(geo_jsons, mapSizes, paddingRatio)`
125
+ ### 8. `batchGetSpaceExtra(geo_jsons, mapSizes, paddingRatio)`
135
126
 
136
127
  **批量获取空间额外信息**
137
128
 
@@ -149,14 +140,14 @@
149
140
  |------|------|------|
150
141
  | area | number | 空间面积(平方米) |
151
142
  | center | [lng, lat] | 空间中心点坐标 |
152
- | bestZoom | number | 空间在当前视口下的最佳缩放级别 |
143
+ | zoom | number | 空间在当前视口下的最佳缩放级别 |
153
144
  | cityCodes | string[] | 空间覆盖的区县编码列表 |
154
145
 
155
146
  **用途:** 展示空域信息时,需要面积、中心点、最佳缩放级别等元数据。
156
147
 
157
148
  ---
158
149
 
159
- ### 10. `batchGetLineExtra(geo_jsons, mapSizes, paddingRatio)`
150
+ ### 9. `batchGetLineExtra(geo_jsons, mapSizes, paddingRatio)`
160
151
 
161
152
  **批量获取航线额外信息**
162
153
 
@@ -174,7 +165,7 @@
174
165
  |------|------|------|
175
166
  | length | number | 航线长度(米) |
176
167
  | center | [lng, lat] | 航线中心点坐标 |
177
- | bestZoom | number | 航线在当前视口下的最佳缩放级别 |
168
+ | zoom | number | 航线在当前视口下的最佳缩放级别 |
178
169
  | cityCodes | string[] | 航线经过的区县编码列表 |
179
170
 
180
171
  **用途:** 展示航线时,需要长度、中心点、最佳缩放级别等信息。
@@ -185,13 +176,10 @@
185
176
  ```javascript
186
177
  import useGeoTools from '@/useWorker/useGeoTools.js'
187
178
 
188
- const { setMapSize, setPaddingRatio, getDistricts, batchSimplify, batchGetSpaceExtra } = useGeoTools()
189
-
190
- // 设置地图视口尺寸
191
- setMapSize(1920, 1080)
179
+ const { setDefault, getDistricts, batchSimplify, batchGetSpaceExtra } = useGeoTools()
192
180
 
193
- // 设置边距比例
194
- setPaddingRatio(0.3)
181
+ // 设置默认地图视口和边距比例
182
+ setDefault(1920, 1080, 0.3)
195
183
 
196
184
  // 获取行政区划
197
185
  const districts = await getDistricts(someGeoJson)
package/dist/index.js CHANGED
@@ -45,14 +45,8 @@ var i = (e) => new TextEncoder().encode(JSON.stringify(e)), a = (e) => {
45
45
  }, g = (e, t) => {
46
46
  f.then(() => h(e, t));
47
47
  }, _ = {
48
- setMapSize: (e, t) => {
49
- typeof e != "number" || typeof t != "number" || (s[0] = e || 4910, s[1] = t || 1311, g("setup", {
50
- MapSize: s,
51
- PaddingRatio: c
52
- }));
53
- },
54
- setPaddingRatio: (e) => {
55
- typeof e == "number" && (c = e, g("setup", {
48
+ setDefault: (e, t, n) => {
49
+ typeof e != "number" || typeof t != "number" || typeof n != "number" || (s[0] = e || 4910, s[1] = t || 1311, c = n, g("setup", {
56
50
  MapSize: s,
57
51
  PaddingRatio: c
58
52
  }));
@@ -148,6 +142,6 @@ var i = (e) => new TextEncoder().encode(JSON.stringify(e)), a = (e) => {
148
142
  paddingRatio: r
149
143
  });
150
144
  })
151
- }, v = o ? _ : (o = !0, m(), _), { setMapSize: y, setPaddingRatio: b, getDistricts: x, checkPoint: S, checkLine: C, checkPolygon: w, batchGetCovers: T, batchSimplify: E, batchGetSpaceExtra: D, batchGetLineExtra: O } = v;
145
+ }, v = o ? _ : (o = !0, m(), _), { setDefault: y, getDistricts: b, checkPoint: x, checkLine: S, checkPolygon: C, batchGetCovers: w, batchSimplify: T, batchGetSpaceExtra: E, batchGetLineExtra: D } = v;
152
146
  //#endregion
153
- export { T as batchGetCovers, O as batchGetLineExtra, D as batchGetSpaceExtra, E as batchSimplify, C as checkLine, S as checkPoint, w as checkPolygon, v as default, x as getDistricts, y as setMapSize, b as setPaddingRatio };
147
+ export { w as batchGetCovers, D as batchGetLineExtra, E as batchGetSpaceExtra, T as batchSimplify, S as checkLine, x as checkPoint, C as checkPolygon, v as default, b as getDistricts, y as setDefault };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shaoxing-geo-tools",
3
- "version": "0.0.3",
3
+ "version": "0.0.4",
4
4
  "description": "GIS tools for shaoxing city GeoJSON data",
5
5
  "main": "dist/index.js",
6
6
  "exports": {