ol-wfst 4.1.0 → 4.2.0
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 +801 -794
- package/dist/css/ol-wfst.bootstrap5.css +212 -23
- package/dist/css/ol-wfst.bootstrap5.min.css +1 -1
- package/dist/ol-wfst.js +3468 -2595
- package/dist/ol-wfst.js.map +1 -1
- package/dist/ol-wfst.min.js +6 -1
- package/dist/ol-wfst.min.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -0
- package/lib/@enums.d.ts +16 -16
- package/lib/@types.d.ts +200 -200
- package/lib/Geoserver.d.ts +274 -267
- package/lib/Geoserver.d.ts.map +1 -1
- package/lib/WfsLayer.d.ts +52 -52
- package/lib/WfsLayer.d.ts.map +1 -1
- package/lib/WmsLayer.d.ts +68 -61
- package/lib/WmsLayer.d.ts.map +1 -1
- package/lib/defaults.d.ts +3 -3
- package/lib/index-umd.d.ts +3 -0
- package/lib/index-umd.d.ts.map +1 -0
- package/lib/modules/EditControlChanges.d.ts +17 -17
- package/lib/modules/EditFieldsModal.d.ts +18 -18
- package/lib/modules/EditOverlay.d.ts +7 -7
- package/lib/modules/LayersControl.d.ts +33 -33
- package/lib/modules/Uploads.d.ts +49 -49
- package/lib/modules/base/BaseLayer.d.ts +61 -61
- package/lib/modules/base/WfsSource.d.ts +47 -47
- package/lib/modules/base/WmsSource.d.ts +46 -46
- package/lib/modules/editLayer.d.ts +3 -3
- package/lib/modules/errors.d.ts +11 -11
- package/lib/modules/helpers.d.ts +6 -6
- package/lib/modules/i18n/en.d.ts +2 -2
- package/lib/modules/i18n/es.d.ts +2 -2
- package/lib/modules/i18n/index.d.ts +14 -14
- package/lib/modules/i18n/zh.d.ts +2 -2
- package/lib/modules/loading.d.ts +2 -2
- package/lib/modules/state.d.ts +21 -21
- package/lib/modules/styleFunction.d.ts +12 -12
- package/lib/myPragma.d.ts +1 -1
- package/lib/ol-wfst.d.ts +336 -336
- package/lib/ol-wfst.d.ts.map +1 -1
- package/lib/ol-wfst.js +2642 -2560
- package/lib/ol-wfst.js.map +1 -1
- package/lib/style/css/ol-wfst.bootstrap5.css +212 -23
- package/lib/style/scss/-ol-wfst.bootstrap5.scss +3 -0
- package/lib/style/scss/ol-wfst.scss +1 -0
- package/lib/tsconfig.tsbuildinfo +1 -0
- package/package.json +13 -12
- package/dist/@enums.d.ts +0 -17
- package/dist/@enums.d.ts.map +0 -1
- package/dist/@types.d.ts +0 -201
- package/dist/@types.d.ts.map +0 -1
- package/dist/Geoserver.d.ts +0 -268
- package/dist/Geoserver.d.ts.map +0 -1
- package/dist/WfsLayer.d.ts +0 -53
- package/dist/WfsLayer.d.ts.map +0 -1
- package/dist/WmsLayer.d.ts +0 -62
- package/dist/WmsLayer.d.ts.map +0 -1
- package/dist/defaults.d.ts +0 -4
- package/dist/defaults.d.ts.map +0 -1
- package/dist/modules/EditControlChanges.d.ts +0 -18
- package/dist/modules/EditControlChanges.d.ts.map +0 -1
- package/dist/modules/EditFieldsModal.d.ts +0 -19
- package/dist/modules/EditFieldsModal.d.ts.map +0 -1
- package/dist/modules/EditOverlay.d.ts +0 -8
- package/dist/modules/EditOverlay.d.ts.map +0 -1
- package/dist/modules/LayersControl.d.ts +0 -34
- package/dist/modules/LayersControl.d.ts.map +0 -1
- package/dist/modules/Uploads.d.ts +0 -50
- package/dist/modules/Uploads.d.ts.map +0 -1
- package/dist/modules/base/BaseLayer.d.ts +0 -62
- package/dist/modules/base/BaseLayer.d.ts.map +0 -1
- package/dist/modules/base/WfsSource.d.ts +0 -48
- package/dist/modules/base/WfsSource.d.ts.map +0 -1
- package/dist/modules/base/WmsSource.d.ts +0 -47
- package/dist/modules/base/WmsSource.d.ts.map +0 -1
- package/dist/modules/editLayer.d.ts +0 -4
- package/dist/modules/editLayer.d.ts.map +0 -1
- package/dist/modules/errors.d.ts +0 -12
- package/dist/modules/errors.d.ts.map +0 -1
- package/dist/modules/helpers.d.ts +0 -7
- package/dist/modules/helpers.d.ts.map +0 -1
- package/dist/modules/i18n/en.d.ts +0 -3
- package/dist/modules/i18n/en.d.ts.map +0 -1
- package/dist/modules/i18n/es.d.ts +0 -3
- package/dist/modules/i18n/es.d.ts.map +0 -1
- package/dist/modules/i18n/index.d.ts +0 -15
- package/dist/modules/i18n/index.d.ts.map +0 -1
- package/dist/modules/i18n/zh.d.ts +0 -3
- package/dist/modules/i18n/zh.d.ts.map +0 -1
- package/dist/modules/loading.d.ts +0 -3
- package/dist/modules/loading.d.ts.map +0 -1
- package/dist/modules/state.d.ts +0 -22
- package/dist/modules/state.d.ts.map +0 -1
- package/dist/modules/styleFunction.d.ts +0 -13
- package/dist/modules/styleFunction.d.ts.map +0 -1
- package/dist/myPragma.d.ts +0 -2
- package/dist/myPragma.d.ts.map +0 -1
- package/dist/ol-wfst.d.ts +0 -337
- package/dist/ol-wfst.d.ts.map +0 -1
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
# OpenLayers WFST
|
|
2
|
-
|
|
1
|
+
# OpenLayers WFST
|
|
2
|
+
|
|
3
3
|
<p align="center">
|
|
4
4
|
<a href="https://www.npmjs.com/package/ol-wfst">
|
|
5
5
|
<img src="https://img.shields.io/npm/v/ol-wfst.svg" alt="npm version">
|
|
@@ -10,20 +10,20 @@
|
|
|
10
10
|
<a href="https://github.com/gastonzalba/ol-wfst/blob/master/LICENSE">
|
|
11
11
|
<img src="https://img.shields.io/npm/l/ol-wfst.svg" alt="license">
|
|
12
12
|
</a>
|
|
13
|
-
</p>
|
|
14
|
-
|
|
15
|
-
Tiny
|
|
16
|
-
|
|
17
|
-
Tested with OpenLayers version 5, 6 and
|
|
18
|
-
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
Tiny WFS-T client to insert (drawing/uploading), modify and delete features on GeoServers using [OpenLayers](https://openlayers.org/). Layers with these types of geometries are supported: *GeometryCollection* (in this case, you can choose the geometry type of each element to draw), *Point*, *MultiPoint*, *LineString*, *MultiLineString*, *Polygon* and *MultiPolygon*.
|
|
16
|
+
|
|
17
|
+
Tested with OpenLayers version 5, 6, 7 and 8.
|
|
18
|
+
|
|
19
19
|
<img src="screenshots/example-1.jpg" alt="Drawing" style="width:50%; float:left;">
|
|
20
|
-
<img src="screenshots/example-2.jpg" alt="Editing fields" style="width:50%; float:left;">
|
|
21
|
-
|
|
22
|
-
## Usage
|
|
23
|
-
|
|
24
|
-
See [Wfst Options](#options) for more details.
|
|
25
|
-
|
|
26
|
-
```javascript
|
|
20
|
+
<img src="screenshots/example-2.jpg" alt="Editing fields" style="width:50%; float:left;">
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
See [Wfst Options](#options) for more details.
|
|
25
|
+
|
|
26
|
+
```javascript
|
|
27
27
|
import Wfst, { Geoserver, WmsLayer, WfsLayer } from 'ol-wfst';
|
|
28
28
|
import { Fill, Stroke, Circle, Style } from 'ol/style';
|
|
29
29
|
|
|
@@ -38,7 +38,7 @@ const username = 'username';
|
|
|
38
38
|
const geoserver = {
|
|
39
39
|
url: 'https://mysite.com/geoserver/myworkspace/ows',
|
|
40
40
|
advanced: {
|
|
41
|
-
getCapabilitiesVersion: '
|
|
41
|
+
getCapabilitiesVersion: '2.0.0',
|
|
42
42
|
getFeatureVersion: '1.0.0',
|
|
43
43
|
describeFeatureTypeVersion: '1.1.0',
|
|
44
44
|
lockFeatureVersion: '1.1.0',
|
|
@@ -118,22 +118,22 @@ const wfst = new Wfst({
|
|
|
118
118
|
showUpload: true
|
|
119
119
|
});
|
|
120
120
|
|
|
121
|
-
map.addControl(wfst);
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
### Useful methods
|
|
125
|
-
|
|
126
|
-
See \[#wfsSource]
|
|
127
|
-
|
|
128
|
-
```js
|
|
129
|
-
|
|
130
|
-
wmsLayer.setCustomParam('cql_filter',
|
|
131
|
-
wmsLayer.setCustomParam('env', `tags=true`);
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
### Adding features programatically
|
|
135
|
-
|
|
136
|
-
```js
|
|
121
|
+
map.addControl(wfst);
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Useful methods
|
|
125
|
+
|
|
126
|
+
See \[#wfsSource]
|
|
127
|
+
|
|
128
|
+
```js
|
|
129
|
+
|
|
130
|
+
wmsLayer.setCustomParam('cql_filter', `id = 28`);
|
|
131
|
+
wmsLayer.setCustomParam('env', `tags=true`);
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### Adding features programatically
|
|
135
|
+
|
|
136
|
+
```js
|
|
137
137
|
const feature = new ol.Feature({
|
|
138
138
|
geometry: new ol.geom.MultiPoint([[`-57.1145}`, `-36.2855`]])
|
|
139
139
|
});
|
|
@@ -143,14 +143,14 @@ if (inserted) {
|
|
|
143
143
|
alert('Feature inserted');
|
|
144
144
|
} else {
|
|
145
145
|
alert('Feature not inserted');
|
|
146
|
-
}
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
### Events
|
|
150
|
-
|
|
151
|
-
### wfst instance events
|
|
152
|
-
|
|
153
|
-
```js
|
|
146
|
+
}
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### Events
|
|
150
|
+
|
|
151
|
+
### wfst instance events
|
|
152
|
+
|
|
153
|
+
```js
|
|
154
154
|
wfst.on(
|
|
155
155
|
['modifystart', 'modifyend', 'drawstart', 'drawend', 'load', 'visible'],
|
|
156
156
|
function (evt) {
|
|
@@ -160,501 +160,508 @@ wfst.on(
|
|
|
160
160
|
|
|
161
161
|
wfst.on(['describeFeatureType'], function (evt) {
|
|
162
162
|
console.log(evt.layer, evt.data);
|
|
163
|
-
});
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
### Geoserver events
|
|
167
|
-
|
|
168
|
-
```js
|
|
163
|
+
});
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### Geoserver events
|
|
167
|
+
|
|
168
|
+
```js
|
|
169
169
|
geoserver.on(['getCapabilities'], function (evt) {
|
|
170
170
|
console.log(evt.data);
|
|
171
|
-
});
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
### Layers events
|
|
175
|
-
|
|
176
|
-
#### WMS Layer
|
|
177
|
-
|
|
178
|
-
```js
|
|
171
|
+
});
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### Layers events
|
|
175
|
+
|
|
176
|
+
#### WMS Layer
|
|
177
|
+
|
|
178
|
+
```js
|
|
179
179
|
wmsLayer.on(['change:describeFeatureType'], function (evt) {
|
|
180
180
|
console.log(evt);
|
|
181
|
-
});
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
Source [TileWMS Events](https://openlayers.org/en/latest/apidoc/module-ol_Object.ObjectEvent.html)
|
|
185
|
-
|
|
186
|
-
```js
|
|
187
|
-
wmsLayer.getSource().on([...])
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
#### WFS Layer
|
|
191
|
-
|
|
192
|
-
```js
|
|
181
|
+
});
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
Source [TileWMS Events](https://openlayers.org/en/latest/apidoc/module-ol_Object.ObjectEvent.html)
|
|
185
|
+
|
|
186
|
+
```js
|
|
187
|
+
wmsLayer.getSource().on([...])
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
#### WFS Layer
|
|
191
|
+
|
|
192
|
+
```js
|
|
193
193
|
wfsLayer.on(['change:describeFeatureType'], function (evt) {
|
|
194
194
|
console.log(evt);
|
|
195
|
-
});
|
|
196
|
-
```
|
|
197
|
-
|
|
198
|
-
[VectorSource Events](https://openlayers.org/en/latest/apidoc/module-ol_source_Vector.VectorSourceEvent.html)
|
|
199
|
-
|
|
200
|
-
```js
|
|
195
|
+
});
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
[VectorSource Events](https://openlayers.org/en/latest/apidoc/module-ol_source_Vector.VectorSourceEvent.html)
|
|
199
|
+
|
|
200
|
+
```js
|
|
201
201
|
wfsLayer.getSource().on([...])
|
|
202
|
-
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
### Some considerations
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
## Changelog
|
|
212
|
-
|
|
213
|
-
See [CHANGELOG](./CHANGELOG.md) for details of changes in each release.
|
|
214
|
-
|
|
215
|
-
## Install
|
|
216
|
-
|
|
217
|
-
### Browser
|
|
218
|
-
|
|
219
|
-
#### JS
|
|
220
|
-
|
|
221
|
-
Load `ol-wfst.js` after OpenLayers. The available classes are `Wfst`, `Wfst.Geoserver`, `Wfst.WfsLayer` and `Wfst.WmsLayer`.
|
|
222
|
-
|
|
223
|
-
```HTML
|
|
224
|
-
<script src="https://unpkg.com/ol-wfst@4.
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
#### CSS
|
|
228
|
-
|
|
229
|
-
```HTML
|
|
230
|
-
<link rel="stylesheet" href="https://unpkg.com/ol-wfst@4.
|
|
231
|
-
<link rel="stylesheet" href="https://unpkg.com/ol-wfst@4.
|
|
232
|
-
```
|
|
233
|
-
|
|
234
|
-
### Parcel, Webpack, etc.
|
|
235
|
-
|
|
236
|
-
NPM package: [ol-wfst](https://www.npmjs.com/package/ol-wfst).
|
|
237
|
-
|
|
238
|
-
Install the package via `npm`
|
|
239
|
-
|
|
240
|
-
npm install ol-wfst
|
|
241
|
-
|
|
242
|
-
#### JS
|
|
243
|
-
|
|
244
|
-
```js
|
|
245
|
-
import Wfst, { Geoserver, WmsLayer, WfsLayer } from 'ol-wfst';
|
|
246
|
-
```
|
|
247
|
-
|
|
248
|
-
#### CSS
|
|
249
|
-
|
|
250
|
-
```js
|
|
202
|
+
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
### Some considerations
|
|
206
|
+
|
|
207
|
+
- If the features/vertex appear to be slightly offset after adding them, check the _Number of Decimals_ in your Workplace, you may have to increment that to have a more accurete preview.
|
|
208
|
+
- You can configure a _Basic Authentication_ or an _HTTP Header Proxy Authentication_ with this client, but in some cases is recommended setting that on an reverse proxy on the backend.
|
|
209
|
+
- If you don't use a reverse proxy, remeber configure [cors](https://docs.geoserver.org/latest/en/user/production/container.html#enable-cors)
|
|
210
|
+
|
|
211
|
+
## Changelog
|
|
212
|
+
|
|
213
|
+
See [CHANGELOG](./CHANGELOG.md) for details of changes in each release.
|
|
214
|
+
|
|
215
|
+
## Install
|
|
216
|
+
|
|
217
|
+
### Browser
|
|
218
|
+
|
|
219
|
+
#### JS
|
|
220
|
+
|
|
221
|
+
Load `ol-wfst.js` after OpenLayers. The available classes are `Wfst`, `Wfst.Geoserver`, `Wfst.WfsLayer` and `Wfst.WmsLayer`.
|
|
222
|
+
|
|
223
|
+
```HTML
|
|
224
|
+
<script src="https://unpkg.com/ol-wfst@4.2.0"></script>
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
#### CSS
|
|
228
|
+
|
|
229
|
+
```HTML
|
|
230
|
+
<link rel="stylesheet" href="https://unpkg.com/ol-wfst@4.2.0/dist/css/ol-wfst.min.css" />
|
|
231
|
+
<link rel="stylesheet" href="https://unpkg.com/ol-wfst@4.2.0/dist/css/ol-wfst.bootstrap5.min.css" />
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
### Parcel, Webpack, etc.
|
|
235
|
+
|
|
236
|
+
NPM package: [ol-wfst](https://www.npmjs.com/package/ol-wfst).
|
|
237
|
+
|
|
238
|
+
Install the package via `npm`
|
|
239
|
+
|
|
240
|
+
npm install ol-wfst
|
|
241
|
+
|
|
242
|
+
#### JS
|
|
243
|
+
|
|
244
|
+
```js
|
|
245
|
+
import Wfst, { Geoserver, WmsLayer, WfsLayer } from 'ol-wfst';
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
#### CSS
|
|
249
|
+
|
|
250
|
+
```js
|
|
251
251
|
// scss
|
|
252
252
|
import 'ol-wfst/lib/style/scss/ol-wfst.scss';
|
|
253
253
|
import 'ol-wfst/lib/style/scss/-ol-wfst.bootstrap5.scss';
|
|
254
254
|
|
|
255
255
|
// or css
|
|
256
256
|
import 'ol-wfst/lib/style/css/ol-wfst.css';
|
|
257
|
-
import 'ol-wfst/lib/style/css/ol-wfst.bootstrap5.css';
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
#### TypeScript type definition
|
|
261
|
-
|
|
262
|
-
TypeScript types are shipped with the project in the dist directory and should be automatically used in a TypeScript project. Interfaces are provided for Wfst Options.
|
|
263
|
-
|
|
264
|
-
## API
|
|
265
|
-
|
|
266
|
-
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
|
|
267
|
-
|
|
268
|
-
#### Table of Contents
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
257
|
+
import 'ol-wfst/lib/style/css/ol-wfst.bootstrap5.css';
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
#### TypeScript type definition
|
|
261
|
+
|
|
262
|
+
TypeScript types are shipped with the project in the dist directory and should be automatically used in a TypeScript project. Interfaces are provided for Wfst Options.
|
|
263
|
+
|
|
264
|
+
## API
|
|
265
|
+
|
|
266
|
+
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
|
|
267
|
+
|
|
268
|
+
#### Table of Contents
|
|
269
|
+
|
|
270
|
+
- [BaseGeoserverVendor](#basegeoservervendor)
|
|
271
|
+
- [key](#key)
|
|
272
|
+
- [cql_filter](#cql_filter)
|
|
273
|
+
- [sortBy](#sortby)
|
|
274
|
+
- [featureid](#featureid)
|
|
275
|
+
- [filter](#filter)
|
|
276
|
+
- [format_options](#format_options)
|
|
277
|
+
- [maxFeatures](#maxfeatures)
|
|
278
|
+
- [startIndex](#startindex)
|
|
279
|
+
- [propertyname](#propertyname)
|
|
280
|
+
- [Wfst](#wfst)
|
|
281
|
+
- [Parameters](#parameters)
|
|
282
|
+
- [getLayers](#getlayers)
|
|
283
|
+
- [getLayerByName](#getlayerbyname)
|
|
284
|
+
- [Parameters](#parameters-1)
|
|
285
|
+
- [activateDrawMode](#activatedrawmode)
|
|
286
|
+
- [Parameters](#parameters-2)
|
|
287
|
+
- [activateEditMode](#activateeditmode)
|
|
288
|
+
- [Parameters](#parameters-3)
|
|
289
|
+
- [Geoserver](#geoserver)
|
|
290
|
+
- [Parameters](#parameters-4)
|
|
291
|
+
- [getCapabilities](#getcapabilities)
|
|
292
|
+
- [getParsedCapabilities](#getparsedcapabilities)
|
|
293
|
+
- [setUrl](#seturl)
|
|
294
|
+
- [Parameters](#parameters-5)
|
|
295
|
+
- [getUrl](#geturl)
|
|
296
|
+
- [setHeaders](#setheaders)
|
|
297
|
+
- [Parameters](#parameters-6)
|
|
298
|
+
- [getHeaders](#getheaders)
|
|
299
|
+
- [setCredentials](#setcredentials)
|
|
300
|
+
- [Parameters](#parameters-7)
|
|
301
|
+
- [getCredentials](#getcredentials)
|
|
302
|
+
- [setAdvanced](#setadvanced)
|
|
303
|
+
- [Parameters](#parameters-8)
|
|
304
|
+
- [getAdvanced](#getadvanced)
|
|
305
|
+
- [hasTransaction](#hastransaction)
|
|
306
|
+
- [hasLockFeature](#haslockfeature)
|
|
307
|
+
- [getUseLockFeature](#getuselockfeature)
|
|
308
|
+
- [setUseLockFeature](#setuselockfeature)
|
|
309
|
+
- [Parameters](#parameters-9)
|
|
310
|
+
- [isLoaded](#isloaded)
|
|
311
|
+
- [getState](#getstate)
|
|
312
|
+
- [getAndUpdateCapabilities](#getandupdatecapabilities)
|
|
313
|
+
- [\_removeFeatures](#_removefeatures)
|
|
314
|
+
- [Parameters](#parameters-10)
|
|
315
|
+
- [lockFeature](#lockfeature)
|
|
316
|
+
- [Parameters](#parameters-11)
|
|
317
|
+
- [WfsLayer](#wfslayer)
|
|
318
|
+
- [Parameters](#parameters-12)
|
|
319
|
+
- [refresh](#refresh)
|
|
320
|
+
- [setCustomParam](#setcustomparam)
|
|
321
|
+
- [Parameters](#parameters-13)
|
|
322
|
+
- [WmsLayer](#wmslayer)
|
|
323
|
+
- [Parameters](#parameters-14)
|
|
324
|
+
- [refresh](#refresh-1)
|
|
325
|
+
- [setCustomParam](#setcustomparam-1)
|
|
326
|
+
- [Parameters](#parameters-15)
|
|
327
|
+
- [Options](#options)
|
|
328
|
+
- [processUpload](#processupload)
|
|
329
|
+
- [Parameters](#parameters-16)
|
|
330
|
+
- [layers](#layers)
|
|
331
|
+
- [active](#active)
|
|
332
|
+
- [evtType](#evttype)
|
|
333
|
+
- [showControl](#showcontrol)
|
|
334
|
+
- [modal](#modal)
|
|
335
|
+
- [language](#language)
|
|
336
|
+
- [i18n](#i18n)
|
|
337
|
+
- [showUpload](#showupload)
|
|
338
|
+
- [uploadFormats](#uploadformats)
|
|
339
|
+
- [LayerOptions](#layeroptions)
|
|
340
|
+
- [beforeTransactFeature](#beforetransactfeature)
|
|
341
|
+
- [Parameters](#parameters-17)
|
|
342
|
+
- [name](#name)
|
|
343
|
+
- [geoserver](#geoserver-1)
|
|
344
|
+
- [label](#label)
|
|
345
|
+
- [geoserverVendor](#geoservervendor)
|
|
346
|
+
- [strategy](#strategy)
|
|
347
|
+
- [GeoserverOptions](#geoserveroptions)
|
|
348
|
+
- [url](#url)
|
|
349
|
+
- [advanced](#advanced)
|
|
350
|
+
- [headers](#headers)
|
|
351
|
+
- [credentials](#credentials)
|
|
352
|
+
- [useLockFeature](#uselockfeature)
|
|
353
|
+
- [GeoServerAdvanced](#geoserveradvanced)
|
|
354
|
+
- [WfsGeoserverVendor](#wfsgeoservervendor)
|
|
355
|
+
- [strict](#strict)
|
|
356
|
+
- [WmsGeoserverVendor](#wmsgeoservervendor)
|
|
357
|
+
- [buffer](#buffer)
|
|
358
|
+
- [env](#env)
|
|
359
|
+
- [clip](#clip)
|
|
360
|
+
- [styles](#styles)
|
|
361
|
+
- [transparent](#transparent)
|
|
362
|
+
- [bgcolor](#bgcolor)
|
|
363
|
+
- [time](#time)
|
|
364
|
+
- [sld](#sld)
|
|
365
|
+
- [sld_body](#sld_body)
|
|
366
|
+
- [IGeoserverDescribeFeatureType](#igeoserverdescribefeaturetype)
|
|
367
|
+
- [\_parsed](#_parsed)
|
|
368
|
+
- [I18n](#i18n-1)
|
|
369
|
+
- [labels](#labels)
|
|
370
|
+
- [errors](#errors)
|
|
371
|
+
|
|
372
|
+
### BaseGeoserverVendor
|
|
373
|
+
|
|
374
|
+
#### key
|
|
375
|
+
|
|
376
|
+
Add any other param
|
|
377
|
+
|
|
378
|
+
#### cql_filter
|
|
379
|
+
|
|
380
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#cql-filter>
|
|
381
|
+
|
|
382
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
383
|
+
|
|
384
|
+
#### sortBy
|
|
385
|
+
|
|
386
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#sortBy>
|
|
387
|
+
|
|
388
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
389
|
+
|
|
390
|
+
#### featureid
|
|
391
|
+
|
|
392
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#featureid>
|
|
393
|
+
|
|
394
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
395
|
+
|
|
396
|
+
#### filter
|
|
397
|
+
|
|
398
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#filter>
|
|
399
|
+
|
|
400
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
401
|
+
|
|
402
|
+
#### format_options
|
|
403
|
+
|
|
403
404
|
WMS: <https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#format-options>
|
|
404
|
-
WFS: <https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html#format-options>
|
|
405
|
-
|
|
406
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
407
|
-
|
|
408
|
-
#### maxFeatures
|
|
409
|
-
|
|
410
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#maxfeatures-and-startindex>
|
|
411
|
-
|
|
412
|
-
Type: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))
|
|
413
|
-
|
|
414
|
-
#### startIndex
|
|
415
|
-
|
|
416
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#maxfeatures-and-startindex>
|
|
417
|
-
|
|
418
|
-
Type: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))
|
|
419
|
-
|
|
420
|
-
#### propertyname
|
|
421
|
-
|
|
422
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#propertyname>
|
|
423
|
-
|
|
424
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
425
|
-
|
|
426
|
-
### Wfst
|
|
427
|
-
|
|
428
|
-
**Extends ol/control/Control~Control**
|
|
429
|
-
|
|
405
|
+
WFS: <https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html#format-options>
|
|
406
|
+
|
|
407
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
408
|
+
|
|
409
|
+
#### maxFeatures
|
|
410
|
+
|
|
411
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#maxfeatures-and-startindex>
|
|
412
|
+
|
|
413
|
+
Type: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))
|
|
414
|
+
|
|
415
|
+
#### startIndex
|
|
416
|
+
|
|
417
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#maxfeatures-and-startindex>
|
|
418
|
+
|
|
419
|
+
Type: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))
|
|
420
|
+
|
|
421
|
+
#### propertyname
|
|
422
|
+
|
|
423
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#propertyname>
|
|
424
|
+
|
|
425
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
426
|
+
|
|
427
|
+
### Wfst
|
|
428
|
+
|
|
429
|
+
**Extends ol/control/[Control](https://openlayers.org/en/latest/apidoc/module-ol_control_Control-Control.html)~[Control](https://openlayers.org/en/latest/apidoc/module-ol_control_Control-Control.html)**
|
|
430
|
+
|
|
430
431
|
Tiny WFST-T client to insert (drawing/uploading), modify and delete
|
|
431
432
|
features on GeoServers using OpenLayers. Layers with these types
|
|
432
433
|
of geometries are supported: "GeometryCollection" (in this case, you can
|
|
433
434
|
choose the geometry type of each element to draw), "Point", "MultiPoint",
|
|
434
|
-
"LineString", "MultiLineString", "Polygon" and "MultiPolygon".
|
|
435
|
-
|
|
436
|
-
#### Parameters
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
#### getLayers
|
|
441
|
-
|
|
442
|
-
Get all the layers in the ol-wfst instance
|
|
443
|
-
|
|
444
|
-
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer))>** 
|
|
445
|
-
|
|
446
|
-
#### getLayerByName
|
|
447
|
-
|
|
448
|
-
Get a layer
|
|
449
|
-
|
|
450
|
-
##### Parameters
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
Returns **([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer))** 
|
|
455
|
-
|
|
456
|
-
#### activateDrawMode
|
|
457
|
-
|
|
458
|
-
Activate/deactivate the draw mode
|
|
459
|
-
|
|
460
|
-
##### Parameters
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
Returns **void** 
|
|
465
|
-
|
|
466
|
-
#### activateEditMode
|
|
467
|
-
|
|
468
|
-
Activate/desactivate the edit mode
|
|
469
|
-
|
|
470
|
-
##### Parameters
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
Returns **void** 
|
|
475
|
-
|
|
476
|
-
### Geoserver
|
|
477
|
-
|
|
478
|
-
**Extends ol/Object~BaseObject**
|
|
479
|
-
|
|
480
|
-
#### Parameters
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
#### getCapabilities
|
|
485
|
-
|
|
486
|
-
Returns **XMLDocument** 
|
|
487
|
-
|
|
488
|
-
####
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
####
|
|
568
|
-
|
|
435
|
+
"LineString", "MultiLineString", "Polygon" and "MultiPolygon".
|
|
436
|
+
|
|
437
|
+
#### Parameters
|
|
438
|
+
|
|
439
|
+
- `options` **[Options](#options)?** Wfst options, see [Wfst Options](#options) for more details.
|
|
440
|
+
|
|
441
|
+
#### getLayers
|
|
442
|
+
|
|
443
|
+
Get all the layers in the ol-wfst instance
|
|
444
|
+
|
|
445
|
+
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer))>** 
|
|
446
|
+
|
|
447
|
+
#### getLayerByName
|
|
448
|
+
|
|
449
|
+
Get a layer
|
|
450
|
+
|
|
451
|
+
##### Parameters
|
|
452
|
+
|
|
453
|
+
- `layerName` (optional, default `''`)
|
|
454
|
+
|
|
455
|
+
Returns **([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer))** 
|
|
456
|
+
|
|
457
|
+
#### activateDrawMode
|
|
458
|
+
|
|
459
|
+
Activate/deactivate the draw mode
|
|
460
|
+
|
|
461
|
+
##### Parameters
|
|
462
|
+
|
|
463
|
+
- `layer` **([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer) | `false`)** 
|
|
464
|
+
|
|
465
|
+
Returns **void** 
|
|
466
|
+
|
|
467
|
+
#### activateEditMode
|
|
468
|
+
|
|
469
|
+
Activate/desactivate the edit mode
|
|
470
|
+
|
|
471
|
+
##### Parameters
|
|
472
|
+
|
|
473
|
+
- `bool` (optional, default `true`)
|
|
474
|
+
|
|
475
|
+
Returns **void** 
|
|
476
|
+
|
|
477
|
+
### Geoserver
|
|
478
|
+
|
|
479
|
+
**Extends ol/Object~[BaseObject](https://openlayers.org/en/latest/apidoc/module-ol_Object-BaseObject.html)**
|
|
480
|
+
|
|
481
|
+
#### Parameters
|
|
482
|
+
|
|
483
|
+
- `options` **[GeoserverOptions](#geoserveroptions)** 
|
|
484
|
+
|
|
485
|
+
#### getCapabilities
|
|
486
|
+
|
|
487
|
+
Returns **XMLDocument** 
|
|
488
|
+
|
|
489
|
+
#### getParsedCapabilities
|
|
490
|
+
|
|
491
|
+
Only work for `2.0.0` getCapabilities version
|
|
492
|
+
|
|
493
|
+
Returns **any** 
|
|
494
|
+
|
|
495
|
+
#### setUrl
|
|
496
|
+
|
|
497
|
+
##### Parameters
|
|
498
|
+
|
|
499
|
+
- `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
500
|
+
- `opt_silent` (optional, default `false`)
|
|
501
|
+
|
|
502
|
+
Returns **void** 
|
|
503
|
+
|
|
504
|
+
#### getUrl
|
|
505
|
+
|
|
506
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
507
|
+
|
|
508
|
+
#### setHeaders
|
|
509
|
+
|
|
510
|
+
##### Parameters
|
|
511
|
+
|
|
512
|
+
- `headers` **HeadersInit** (optional, default `{}`)
|
|
513
|
+
- `opt_silent` (optional, default `false`)
|
|
514
|
+
|
|
515
|
+
Returns **void** 
|
|
516
|
+
|
|
517
|
+
#### getHeaders
|
|
518
|
+
|
|
519
|
+
Returns **HeadersInit** 
|
|
520
|
+
|
|
521
|
+
#### setCredentials
|
|
522
|
+
|
|
523
|
+
##### Parameters
|
|
524
|
+
|
|
525
|
+
- `credentials` **RequestCredentials** (optional, default `null`)
|
|
526
|
+
- `opt_silent` (optional, default `false`)
|
|
527
|
+
|
|
528
|
+
Returns **void** 
|
|
529
|
+
|
|
530
|
+
#### getCredentials
|
|
531
|
+
|
|
532
|
+
Returns **RequestCredentials** 
|
|
533
|
+
|
|
534
|
+
#### setAdvanced
|
|
535
|
+
|
|
536
|
+
##### Parameters
|
|
537
|
+
|
|
538
|
+
- `advanced` **[GeoServerAdvanced](#geoserveradvanced)** (optional, default `{}`)
|
|
539
|
+
- `opt_silent` (optional, default `false`)
|
|
540
|
+
|
|
541
|
+
Returns **void** 
|
|
542
|
+
|
|
543
|
+
#### getAdvanced
|
|
544
|
+
|
|
545
|
+
Returns **[GeoServerAdvanced](#geoserveradvanced)** 
|
|
546
|
+
|
|
547
|
+
#### hasTransaction
|
|
548
|
+
|
|
549
|
+
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
550
|
+
|
|
551
|
+
#### hasLockFeature
|
|
552
|
+
|
|
553
|
+
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
554
|
+
|
|
555
|
+
#### getUseLockFeature
|
|
556
|
+
|
|
557
|
+
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
558
|
+
|
|
559
|
+
#### setUseLockFeature
|
|
560
|
+
|
|
561
|
+
##### Parameters
|
|
562
|
+
|
|
563
|
+
- `useLockFeature` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
564
|
+
- `opt_silent` (optional, default `false`)
|
|
565
|
+
|
|
566
|
+
Returns **void** 
|
|
567
|
+
|
|
568
|
+
#### isLoaded
|
|
569
|
+
|
|
570
|
+
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
571
|
+
|
|
572
|
+
#### getState
|
|
573
|
+
|
|
574
|
+
#### getAndUpdateCapabilities
|
|
575
|
+
|
|
569
576
|
Get the capabilities from the GeoServer and check
|
|
570
|
-
all the available operations.
|
|
571
|
-
|
|
572
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<XMLDocument>** 
|
|
573
|
-
|
|
574
|
-
#### \_removeFeatures
|
|
575
|
-
|
|
576
|
-
##### Parameters
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
#### lockFeature
|
|
581
|
-
|
|
577
|
+
all the available operations.
|
|
578
|
+
|
|
579
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<XMLDocument>** 
|
|
580
|
+
|
|
581
|
+
#### \_removeFeatures
|
|
582
|
+
|
|
583
|
+
##### Parameters
|
|
584
|
+
|
|
585
|
+
- `features` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Feature\<Geometry>>** 
|
|
586
|
+
|
|
587
|
+
#### lockFeature
|
|
588
|
+
|
|
582
589
|
Lock a feature in the geoserver. Useful before editing a geometry,
|
|
583
|
-
to avoid changes from multiples suers
|
|
584
|
-
|
|
585
|
-
##### Parameters
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
|
|
592
|
-
|
|
593
|
-
### WfsLayer
|
|
594
|
-
|
|
595
|
-
**Extends ol/layer/Vector~VectorLayer**
|
|
596
|
-
|
|
590
|
+
to avoid changes from multiples suers
|
|
591
|
+
|
|
592
|
+
##### Parameters
|
|
593
|
+
|
|
594
|
+
- `featureId` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))** 
|
|
595
|
+
- `layerName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
596
|
+
- `retry` (optional, default `0`)
|
|
597
|
+
|
|
598
|
+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
|
|
599
|
+
|
|
600
|
+
### WfsLayer
|
|
601
|
+
|
|
602
|
+
**Extends ol/layer/Vector~[VectorLayer](https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html)**
|
|
603
|
+
|
|
597
604
|
Layer to retrieve WFS features from geoservers
|
|
598
|
-
<https://docs.geoserver.org/stable/en/user/services/wfs/reference.html>
|
|
599
|
-
|
|
600
|
-
#### Parameters
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
#### refresh
|
|
605
|
-
|
|
606
|
-
#### setCustomParam
|
|
607
|
-
|
|
605
|
+
<https://docs.geoserver.org/stable/en/user/services/wfs/reference.html>
|
|
606
|
+
|
|
607
|
+
#### Parameters
|
|
608
|
+
|
|
609
|
+
- `options` **[LayerOptions](#layeroptions)** 
|
|
610
|
+
|
|
611
|
+
#### refresh
|
|
612
|
+
|
|
613
|
+
#### setCustomParam
|
|
614
|
+
|
|
608
615
|
Use this to update Geoserver Wms Vendors (<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html>)
|
|
609
616
|
and other arguements (<https://docs.geoserver.org/stable/en/user/services/wms/reference.html#getmap>)
|
|
610
|
-
in all the getMap requests.
|
|
611
|
-
|
|
612
|
-
Example: you can use this to change the style of the WMS, add a custom sld, set a
|
|
613
|
-
|
|
614
|
-
##### Parameters
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
Returns **URLSearchParams** 
|
|
621
|
-
|
|
622
|
-
### WmsLayer
|
|
623
|
-
|
|
624
|
-
**Extends ol/layer/Tile~TileLayer**
|
|
625
|
-
|
|
617
|
+
in all the getMap requests.
|
|
618
|
+
|
|
619
|
+
Example: you can use this to change the style of the WMS, add a custom sld, set a cql_filter, etc.
|
|
620
|
+
|
|
621
|
+
##### Parameters
|
|
622
|
+
|
|
623
|
+
- `paramName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
624
|
+
- `value` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Use `undefined` or `null` to remove the param (optional, default `null`)
|
|
625
|
+
- `refresh` (optional, default `true`)
|
|
626
|
+
|
|
627
|
+
Returns **URLSearchParams** 
|
|
628
|
+
|
|
629
|
+
### WmsLayer
|
|
630
|
+
|
|
631
|
+
**Extends ol/layer/Tile~[TileLayer](https://openlayers.org/en/latest/apidoc/module-ol_layer_Tile-TileLayer.html)**
|
|
632
|
+
|
|
626
633
|
Layer to retrieve WMS information from geoservers
|
|
627
|
-
<https://docs.geoserver.org/stable/en/user/services/wms/reference.html>
|
|
628
|
-
|
|
629
|
-
#### Parameters
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
#### refresh
|
|
634
|
-
|
|
635
|
-
#### setCustomParam
|
|
636
|
-
|
|
634
|
+
<https://docs.geoserver.org/stable/en/user/services/wms/reference.html>
|
|
635
|
+
|
|
636
|
+
#### Parameters
|
|
637
|
+
|
|
638
|
+
- `options` **[LayerOptions](#layeroptions)** 
|
|
639
|
+
|
|
640
|
+
#### refresh
|
|
641
|
+
|
|
642
|
+
#### setCustomParam
|
|
643
|
+
|
|
637
644
|
Use this to update Geoserver Wfs Vendors (<https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html>)
|
|
638
645
|
and other arguements (<https://docs.geoserver.org/stable/en/user/services/wfs/reference.html>)
|
|
639
|
-
in all the getFeature requests.
|
|
640
|
-
|
|
641
|
-
Example: you can use this to set a
|
|
642
|
-
|
|
643
|
-
##### Parameters
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
Returns **URLSearchParams** 
|
|
650
|
-
|
|
651
|
-
### Options
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
Default values:
|
|
656
|
-
|
|
657
|
-
```javascript
|
|
646
|
+
in all the getFeature requests.
|
|
647
|
+
|
|
648
|
+
Example: you can use this to set a cql_filter, limit the numbers of features, etc.
|
|
649
|
+
|
|
650
|
+
##### Parameters
|
|
651
|
+
|
|
652
|
+
- `paramName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
653
|
+
- `value` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (optional, default `null`)
|
|
654
|
+
- `refresh` (optional, default `true`)
|
|
655
|
+
|
|
656
|
+
Returns **URLSearchParams** 
|
|
657
|
+
|
|
658
|
+
### Options
|
|
659
|
+
|
|
660
|
+
**_\[interface]_** - Wfst Options specified when creating a Wfst instance
|
|
661
|
+
|
|
662
|
+
Default values:
|
|
663
|
+
|
|
664
|
+
```javascript
|
|
658
665
|
{
|
|
659
666
|
layers: null,
|
|
660
667
|
evtType: 'singleclick',
|
|
@@ -664,189 +671,189 @@ Default values:
|
|
|
664
671
|
i18n: {...}, // according to language selection
|
|
665
672
|
uploadFormats: '.geojson,.json,.kml',
|
|
666
673
|
processUpload: null,
|
|
667
|
-
}
|
|
668
|
-
```
|
|
669
|
-
|
|
670
|
-
#### processUpload
|
|
671
|
-
|
|
674
|
+
}
|
|
675
|
+
```
|
|
676
|
+
|
|
677
|
+
#### processUpload
|
|
678
|
+
|
|
672
679
|
Triggered to allow implement custom functions or to parse other formats than default
|
|
673
680
|
by filtering the extension. If this doesn't return features, the default function
|
|
674
|
-
will be used to extract them.
|
|
675
|
-
|
|
676
|
-
##### Parameters
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Feature\<Geometry>>** 
|
|
681
|
-
|
|
682
|
-
#### layers
|
|
683
|
-
|
|
684
|
-
Layers to be loaded from the geoserver
|
|
685
|
-
|
|
686
|
-
Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer))>
|
|
687
|
-
|
|
688
|
-
#### active
|
|
689
|
-
|
|
690
|
-
Init active
|
|
691
|
-
|
|
692
|
-
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
693
|
-
|
|
694
|
-
#### evtType
|
|
695
|
-
|
|
696
|
-
The click event to allow selection of Features to be edited
|
|
697
|
-
|
|
698
|
-
Type: (`"singleclick"` | `"dblclick"`)
|
|
699
|
-
|
|
700
|
-
#### showControl
|
|
701
|
-
|
|
702
|
-
Show/hide the control map
|
|
703
|
-
|
|
704
|
-
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
705
|
-
|
|
706
|
-
#### modal
|
|
707
|
-
|
|
708
|
-
Modal configuration
|
|
709
|
-
|
|
710
|
-
Type: {animateClass: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, animateInClass: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, transition: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?, backdropTransition: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?, templates: {dialog: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element))?, headerClose: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element))?}?}
|
|
711
|
-
|
|
712
|
-
#### language
|
|
713
|
-
|
|
714
|
-
Language to be used
|
|
715
|
-
|
|
716
|
-
Type: (`"es"` | `"en"` | `"zh"`)
|
|
717
|
-
|
|
718
|
-
#### i18n
|
|
719
|
-
|
|
720
|
-
Custom translations
|
|
721
|
-
|
|
722
|
-
Type: [I18n](#i18n)
|
|
723
|
-
|
|
724
|
-
#### showUpload
|
|
725
|
-
|
|
726
|
-
Show/hide the upload button
|
|
727
|
-
|
|
728
|
-
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
729
|
-
|
|
730
|
-
#### uploadFormats
|
|
731
|
-
|
|
681
|
+
will be used to extract them.
|
|
682
|
+
|
|
683
|
+
##### Parameters
|
|
684
|
+
|
|
685
|
+
- `file` **File** 
|
|
686
|
+
|
|
687
|
+
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Feature\<Geometry>>** 
|
|
688
|
+
|
|
689
|
+
#### layers
|
|
690
|
+
|
|
691
|
+
Layers to be loaded from the geoserver
|
|
692
|
+
|
|
693
|
+
Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer))>
|
|
694
|
+
|
|
695
|
+
#### active
|
|
696
|
+
|
|
697
|
+
Init active
|
|
698
|
+
|
|
699
|
+
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
700
|
+
|
|
701
|
+
#### evtType
|
|
702
|
+
|
|
703
|
+
The click event to allow selection of Features to be edited
|
|
704
|
+
|
|
705
|
+
Type: (`"singleclick"` | `"dblclick"`)
|
|
706
|
+
|
|
707
|
+
#### showControl
|
|
708
|
+
|
|
709
|
+
Show/hide the control map
|
|
710
|
+
|
|
711
|
+
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
712
|
+
|
|
713
|
+
#### modal
|
|
714
|
+
|
|
715
|
+
Modal configuration
|
|
716
|
+
|
|
717
|
+
Type: {animateClass: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, animateInClass: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, transition: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?, backdropTransition: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?, templates: {dialog: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element))?, headerClose: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [HTMLElement](https://developer.mozilla.org/docs/Web/HTML/Element))?}?}
|
|
718
|
+
|
|
719
|
+
#### language
|
|
720
|
+
|
|
721
|
+
Language to be used
|
|
722
|
+
|
|
723
|
+
Type: (`"es"` | `"en"` | `"zh"`)
|
|
724
|
+
|
|
725
|
+
#### i18n
|
|
726
|
+
|
|
727
|
+
Custom translations
|
|
728
|
+
|
|
729
|
+
Type: [I18n](#i18n)
|
|
730
|
+
|
|
731
|
+
#### showUpload
|
|
732
|
+
|
|
733
|
+
Show/hide the upload button
|
|
734
|
+
|
|
735
|
+
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
736
|
+
|
|
737
|
+
#### uploadFormats
|
|
738
|
+
|
|
732
739
|
Accepted extension formats on upload
|
|
733
|
-
Example: ".json,.geojson"
|
|
734
|
-
|
|
735
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
736
|
-
|
|
737
|
-
### LayerOptions
|
|
738
|
-
|
|
739
|
-
**Extends Omit\<VectorLayerOptions\<any>, 'source'>**
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
You can use all the parameters supported by OpenLayers
|
|
744
|
-
|
|
745
|
-
Default values:
|
|
746
|
-
|
|
747
|
-
```javascript
|
|
740
|
+
Example: ".json,.geojson"
|
|
741
|
+
|
|
742
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
743
|
+
|
|
744
|
+
### LayerOptions
|
|
745
|
+
|
|
746
|
+
**Extends Omit\<[VectorLayerOptions](https://openlayers.org/en/latest/apidoc/module-ol_layer_Vector-VectorLayer.html)\<any>, 'source'>**
|
|
747
|
+
|
|
748
|
+
**_\[interface]_** - Parameters to create the layers and connect to the GeoServer
|
|
749
|
+
|
|
750
|
+
You can use all the parameters supported by OpenLayers
|
|
751
|
+
|
|
752
|
+
Default values:
|
|
753
|
+
|
|
754
|
+
```javascript
|
|
748
755
|
{
|
|
749
756
|
name: null,
|
|
750
757
|
geoserver: null,
|
|
751
758
|
label: null, // `name` if not provided
|
|
752
759
|
strategy: all,
|
|
753
760
|
geoserverVendor: null
|
|
754
|
-
}
|
|
755
|
-
```
|
|
756
|
-
|
|
757
|
-
#### beforeTransactFeature
|
|
758
|
-
|
|
761
|
+
}
|
|
762
|
+
```
|
|
763
|
+
|
|
764
|
+
#### beforeTransactFeature
|
|
765
|
+
|
|
759
766
|
Triggered before inserting new features to the Geoserver.
|
|
760
|
-
Use this to insert custom properties, modify the feature, etc.
|
|
761
|
-
|
|
762
|
-
##### Parameters
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
Returns **Feature\<Geometry>** 
|
|
768
|
-
|
|
769
|
-
#### name
|
|
770
|
-
|
|
771
|
-
Layer name in the GeoServer
|
|
772
|
-
|
|
773
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
774
|
-
|
|
775
|
-
#### geoserver
|
|
776
|
-
|
|
777
|
-
Geoserver Object
|
|
778
|
-
|
|
779
|
-
Type: [Geoserver](#geoserver)
|
|
780
|
-
|
|
781
|
-
#### label
|
|
782
|
-
|
|
783
|
-
Label to be displayed in the widget control
|
|
784
|
-
|
|
785
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
786
|
-
|
|
787
|
-
#### geoserverVendor
|
|
788
|
-
|
|
789
|
-
Available geoserver options
|
|
790
|
-
|
|
791
|
-
Type: ([WfsGeoserverVendor](#wfsgeoservervendor) | [WmsGeoserverVendor](#wmsgeoservervendor))
|
|
792
|
-
|
|
793
|
-
#### strategy
|
|
794
|
-
|
|
767
|
+
Use this to insert custom properties, modify the feature, etc.
|
|
768
|
+
|
|
769
|
+
##### Parameters
|
|
770
|
+
|
|
771
|
+
- `feature` **Feature\<Geometry>** 
|
|
772
|
+
- `transaction` **TransactionType** 
|
|
773
|
+
|
|
774
|
+
Returns **Feature\<Geometry>** 
|
|
775
|
+
|
|
776
|
+
#### name
|
|
777
|
+
|
|
778
|
+
Layer name in the GeoServer
|
|
779
|
+
|
|
780
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
781
|
+
|
|
782
|
+
#### geoserver
|
|
783
|
+
|
|
784
|
+
Geoserver Object
|
|
785
|
+
|
|
786
|
+
Type: [Geoserver](#geoserver)
|
|
787
|
+
|
|
788
|
+
#### label
|
|
789
|
+
|
|
790
|
+
Label to be displayed in the widget control
|
|
791
|
+
|
|
792
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
793
|
+
|
|
794
|
+
#### geoserverVendor
|
|
795
|
+
|
|
796
|
+
Available geoserver options
|
|
797
|
+
|
|
798
|
+
Type: ([WfsGeoserverVendor](#wfsgeoservervendor) | [WmsGeoserverVendor](#wmsgeoservervendor))
|
|
799
|
+
|
|
800
|
+
#### strategy
|
|
801
|
+
|
|
795
802
|
Strategy function for loading features.
|
|
796
803
|
Only for WFS
|
|
797
|
-
By default `all` strategy is used
|
|
798
|
-
|
|
799
|
-
Type: LoadingStrategy
|
|
800
|
-
|
|
801
|
-
### GeoserverOptions
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
#### url
|
|
806
|
-
|
|
807
|
-
Url for OWS services. This endpoint will recive the WFS, WFST and WMS requests
|
|
808
|
-
|
|
809
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
810
|
-
|
|
811
|
-
#### advanced
|
|
812
|
-
|
|
813
|
-
Advanced options for geoserver requests
|
|
814
|
-
|
|
815
|
-
Type: [GeoServerAdvanced](#geoserveradvanced)
|
|
816
|
-
|
|
817
|
-
#### headers
|
|
818
|
-
|
|
804
|
+
By default `all` strategy is used
|
|
805
|
+
|
|
806
|
+
Type: LoadingStrategy
|
|
807
|
+
|
|
808
|
+
### GeoserverOptions
|
|
809
|
+
|
|
810
|
+
**_\[interface]_**
|
|
811
|
+
|
|
812
|
+
#### url
|
|
813
|
+
|
|
814
|
+
Url for OWS services. This endpoint will recive the WFS, WFST and WMS requests
|
|
815
|
+
|
|
816
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
817
|
+
|
|
818
|
+
#### advanced
|
|
819
|
+
|
|
820
|
+
Advanced options for geoserver requests
|
|
821
|
+
|
|
822
|
+
Type: [GeoServerAdvanced](#geoserveradvanced)
|
|
823
|
+
|
|
824
|
+
#### headers
|
|
825
|
+
|
|
819
826
|
Http headers for GeoServer requests
|
|
820
|
-
<https://developer.mozilla.org/en-US/docs/Web/API/Request/headers>
|
|
821
|
-
|
|
822
|
-
Type: HeadersInit
|
|
823
|
-
|
|
824
|
-
#### credentials
|
|
825
|
-
|
|
827
|
+
<https://developer.mozilla.org/en-US/docs/Web/API/Request/headers>
|
|
828
|
+
|
|
829
|
+
Type: HeadersInit
|
|
830
|
+
|
|
831
|
+
#### credentials
|
|
832
|
+
|
|
826
833
|
Credentials for fetch requests
|
|
827
|
-
<https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials>
|
|
828
|
-
|
|
829
|
-
Default is 'same-origin'
|
|
830
|
-
|
|
831
|
-
Type: RequestCredentials
|
|
832
|
-
|
|
833
|
-
#### useLockFeature
|
|
834
|
-
|
|
834
|
+
<https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials>
|
|
835
|
+
|
|
836
|
+
Default is 'same-origin'
|
|
837
|
+
|
|
838
|
+
Type: RequestCredentials
|
|
839
|
+
|
|
840
|
+
#### useLockFeature
|
|
841
|
+
|
|
835
842
|
Use LockFeatue request on GeoServer when selecting features. Prevents a feature from being edited
|
|
836
843
|
through a persistent feature lock. This is not always supportedd by the GeoServer.
|
|
837
|
-
See <https://docs.geoserver.org/stable/en/user/services/wfs/reference.html>
|
|
838
|
-
|
|
839
|
-
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
840
|
-
|
|
841
|
-
### GeoServerAdvanced
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
```javascript
|
|
844
|
+
See <https://docs.geoserver.org/stable/en/user/services/wfs/reference.html>
|
|
845
|
+
|
|
846
|
+
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
847
|
+
|
|
848
|
+
### GeoServerAdvanced
|
|
849
|
+
|
|
850
|
+
**_\[interface]_**
|
|
851
|
+
|
|
852
|
+
- Default values:
|
|
853
|
+
|
|
854
|
+
```javascript
|
|
848
855
|
{
|
|
849
|
-
getCapabilitiesVersion: '
|
|
856
|
+
getCapabilitiesVersion: '2.0.0',
|
|
850
857
|
getFeatureVersion: '1.0.0',
|
|
851
858
|
describeFeatureTypeVersion: '1.1.0',
|
|
852
859
|
lockFeatureVersion: '1.1.0',
|
|
@@ -857,126 +864,126 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob
|
|
|
857
864
|
lockId: 'Geoserver',
|
|
858
865
|
releaseAction: 'SOME'
|
|
859
866
|
}
|
|
860
|
-
}
|
|
861
|
-
```
|
|
862
|
-
|
|
863
|
-
### WfsGeoserverVendor
|
|
864
|
-
|
|
865
|
-
**Extends BaseGeoserverVendor**
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
<https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html>
|
|
869
|
-
|
|
870
|
-
#### strict
|
|
871
|
-
|
|
872
|
-
<https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html#xml-request-validation>
|
|
873
|
-
|
|
874
|
-
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
875
|
-
|
|
876
|
-
### WmsGeoserverVendor
|
|
877
|
-
|
|
878
|
-
**Extends BaseGeoserverVendor**
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html>
|
|
882
|
-
|
|
883
|
-
#### buffer
|
|
884
|
-
|
|
885
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#buffer>
|
|
886
|
-
|
|
887
|
-
Type: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))
|
|
888
|
-
|
|
889
|
-
#### env
|
|
890
|
-
|
|
891
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#env>
|
|
892
|
-
|
|
893
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
894
|
-
|
|
895
|
-
#### clip
|
|
896
|
-
|
|
897
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#clip>
|
|
898
|
-
|
|
899
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
900
|
-
|
|
901
|
-
#### styles
|
|
902
|
-
|
|
867
|
+
}
|
|
868
|
+
```
|
|
869
|
+
|
|
870
|
+
### WfsGeoserverVendor
|
|
871
|
+
|
|
872
|
+
**Extends BaseGeoserverVendor**
|
|
873
|
+
|
|
874
|
+
**_\[interface]_** - WFS geoserver options
|
|
875
|
+
<https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html>
|
|
876
|
+
|
|
877
|
+
#### strict
|
|
878
|
+
|
|
879
|
+
<https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html#xml-request-validation>
|
|
880
|
+
|
|
881
|
+
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
882
|
+
|
|
883
|
+
### WmsGeoserverVendor
|
|
884
|
+
|
|
885
|
+
**Extends BaseGeoserverVendor**
|
|
886
|
+
|
|
887
|
+
**_\[interface]_** - WMS geoserver options
|
|
888
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html>
|
|
889
|
+
|
|
890
|
+
#### buffer
|
|
891
|
+
|
|
892
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#buffer>
|
|
893
|
+
|
|
894
|
+
Type: ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))
|
|
895
|
+
|
|
896
|
+
#### env
|
|
897
|
+
|
|
898
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#env>
|
|
899
|
+
|
|
900
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
901
|
+
|
|
902
|
+
#### clip
|
|
903
|
+
|
|
904
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#clip>
|
|
905
|
+
|
|
906
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
907
|
+
|
|
908
|
+
#### styles
|
|
909
|
+
|
|
903
910
|
Styles in which layers are to be rendered.
|
|
904
911
|
Value is a comma-separated list of style names, or empty if default styling is required.
|
|
905
|
-
Style names may be empty in the list, to use default layer styling.
|
|
906
|
-
|
|
907
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
908
|
-
|
|
909
|
-
#### transparent
|
|
910
|
-
|
|
911
|
-
Whether the map background should be transparent. Values are true or false. Default is false
|
|
912
|
-
|
|
913
|
-
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
914
|
-
|
|
915
|
-
#### bgcolor
|
|
916
|
-
|
|
917
|
-
Background color for the map image. Value is in the form RRGGBB. Default is FFFFFF (white).
|
|
918
|
-
|
|
919
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
920
|
-
|
|
921
|
-
#### time
|
|
922
|
-
|
|
912
|
+
Style names may be empty in the list, to use default layer styling.
|
|
913
|
+
|
|
914
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
915
|
+
|
|
916
|
+
#### transparent
|
|
917
|
+
|
|
918
|
+
Whether the map background should be transparent. Values are true or false. Default is false
|
|
919
|
+
|
|
920
|
+
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
921
|
+
|
|
922
|
+
#### bgcolor
|
|
923
|
+
|
|
924
|
+
Background color for the map image. Value is in the form RRGGBB. Default is FFFFFF (white).
|
|
925
|
+
|
|
926
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
927
|
+
|
|
928
|
+
#### time
|
|
929
|
+
|
|
923
930
|
Time value or range for map data.
|
|
924
|
-
See [Time Support in GeoServer WMS](https://docs.geoserver.org/stable/en/user/services/wms/time.html#wms-time) for more information.
|
|
925
|
-
|
|
926
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
927
|
-
|
|
928
|
-
#### sld
|
|
929
|
-
|
|
931
|
+
See [Time Support in GeoServer WMS](https://docs.geoserver.org/stable/en/user/services/wms/time.html#wms-time) for more information.
|
|
932
|
+
|
|
933
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
934
|
+
|
|
935
|
+
#### sld
|
|
936
|
+
|
|
930
937
|
A URL referencing a [StyledLayerDescriptor](https://docs.geoserver.org/stable/en/user/styling/index.html#styling)
|
|
931
|
-
XML file which controls or enhances map layers and styling
|
|
932
|
-
|
|
933
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
934
|
-
|
|
935
|
-
####
|
|
936
|
-
|
|
937
|
-
A URL-encoded StyledLayerDescriptor XML document which controls or enhances map layers and styling
|
|
938
|
-
|
|
939
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
940
|
-
|
|
941
|
-
### IGeoserverDescribeFeatureType
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
#### \_parsed
|
|
946
|
-
|
|
947
|
-
DescribeFeature request parsed
|
|
948
|
-
|
|
949
|
-
Type: {namespace: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), properties: any, geomType: GeometryType, geomField: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}
|
|
950
|
-
|
|
951
|
-
### I18n
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
#### labels
|
|
956
|
-
|
|
957
|
-
Labels section
|
|
958
|
-
|
|
959
|
-
Type: {select: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, addElement: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editElement: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, save: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, delete: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, cancel: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, apply: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, upload: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editMode: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, confirmDelete: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, geomTypeNotSupported: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editFields: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editGeom: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, selectDrawType: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, uploadToLayer: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, uploadFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, validFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, invalidFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, loading: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, toggleVisibility: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, close: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?}
|
|
960
|
-
|
|
961
|
-
#### errors
|
|
962
|
-
|
|
963
|
-
Errors section
|
|
964
|
-
|
|
965
|
-
Type: {capabilities: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, wfst: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, layer: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, layerNotFound: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, layerNotVisible: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, noValidGeometry: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, geoserver: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, badFormat: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, badFile: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, lockFeature: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, transaction: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, getFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?}
|
|
966
|
-
|
|
967
|
-
## TODO
|
|
968
|
-
|
|
969
|
-
*
|
|
970
|
-
*
|
|
971
|
-
*
|
|
972
|
-
* Add `Don't show again` option in the error modal
|
|
973
|
-
* Allow selection of multiples features and bulk edit
|
|
974
|
-
* Add customizables styles
|
|
975
|
-
* Improve scss (add variables)
|
|
976
|
-
* Add cookies to persist widget controller state
|
|
977
|
-
* Geometry type *LinearRing* support
|
|
978
|
-
* Tests!
|
|
979
|
-
* Improve comments and documentation
|
|
980
|
-
* Improve interface
|
|
981
|
-
* Change svg imports to preserve svg structure
|
|
982
|
-
* Improve style on editing and drawing features
|
|
938
|
+
XML file which controls or enhances map layers and styling
|
|
939
|
+
|
|
940
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
941
|
+
|
|
942
|
+
#### sld_body
|
|
943
|
+
|
|
944
|
+
A URL-encoded StyledLayerDescriptor XML document which controls or enhances map layers and styling
|
|
945
|
+
|
|
946
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
947
|
+
|
|
948
|
+
### IGeoserverDescribeFeatureType
|
|
949
|
+
|
|
950
|
+
**_\[interface]_** - Geoserver original response on DescribeFeature request
|
|
951
|
+
|
|
952
|
+
#### \_parsed
|
|
953
|
+
|
|
954
|
+
DescribeFeature request parsed
|
|
955
|
+
|
|
956
|
+
Type: {namespace: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), properties: any, geomType: GeometryType, geomField: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}
|
|
957
|
+
|
|
958
|
+
### I18n
|
|
959
|
+
|
|
960
|
+
**_\[interface]_** - Custom Language specified when creating a WFST instance
|
|
961
|
+
|
|
962
|
+
#### labels
|
|
963
|
+
|
|
964
|
+
Labels section
|
|
965
|
+
|
|
966
|
+
Type: {select: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, addElement: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editElement: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, save: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, delete: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, cancel: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, apply: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, upload: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editMode: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, confirmDelete: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, geomTypeNotSupported: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editFields: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, editGeom: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, selectDrawType: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, uploadToLayer: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, uploadFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, validFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, invalidFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, loading: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, toggleVisibility: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, close: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?}
|
|
967
|
+
|
|
968
|
+
#### errors
|
|
969
|
+
|
|
970
|
+
Errors section
|
|
971
|
+
|
|
972
|
+
Type: {capabilities: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, wfst: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, layer: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, layerNotFound: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, layerNotVisible: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, noValidGeometry: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, geoserver: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, badFormat: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, badFile: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, lockFeature: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, transaction: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, getFeatures: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?}
|
|
973
|
+
|
|
974
|
+
## TODO
|
|
975
|
+
|
|
976
|
+
* ~~Add support to diferent layer styles~~
|
|
977
|
+
* ~~Improve widget controller: visibility toggle~~
|
|
978
|
+
* ~~Add events~~
|
|
979
|
+
* Add `Don't show again` option in the error modal
|
|
980
|
+
* Allow selection of multiples features and bulk edit
|
|
981
|
+
* Add customizables styles
|
|
982
|
+
* Improve scss (add variables)
|
|
983
|
+
* Add cookies to persist widget controller state
|
|
984
|
+
* Geometry type *LinearRing* support
|
|
985
|
+
* Tests!
|
|
986
|
+
* Improve comments and documentation
|
|
987
|
+
* Improve interface
|
|
988
|
+
* Change svg imports to preserve svg structure
|
|
989
|
+
* Improve style on editing and drawing features
|