ol-wfst 4.0.6 → 4.1.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 +790 -782
- package/dist/Geoserver.d.ts +15 -15
- package/dist/Geoserver.d.ts.map +1 -1
- package/dist/WfsLayer.d.ts +10 -10
- package/dist/WfsLayer.d.ts.map +1 -1
- package/dist/WmsLayer.d.ts +11 -11
- package/dist/WmsLayer.d.ts.map +1 -1
- package/dist/modules/EditControlChanges.d.ts +9 -9
- package/dist/modules/EditControlChanges.d.ts.map +1 -1
- package/dist/modules/EditFieldsModal.d.ts +3 -2
- package/dist/modules/EditFieldsModal.d.ts.map +1 -1
- package/dist/modules/EditOverlay.d.ts +4 -3
- package/dist/modules/EditOverlay.d.ts.map +1 -1
- package/dist/modules/LayersControl.d.ts +2 -3
- package/dist/modules/LayersControl.d.ts.map +1 -1
- package/dist/modules/Uploads.d.ts +6 -3
- package/dist/modules/Uploads.d.ts.map +1 -1
- package/dist/modules/base/BaseLayer.d.ts +4 -4
- package/dist/modules/base/BaseLayer.d.ts.map +1 -1
- package/dist/modules/base/WfsSource.d.ts +1 -1
- package/dist/modules/base/WfsSource.d.ts.map +1 -1
- package/dist/modules/base/WmsSource.d.ts +1 -1
- package/dist/modules/base/WmsSource.d.ts.map +1 -1
- package/dist/modules/editLayer.d.ts +2 -2
- package/dist/modules/editLayer.d.ts.map +1 -1
- package/dist/modules/state.d.ts +2 -2
- package/dist/modules/state.d.ts.map +1 -1
- package/dist/modules/styleFunction.d.ts +3 -3
- package/dist/modules/styleFunction.d.ts.map +1 -1
- package/dist/ol-wfst.d.ts +20 -20
- package/dist/ol-wfst.d.ts.map +1 -1
- package/dist/ol-wfst.js +321 -2105
- package/dist/ol-wfst.js.map +1 -1
- package/dist/ol-wfst.min.js +1 -1
- package/dist/ol-wfst.min.js.map +1 -1
- package/lib/Geoserver.d.ts +15 -15
- package/lib/Geoserver.d.ts.map +1 -1
- package/lib/WfsLayer.d.ts +10 -10
- package/lib/WfsLayer.d.ts.map +1 -1
- package/lib/WmsLayer.d.ts +11 -11
- package/lib/WmsLayer.d.ts.map +1 -1
- package/lib/modules/EditControlChanges.d.ts +9 -9
- package/lib/modules/EditControlChanges.d.ts.map +1 -1
- package/lib/modules/EditFieldsModal.d.ts +3 -2
- package/lib/modules/EditFieldsModal.d.ts.map +1 -1
- package/lib/modules/EditOverlay.d.ts +4 -3
- package/lib/modules/EditOverlay.d.ts.map +1 -1
- package/lib/modules/LayersControl.d.ts +2 -3
- package/lib/modules/LayersControl.d.ts.map +1 -1
- package/lib/modules/Uploads.d.ts +6 -3
- package/lib/modules/Uploads.d.ts.map +1 -1
- package/lib/modules/base/BaseLayer.d.ts +4 -4
- package/lib/modules/base/BaseLayer.d.ts.map +1 -1
- package/lib/modules/base/WfsSource.d.ts +1 -1
- package/lib/modules/base/WfsSource.d.ts.map +1 -1
- package/lib/modules/base/WmsSource.d.ts +1 -1
- package/lib/modules/base/WmsSource.d.ts.map +1 -1
- package/lib/modules/editLayer.d.ts +2 -2
- package/lib/modules/editLayer.d.ts.map +1 -1
- package/lib/modules/state.d.ts +2 -2
- package/lib/modules/state.d.ts.map +1 -1
- package/lib/modules/styleFunction.d.ts +3 -3
- package/lib/modules/styleFunction.d.ts.map +1 -1
- package/lib/ol-wfst.d.ts +20 -20
- package/lib/ol-wfst.d.ts.map +1 -1
- package/lib/ol-wfst.js +81 -196
- package/lib/ol-wfst.js.map +1 -1
- package/package.json +5 -5
- package/dist/tsconfig.tsbuildinfo +0 -1
- package/lib/tsconfig.tsbuildinfo +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 WFST-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:
|
|
16
|
-
|
|
17
|
-
Tested with OpenLayers version 5, 6 and 7.
|
|
18
|
-
|
|
13
|
+
</p>
|
|
14
|
+
|
|
15
|
+
Tiny WFST-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 and 7.
|
|
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
|
|
|
@@ -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
|
|
121
|
+
map.addControl(wfst);
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Useful methods
|
|
125
|
+
|
|
126
|
+
See \[#wfsSource]
|
|
127
|
+
|
|
128
|
+
```js
|
|
129
129
|
|
|
130
130
|
wmsLayer.setCustomParam('cql_filter',(`id = 28`);
|
|
131
|
-
wmsLayer.setCustomParam('env', `tags=true`);
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
### Adding features programatically
|
|
135
|
-
|
|
136
|
-
```js
|
|
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,493 +160,501 @@ 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.0
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
#### CSS
|
|
228
|
-
|
|
229
|
-
```HTML
|
|
230
|
-
<link rel="stylesheet" href="https://unpkg.com/ol-wfst@4.0
|
|
231
|
-
<link rel="stylesheet" href="https://unpkg.com/ol-wfst@4.0
|
|
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.1.0"></script>
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
#### CSS
|
|
228
|
+
|
|
229
|
+
```HTML
|
|
230
|
+
<link rel="stylesheet" href="https://unpkg.com/ol-wfst@4.1.0/dist/css/ol-wfst.min.css" />
|
|
231
|
+
<link rel="stylesheet" href="https://unpkg.com/ol-wfst@4.1.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
|
-
|
|
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
|
+
* [setUrl](#seturl)
|
|
293
|
+
* [Parameters](#parameters-5)
|
|
294
|
+
* [getUrl](#geturl)
|
|
295
|
+
* [setHeaders](#setheaders)
|
|
296
|
+
* [Parameters](#parameters-6)
|
|
297
|
+
* [getHeaders](#getheaders)
|
|
298
|
+
* [setCredentials](#setcredentials)
|
|
299
|
+
* [Parameters](#parameters-7)
|
|
300
|
+
* [getCredentials](#getcredentials)
|
|
301
|
+
* [setAdvanced](#setadvanced)
|
|
302
|
+
* [Parameters](#parameters-8)
|
|
303
|
+
* [getAdvanced](#getadvanced)
|
|
304
|
+
* [hasTransaction](#hastransaction)
|
|
305
|
+
* [hasLockFeature](#haslockfeature)
|
|
306
|
+
* [getUseLockFeature](#getuselockfeature)
|
|
307
|
+
* [setUseLockFeature](#setuselockfeature)
|
|
308
|
+
* [Parameters](#parameters-9)
|
|
309
|
+
* [isLoaded](#isloaded)
|
|
310
|
+
* [getState](#getstate)
|
|
311
|
+
* [getAndUpdateCapabilities](#getandupdatecapabilities)
|
|
312
|
+
* [\_removeFeatures](#_removefeatures)
|
|
313
|
+
* [Parameters](#parameters-10)
|
|
314
|
+
* [lockFeature](#lockfeature)
|
|
315
|
+
* [Parameters](#parameters-11)
|
|
316
|
+
* [WfsLayer](#wfslayer)
|
|
317
|
+
* [Parameters](#parameters-12)
|
|
318
|
+
* [refresh](#refresh)
|
|
319
|
+
* [setCustomParam](#setcustomparam)
|
|
320
|
+
* [Parameters](#parameters-13)
|
|
321
|
+
* [WmsLayer](#wmslayer)
|
|
322
|
+
* [Parameters](#parameters-14)
|
|
323
|
+
* [refresh](#refresh-1)
|
|
324
|
+
* [setCustomParam](#setcustomparam-1)
|
|
325
|
+
* [Parameters](#parameters-15)
|
|
326
|
+
* [Options](#options)
|
|
327
|
+
* [processUpload](#processupload)
|
|
328
|
+
* [Parameters](#parameters-16)
|
|
329
|
+
* [layers](#layers)
|
|
330
|
+
* [active](#active)
|
|
331
|
+
* [evtType](#evttype)
|
|
332
|
+
* [showControl](#showcontrol)
|
|
333
|
+
* [modal](#modal)
|
|
334
|
+
* [language](#language)
|
|
335
|
+
* [i18n](#i18n)
|
|
336
|
+
* [showUpload](#showupload)
|
|
337
|
+
* [uploadFormats](#uploadformats)
|
|
338
|
+
* [LayerOptions](#layeroptions)
|
|
339
|
+
* [beforeTransactFeature](#beforetransactfeature)
|
|
340
|
+
* [Parameters](#parameters-17)
|
|
341
|
+
* [name](#name)
|
|
342
|
+
* [geoserver](#geoserver-1)
|
|
343
|
+
* [label](#label)
|
|
344
|
+
* [geoserverVendor](#geoservervendor)
|
|
345
|
+
* [strategy](#strategy)
|
|
346
|
+
* [GeoserverOptions](#geoserveroptions)
|
|
347
|
+
* [url](#url)
|
|
348
|
+
* [advanced](#advanced)
|
|
349
|
+
* [headers](#headers)
|
|
350
|
+
* [credentials](#credentials)
|
|
351
|
+
* [useLockFeature](#uselockfeature)
|
|
352
|
+
* [GeoServerAdvanced](#geoserveradvanced)
|
|
353
|
+
* [WfsGeoserverVendor](#wfsgeoservervendor)
|
|
354
|
+
* [strict](#strict)
|
|
355
|
+
* [WmsGeoserverVendor](#wmsgeoservervendor)
|
|
356
|
+
* [buffer](#buffer)
|
|
357
|
+
* [env](#env)
|
|
358
|
+
* [clip](#clip)
|
|
359
|
+
* [styles](#styles)
|
|
360
|
+
* [transparent](#transparent)
|
|
361
|
+
* [bgcolor](#bgcolor)
|
|
362
|
+
* [time](#time)
|
|
363
|
+
* [sld](#sld)
|
|
364
|
+
* [sld\_body](#sld_body)
|
|
365
|
+
* [IGeoserverDescribeFeatureType](#igeoserverdescribefeaturetype)
|
|
366
|
+
* [\_parsed](#_parsed)
|
|
367
|
+
* [I18n](#i18n-1)
|
|
368
|
+
* [labels](#labels)
|
|
369
|
+
* [errors](#errors)
|
|
370
|
+
|
|
371
|
+
### BaseGeoserverVendor
|
|
372
|
+
|
|
373
|
+
#### key
|
|
374
|
+
|
|
375
|
+
Add any other param
|
|
376
|
+
|
|
377
|
+
#### cql\_filter
|
|
378
|
+
|
|
379
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#cql-filter>
|
|
380
|
+
|
|
381
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
382
|
+
|
|
383
|
+
#### sortBy
|
|
384
|
+
|
|
385
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#sortBy>
|
|
386
|
+
|
|
387
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
388
|
+
|
|
389
|
+
#### featureid
|
|
390
|
+
|
|
391
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#featureid>
|
|
392
|
+
|
|
393
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
394
|
+
|
|
395
|
+
#### filter
|
|
396
|
+
|
|
397
|
+
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#filter>
|
|
398
|
+
|
|
399
|
+
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
400
|
+
|
|
401
|
+
#### format\_options
|
|
402
|
+
|
|
401
403
|
WMS: <https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#format-options>
|
|
402
|
-
WFS: <https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html#format-options>
|
|
403
|
-
|
|
404
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
405
|
-
|
|
406
|
-
#### maxFeatures
|
|
407
|
-
|
|
408
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#maxfeatures-and-startindex>
|
|
409
|
-
|
|
410
|
-
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))
|
|
411
|
-
|
|
412
|
-
#### startIndex
|
|
413
|
-
|
|
414
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#maxfeatures-and-startindex>
|
|
415
|
-
|
|
416
|
-
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))
|
|
417
|
-
|
|
418
|
-
#### propertyname
|
|
419
|
-
|
|
420
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#propertyname>
|
|
421
|
-
|
|
422
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
423
|
-
|
|
424
|
-
### Wfst
|
|
425
|
-
|
|
426
|
-
**Extends ol/control/
|
|
427
|
-
|
|
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
|
+
|
|
428
430
|
Tiny WFST-T client to insert (drawing/uploading), modify and delete
|
|
429
431
|
features on GeoServers using OpenLayers. Layers with these types
|
|
430
432
|
of geometries are supported: "GeometryCollection" (in this case, you can
|
|
431
433
|
choose the geometry type of each element to draw), "Point", "MultiPoint",
|
|
432
|
-
"LineString", "MultiLineString", "Polygon" and "MultiPolygon".
|
|
433
|
-
|
|
434
|
-
#### Parameters
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
#### getLayers
|
|
439
|
-
|
|
440
|
-
Get all the layers in the ol-wfst instance
|
|
441
|
-
|
|
442
|
-
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer))>** 
|
|
443
|
-
|
|
444
|
-
#### getLayerByName
|
|
445
|
-
|
|
446
|
-
Get a layer
|
|
447
|
-
|
|
448
|
-
##### Parameters
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
Returns **([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer))** 
|
|
453
|
-
|
|
454
|
-
#### activateDrawMode
|
|
455
|
-
|
|
456
|
-
Activate/deactivate the draw mode
|
|
457
|
-
|
|
458
|
-
##### Parameters
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
Returns **void** 
|
|
463
|
-
|
|
464
|
-
#### activateEditMode
|
|
465
|
-
|
|
466
|
-
Activate/desactivate the edit mode
|
|
467
|
-
|
|
468
|
-
##### Parameters
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
Returns **void** 
|
|
473
|
-
|
|
474
|
-
### Geoserver
|
|
475
|
-
|
|
476
|
-
**Extends ol/Object~
|
|
477
|
-
|
|
478
|
-
#### Parameters
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
#### getCapabilities
|
|
483
|
-
|
|
484
|
-
Returns **XMLDocument** 
|
|
485
|
-
|
|
486
|
-
#### setUrl
|
|
487
|
-
|
|
488
|
-
##### Parameters
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
Returns **void** 
|
|
494
|
-
|
|
495
|
-
#### getUrl
|
|
496
|
-
|
|
497
|
-
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
498
|
-
|
|
499
|
-
#### setHeaders
|
|
500
|
-
|
|
501
|
-
##### Parameters
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
Returns **void** 
|
|
507
|
-
|
|
508
|
-
#### getHeaders
|
|
509
|
-
|
|
510
|
-
Returns **HeadersInit** 
|
|
511
|
-
|
|
512
|
-
#### setCredentials
|
|
513
|
-
|
|
514
|
-
##### Parameters
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
Returns **void** 
|
|
520
|
-
|
|
521
|
-
#### getCredentials
|
|
522
|
-
|
|
523
|
-
Returns **RequestCredentials** 
|
|
524
|
-
|
|
525
|
-
#### setAdvanced
|
|
526
|
-
|
|
527
|
-
##### Parameters
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
Returns **void** 
|
|
533
|
-
|
|
534
|
-
#### getAdvanced
|
|
535
|
-
|
|
536
|
-
Returns **[GeoServerAdvanced](#geoserveradvanced)** 
|
|
537
|
-
|
|
538
|
-
#### hasTransaction
|
|
539
|
-
|
|
540
|
-
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
541
|
-
|
|
542
|
-
#### hasLockFeature
|
|
543
|
-
|
|
544
|
-
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
545
|
-
|
|
546
|
-
#### getUseLockFeature
|
|
547
|
-
|
|
548
|
-
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
549
|
-
|
|
550
|
-
#### setUseLockFeature
|
|
551
|
-
|
|
552
|
-
##### Parameters
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
Returns **void** 
|
|
558
|
-
|
|
559
|
-
#### isLoaded
|
|
560
|
-
|
|
561
|
-
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
562
|
-
|
|
563
|
-
#### getState
|
|
564
|
-
|
|
565
|
-
#### getAndUpdateCapabilities
|
|
566
|
-
|
|
434
|
+
"LineString", "MultiLineString", "Polygon" and "MultiPolygon".
|
|
435
|
+
|
|
436
|
+
#### Parameters
|
|
437
|
+
|
|
438
|
+
* `options` **[Options](#options)?** Wfst options, see [Wfst Options](#options) for more details.
|
|
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
|
+
* `layerName` (optional, default `''`)
|
|
453
|
+
|
|
454
|
+
Returns **([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer))** 
|
|
455
|
+
|
|
456
|
+
#### activateDrawMode
|
|
457
|
+
|
|
458
|
+
Activate/deactivate the draw mode
|
|
459
|
+
|
|
460
|
+
##### Parameters
|
|
461
|
+
|
|
462
|
+
* `layer` **([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer) | `false`)** 
|
|
463
|
+
|
|
464
|
+
Returns **void** 
|
|
465
|
+
|
|
466
|
+
#### activateEditMode
|
|
467
|
+
|
|
468
|
+
Activate/desactivate the edit mode
|
|
469
|
+
|
|
470
|
+
##### Parameters
|
|
471
|
+
|
|
472
|
+
* `bool` (optional, default `true`)
|
|
473
|
+
|
|
474
|
+
Returns **void** 
|
|
475
|
+
|
|
476
|
+
### Geoserver
|
|
477
|
+
|
|
478
|
+
**Extends ol/Object~BaseObject**
|
|
479
|
+
|
|
480
|
+
#### Parameters
|
|
481
|
+
|
|
482
|
+
* `options` **[GeoserverOptions](#geoserveroptions)** 
|
|
483
|
+
|
|
484
|
+
#### getCapabilities
|
|
485
|
+
|
|
486
|
+
Returns **XMLDocument** 
|
|
487
|
+
|
|
488
|
+
#### setUrl
|
|
489
|
+
|
|
490
|
+
##### Parameters
|
|
491
|
+
|
|
492
|
+
* `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
493
|
+
* `opt_silent` (optional, default `false`)
|
|
494
|
+
|
|
495
|
+
Returns **void** 
|
|
496
|
+
|
|
497
|
+
#### getUrl
|
|
498
|
+
|
|
499
|
+
Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
500
|
+
|
|
501
|
+
#### setHeaders
|
|
502
|
+
|
|
503
|
+
##### Parameters
|
|
504
|
+
|
|
505
|
+
* `headers` **HeadersInit** (optional, default `{}`)
|
|
506
|
+
* `opt_silent` (optional, default `false`)
|
|
507
|
+
|
|
508
|
+
Returns **void** 
|
|
509
|
+
|
|
510
|
+
#### getHeaders
|
|
511
|
+
|
|
512
|
+
Returns **HeadersInit** 
|
|
513
|
+
|
|
514
|
+
#### setCredentials
|
|
515
|
+
|
|
516
|
+
##### Parameters
|
|
517
|
+
|
|
518
|
+
* `credentials` **RequestCredentials** (optional, default `null`)
|
|
519
|
+
* `opt_silent` (optional, default `false`)
|
|
520
|
+
|
|
521
|
+
Returns **void** 
|
|
522
|
+
|
|
523
|
+
#### getCredentials
|
|
524
|
+
|
|
525
|
+
Returns **RequestCredentials** 
|
|
526
|
+
|
|
527
|
+
#### setAdvanced
|
|
528
|
+
|
|
529
|
+
##### Parameters
|
|
530
|
+
|
|
531
|
+
* `advanced` **[GeoServerAdvanced](#geoserveradvanced)** (optional, default `{}`)
|
|
532
|
+
* `opt_silent` (optional, default `false`)
|
|
533
|
+
|
|
534
|
+
Returns **void** 
|
|
535
|
+
|
|
536
|
+
#### getAdvanced
|
|
537
|
+
|
|
538
|
+
Returns **[GeoServerAdvanced](#geoserveradvanced)** 
|
|
539
|
+
|
|
540
|
+
#### hasTransaction
|
|
541
|
+
|
|
542
|
+
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
543
|
+
|
|
544
|
+
#### hasLockFeature
|
|
545
|
+
|
|
546
|
+
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
547
|
+
|
|
548
|
+
#### getUseLockFeature
|
|
549
|
+
|
|
550
|
+
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
551
|
+
|
|
552
|
+
#### setUseLockFeature
|
|
553
|
+
|
|
554
|
+
##### Parameters
|
|
555
|
+
|
|
556
|
+
* `useLockFeature` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
557
|
+
* `opt_silent` (optional, default `false`)
|
|
558
|
+
|
|
559
|
+
Returns **void** 
|
|
560
|
+
|
|
561
|
+
#### isLoaded
|
|
562
|
+
|
|
563
|
+
Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
|
|
564
|
+
|
|
565
|
+
#### getState
|
|
566
|
+
|
|
567
|
+
#### getAndUpdateCapabilities
|
|
568
|
+
|
|
567
569
|
Get the capabilities from the GeoServer and check
|
|
568
|
-
all the available operations.
|
|
569
|
-
|
|
570
|
-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<XMLDocument>** 
|
|
571
|
-
|
|
572
|
-
####
|
|
573
|
-
|
|
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
|
+
* `features` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Feature\<Geometry>>** 
|
|
579
|
+
|
|
580
|
+
#### lockFeature
|
|
581
|
+
|
|
574
582
|
Lock a feature in the geoserver. Useful before editing a geometry,
|
|
575
|
-
to avoid changes from multiples suers
|
|
576
|
-
|
|
577
|
-
##### Parameters
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
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)>** 
|
|
584
|
-
|
|
585
|
-
### WfsLayer
|
|
586
|
-
|
|
587
|
-
**Extends ol/layer/Vector~
|
|
588
|
-
|
|
583
|
+
to avoid changes from multiples suers
|
|
584
|
+
|
|
585
|
+
##### Parameters
|
|
586
|
+
|
|
587
|
+
* `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))** 
|
|
588
|
+
* `layerName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
589
|
+
* `retry` (optional, default `0`)
|
|
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
|
+
|
|
589
597
|
Layer to retrieve WFS features from geoservers
|
|
590
|
-
<https://docs.geoserver.org/stable/en/user/services/wfs/reference.html>
|
|
591
|
-
|
|
592
|
-
#### Parameters
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
#### refresh
|
|
597
|
-
|
|
598
|
-
#### setCustomParam
|
|
599
|
-
|
|
598
|
+
<https://docs.geoserver.org/stable/en/user/services/wfs/reference.html>
|
|
599
|
+
|
|
600
|
+
#### Parameters
|
|
601
|
+
|
|
602
|
+
* `options` **[LayerOptions](#layeroptions)** 
|
|
603
|
+
|
|
604
|
+
#### refresh
|
|
605
|
+
|
|
606
|
+
#### setCustomParam
|
|
607
|
+
|
|
600
608
|
Use this to update Geoserver Wms Vendors (<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html>)
|
|
601
609
|
and other arguements (<https://docs.geoserver.org/stable/en/user/services/wms/reference.html#getmap>)
|
|
602
|
-
in all the getMap requests.
|
|
603
|
-
|
|
604
|
-
Example: you can use this to change the style of the WMS, add a custom sld, set a
|
|
605
|
-
|
|
606
|
-
##### Parameters
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
Returns **URLSearchParams** 
|
|
613
|
-
|
|
614
|
-
### WmsLayer
|
|
615
|
-
|
|
616
|
-
**Extends ol/layer/Tile~
|
|
617
|
-
|
|
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 cql\_filter, etc.
|
|
613
|
+
|
|
614
|
+
##### Parameters
|
|
615
|
+
|
|
616
|
+
* `paramName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
617
|
+
* `value` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Use `undefined` or `null` to remove the param (optional, default `null`)
|
|
618
|
+
* `refresh` (optional, default `true`)
|
|
619
|
+
|
|
620
|
+
Returns **URLSearchParams** 
|
|
621
|
+
|
|
622
|
+
### WmsLayer
|
|
623
|
+
|
|
624
|
+
**Extends ol/layer/Tile~TileLayer**
|
|
625
|
+
|
|
618
626
|
Layer to retrieve WMS information from geoservers
|
|
619
|
-
<https://docs.geoserver.org/stable/en/user/services/wms/reference.html>
|
|
620
|
-
|
|
621
|
-
#### Parameters
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
#### refresh
|
|
626
|
-
|
|
627
|
-
#### setCustomParam
|
|
628
|
-
|
|
627
|
+
<https://docs.geoserver.org/stable/en/user/services/wms/reference.html>
|
|
628
|
+
|
|
629
|
+
#### Parameters
|
|
630
|
+
|
|
631
|
+
* `options` **[LayerOptions](#layeroptions)** 
|
|
632
|
+
|
|
633
|
+
#### refresh
|
|
634
|
+
|
|
635
|
+
#### setCustomParam
|
|
636
|
+
|
|
629
637
|
Use this to update Geoserver Wfs Vendors (<https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html>)
|
|
630
638
|
and other arguements (<https://docs.geoserver.org/stable/en/user/services/wfs/reference.html>)
|
|
631
|
-
in all the getFeature requests.
|
|
632
|
-
|
|
633
|
-
Example: you can use this to set a
|
|
634
|
-
|
|
635
|
-
##### Parameters
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
Returns **URLSearchParams** 
|
|
642
|
-
|
|
643
|
-
### Options
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
Default values:
|
|
648
|
-
|
|
649
|
-
```javascript
|
|
639
|
+
in all the getFeature requests.
|
|
640
|
+
|
|
641
|
+
Example: you can use this to set a cql\_filter, limit the numbers of features, etc.
|
|
642
|
+
|
|
643
|
+
##### Parameters
|
|
644
|
+
|
|
645
|
+
* `paramName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
|
|
646
|
+
* `value` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (optional, default `null`)
|
|
647
|
+
* `refresh` (optional, default `true`)
|
|
648
|
+
|
|
649
|
+
Returns **URLSearchParams** 
|
|
650
|
+
|
|
651
|
+
### Options
|
|
652
|
+
|
|
653
|
+
***\[interface]*** - Wfst Options specified when creating a Wfst instance
|
|
654
|
+
|
|
655
|
+
Default values:
|
|
656
|
+
|
|
657
|
+
```javascript
|
|
650
658
|
{
|
|
651
659
|
layers: null,
|
|
652
660
|
evtType: 'singleclick',
|
|
@@ -656,187 +664,187 @@ Default values:
|
|
|
656
664
|
i18n: {...}, // according to language selection
|
|
657
665
|
uploadFormats: '.geojson,.json,.kml',
|
|
658
666
|
processUpload: null,
|
|
659
|
-
}
|
|
660
|
-
```
|
|
661
|
-
|
|
662
|
-
#### processUpload
|
|
663
|
-
|
|
667
|
+
}
|
|
668
|
+
```
|
|
669
|
+
|
|
670
|
+
#### processUpload
|
|
671
|
+
|
|
664
672
|
Triggered to allow implement custom functions or to parse other formats than default
|
|
665
673
|
by filtering the extension. If this doesn't return features, the default function
|
|
666
|
-
will be used to extract them.
|
|
667
|
-
|
|
668
|
-
##### Parameters
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Feature\<Geometry>>** 
|
|
673
|
-
|
|
674
|
-
#### layers
|
|
675
|
-
|
|
676
|
-
Layers to be loaded from the geoserver
|
|
677
|
-
|
|
678
|
-
Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<([WfsLayer](#wfslayer) | [WmsLayer](#wmslayer))>
|
|
679
|
-
|
|
680
|
-
#### active
|
|
681
|
-
|
|
682
|
-
Init active
|
|
683
|
-
|
|
684
|
-
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
685
|
-
|
|
686
|
-
#### evtType
|
|
687
|
-
|
|
688
|
-
The click event to allow selection of Features to be edited
|
|
689
|
-
|
|
690
|
-
Type: (`"singleclick"` | `"dblclick"`)
|
|
691
|
-
|
|
692
|
-
#### showControl
|
|
693
|
-
|
|
694
|
-
Show/hide the control map
|
|
695
|
-
|
|
696
|
-
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
697
|
-
|
|
698
|
-
#### modal
|
|
699
|
-
|
|
700
|
-
Modal configuration
|
|
701
|
-
|
|
702
|
-
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))?}?}
|
|
703
|
-
|
|
704
|
-
#### language
|
|
705
|
-
|
|
706
|
-
Language to be used
|
|
707
|
-
|
|
708
|
-
Type: (`"es"` | `"en"` | `"zh"`)
|
|
709
|
-
|
|
710
|
-
#### i18n
|
|
711
|
-
|
|
712
|
-
Custom translations
|
|
713
|
-
|
|
714
|
-
Type: [I18n](#i18n)
|
|
715
|
-
|
|
716
|
-
#### showUpload
|
|
717
|
-
|
|
718
|
-
Show/hide the upload button
|
|
719
|
-
|
|
720
|
-
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
721
|
-
|
|
722
|
-
#### uploadFormats
|
|
723
|
-
|
|
674
|
+
will be used to extract them.
|
|
675
|
+
|
|
676
|
+
##### Parameters
|
|
677
|
+
|
|
678
|
+
* `file` **File** 
|
|
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
|
+
|
|
724
732
|
Accepted extension formats on upload
|
|
725
|
-
Example: ".json,.geojson"
|
|
726
|
-
|
|
727
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
728
|
-
|
|
729
|
-
### LayerOptions
|
|
730
|
-
|
|
731
|
-
**Extends Omit\<
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
You can use all the parameters supported by OpenLayers
|
|
736
|
-
|
|
737
|
-
Default values:
|
|
738
|
-
|
|
739
|
-
```javascript
|
|
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
|
+
***\[interface]*** - Parameters to create the layers and connect to the GeoServer
|
|
742
|
+
|
|
743
|
+
You can use all the parameters supported by OpenLayers
|
|
744
|
+
|
|
745
|
+
Default values:
|
|
746
|
+
|
|
747
|
+
```javascript
|
|
740
748
|
{
|
|
741
749
|
name: null,
|
|
742
750
|
geoserver: null,
|
|
743
751
|
label: null, // `name` if not provided
|
|
744
752
|
strategy: all,
|
|
745
753
|
geoserverVendor: null
|
|
746
|
-
}
|
|
747
|
-
```
|
|
748
|
-
|
|
749
|
-
#### beforeTransactFeature
|
|
750
|
-
|
|
754
|
+
}
|
|
755
|
+
```
|
|
756
|
+
|
|
757
|
+
#### beforeTransactFeature
|
|
758
|
+
|
|
751
759
|
Triggered before inserting new features to the Geoserver.
|
|
752
|
-
Use this to insert custom properties, modify the feature, etc.
|
|
753
|
-
|
|
754
|
-
##### Parameters
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
Returns **Feature\<Geometry>** 
|
|
760
|
-
|
|
761
|
-
#### name
|
|
762
|
-
|
|
763
|
-
Layer name in the GeoServer
|
|
764
|
-
|
|
765
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
766
|
-
|
|
767
|
-
#### geoserver
|
|
768
|
-
|
|
769
|
-
Geoserver Object
|
|
770
|
-
|
|
771
|
-
Type: [Geoserver](#geoserver)
|
|
772
|
-
|
|
773
|
-
#### label
|
|
774
|
-
|
|
775
|
-
Label to be displayed in the widget control
|
|
776
|
-
|
|
777
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
778
|
-
|
|
779
|
-
#### geoserverVendor
|
|
780
|
-
|
|
781
|
-
Available geoserver options
|
|
782
|
-
|
|
783
|
-
Type: ([WfsGeoserverVendor](#wfsgeoservervendor) | [WmsGeoserverVendor](#wmsgeoservervendor))
|
|
784
|
-
|
|
785
|
-
#### strategy
|
|
786
|
-
|
|
760
|
+
Use this to insert custom properties, modify the feature, etc.
|
|
761
|
+
|
|
762
|
+
##### Parameters
|
|
763
|
+
|
|
764
|
+
* `feature` **Feature\<Geometry>** 
|
|
765
|
+
* `transaction` **TransactionType** 
|
|
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
|
+
|
|
787
795
|
Strategy function for loading features.
|
|
788
796
|
Only for WFS
|
|
789
|
-
By default `all` strategy is used
|
|
790
|
-
|
|
791
|
-
Type: LoadingStrategy
|
|
792
|
-
|
|
793
|
-
### GeoserverOptions
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
#### url
|
|
798
|
-
|
|
799
|
-
Url for OWS services. This endpoint will recive the WFS, WFST and WMS requests
|
|
800
|
-
|
|
801
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
802
|
-
|
|
803
|
-
#### advanced
|
|
804
|
-
|
|
805
|
-
Advanced options for geoserver requests
|
|
806
|
-
|
|
807
|
-
Type: [GeoServerAdvanced](#geoserveradvanced)
|
|
808
|
-
|
|
809
|
-
#### headers
|
|
810
|
-
|
|
797
|
+
By default `all` strategy is used
|
|
798
|
+
|
|
799
|
+
Type: LoadingStrategy
|
|
800
|
+
|
|
801
|
+
### GeoserverOptions
|
|
802
|
+
|
|
803
|
+
***\[interface]***
|
|
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
|
+
|
|
811
819
|
Http headers for GeoServer requests
|
|
812
|
-
<https://developer.mozilla.org/en-US/docs/Web/API/Request/headers>
|
|
813
|
-
|
|
814
|
-
Type: HeadersInit
|
|
815
|
-
|
|
816
|
-
#### credentials
|
|
817
|
-
|
|
820
|
+
<https://developer.mozilla.org/en-US/docs/Web/API/Request/headers>
|
|
821
|
+
|
|
822
|
+
Type: HeadersInit
|
|
823
|
+
|
|
824
|
+
#### credentials
|
|
825
|
+
|
|
818
826
|
Credentials for fetch requests
|
|
819
|
-
<https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials>
|
|
820
|
-
|
|
821
|
-
Default is 'same-origin'
|
|
822
|
-
|
|
823
|
-
Type: RequestCredentials
|
|
824
|
-
|
|
825
|
-
#### useLockFeature
|
|
826
|
-
|
|
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
|
+
|
|
827
835
|
Use LockFeatue request on GeoServer when selecting features. Prevents a feature from being edited
|
|
828
836
|
through a persistent feature lock. This is not always supportedd by the GeoServer.
|
|
829
|
-
See <https://docs.geoserver.org/stable/en/user/services/wfs/reference.html>
|
|
830
|
-
|
|
831
|
-
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
832
|
-
|
|
833
|
-
### GeoServerAdvanced
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
```javascript
|
|
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
|
+
***\[interface]***
|
|
844
|
+
|
|
845
|
+
* Default values:
|
|
846
|
+
|
|
847
|
+
```javascript
|
|
840
848
|
{
|
|
841
849
|
getCapabilitiesVersion: '1.3.0',
|
|
842
850
|
getFeatureVersion: '1.0.0',
|
|
@@ -849,126 +857,126 @@ Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Glob
|
|
|
849
857
|
lockId: 'Geoserver',
|
|
850
858
|
releaseAction: 'SOME'
|
|
851
859
|
}
|
|
852
|
-
}
|
|
853
|
-
```
|
|
854
|
-
|
|
855
|
-
### WfsGeoserverVendor
|
|
856
|
-
|
|
857
|
-
**Extends BaseGeoserverVendor**
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
<https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html>
|
|
861
|
-
|
|
862
|
-
#### strict
|
|
863
|
-
|
|
864
|
-
<https://docs.geoserver.org/latest/en/user/services/wfs/vendor.html#xml-request-validation>
|
|
865
|
-
|
|
866
|
-
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
867
|
-
|
|
868
|
-
### WmsGeoserverVendor
|
|
869
|
-
|
|
870
|
-
**Extends BaseGeoserverVendor**
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html>
|
|
874
|
-
|
|
875
|
-
#### buffer
|
|
876
|
-
|
|
877
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#buffer>
|
|
878
|
-
|
|
879
|
-
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))
|
|
880
|
-
|
|
881
|
-
#### env
|
|
882
|
-
|
|
883
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#env>
|
|
884
|
-
|
|
885
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
886
|
-
|
|
887
|
-
#### clip
|
|
888
|
-
|
|
889
|
-
<https://docs.geoserver.org/latest/en/user/services/wms/vendor.html#clip>
|
|
890
|
-
|
|
891
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
892
|
-
|
|
893
|
-
#### styles
|
|
894
|
-
|
|
860
|
+
}
|
|
861
|
+
```
|
|
862
|
+
|
|
863
|
+
### WfsGeoserverVendor
|
|
864
|
+
|
|
865
|
+
**Extends BaseGeoserverVendor**
|
|
866
|
+
|
|
867
|
+
***\[interface]*** - WFS geoserver options
|
|
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
|
+
***\[interface]*** - WMS geoserver options
|
|
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
|
+
|
|
895
903
|
Styles in which layers are to be rendered.
|
|
896
904
|
Value is a comma-separated list of style names, or empty if default styling is required.
|
|
897
|
-
Style names may be empty in the list, to use default layer styling.
|
|
898
|
-
|
|
899
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
900
|
-
|
|
901
|
-
#### transparent
|
|
902
|
-
|
|
903
|
-
Whether the map background should be transparent. Values are true or false. Default is false
|
|
904
|
-
|
|
905
|
-
Type: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)
|
|
906
|
-
|
|
907
|
-
#### bgcolor
|
|
908
|
-
|
|
909
|
-
Background color for the map image. Value is in the form RRGGBB. Default is FFFFFF (white).
|
|
910
|
-
|
|
911
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
912
|
-
|
|
913
|
-
#### time
|
|
914
|
-
|
|
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
|
+
|
|
915
923
|
Time value or range for map data.
|
|
916
|
-
See [Time Support in GeoServer WMS](https://docs.geoserver.org/stable/en/user/services/wms/time.html#wms-time) for more information.
|
|
917
|
-
|
|
918
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
919
|
-
|
|
920
|
-
#### sld
|
|
921
|
-
|
|
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
|
+
|
|
922
930
|
A URL referencing a [StyledLayerDescriptor](https://docs.geoserver.org/stable/en/user/styling/index.html#styling)
|
|
923
|
-
XML file which controls or enhances map layers and styling
|
|
924
|
-
|
|
925
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
926
|
-
|
|
927
|
-
####
|
|
928
|
-
|
|
929
|
-
A URL-encoded StyledLayerDescriptor XML document which controls or enhances map layers and styling
|
|
930
|
-
|
|
931
|
-
Type: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)
|
|
932
|
-
|
|
933
|
-
### IGeoserverDescribeFeatureType
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
#### \_parsed
|
|
938
|
-
|
|
939
|
-
DescribeFeature request parsed
|
|
940
|
-
|
|
941
|
-
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)}
|
|
942
|
-
|
|
943
|
-
### I18n
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
#### labels
|
|
948
|
-
|
|
949
|
-
Labels section
|
|
950
|
-
|
|
951
|
-
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)?}
|
|
952
|
-
|
|
953
|
-
#### errors
|
|
954
|
-
|
|
955
|
-
Errors section
|
|
956
|
-
|
|
957
|
-
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)?}
|
|
958
|
-
|
|
959
|
-
## TODO
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
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
|
+
#### sld\_body
|
|
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
|
+
***\[interface]*** - Geoserver original response on DescribeFeature request
|
|
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
|
+
***\[interface]*** - Custom Language specified when creating a WFST instance
|
|
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
|
+
* \~~Add support to diferent layer styles~~
|
|
970
|
+
* \~~Improve widget controller: visibility toggle~~
|
|
971
|
+
* \~~Add events~~
|
|
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
|