Class: WFS

ol/format/WFS~WFS 


import WFS from 'ol/format/WFS.js';

Feature format for reading and writing data in the WFS format. By default, supports WFS version 1.1.0. You can pass a GML format as option to override the default. Also see GMLBase which is used by this format.

new WFS(options)

format/WFS.js, line 271
Name Type Description
featureNS Object.<string, string> | string | undefined

The namespace URI used for features.
featureType Array.<string> | string | undefined

The feature type to parse. Only used for read operations.
gmlFormat GMLBase | undefined

The GML format to use to parse the response. Default is ol/format/GML2 for WFS 1.0.0, ol/format/GML3 for WFS 1.1.0 and ol/format/GML32 for WFS 2.0.0.
schemaLocation string | undefined

Optional schemaLocation to use for serialization, this will override the default.
version string (defaults to '1.1.0')

WFS version to use. Can be either 1.0.0, 1.1.0 or 2.0.0.

Extends

Methods

readFeatureCollectionMetadata(source){FeatureCollectionMetadata | undefined}

format/WFS.js, line 400

Read feature collection metadata of the source.

Name Type Description
source Document | Element | Object | string

Source.
Returns:
FeatureCollection metadata.

readTransactionResponse(source){TransactionResponse | undefined}

format/WFS.js, line 374

Read transaction response of the source.

Name Type Description
source Document | Element | Object | string

Source.
Returns:
Transaction response.

writeGetFeature(options){Node}

format/WFS.js, line 487

Encode format as WFS GetFeature and return the Node.

Name Type Description
featureNS string

The namespace URI used for features.
featurePrefix string

The prefix for the feature namespace.
featureTypes Array.<(string|module:ol/format/WFS~FeatureType)>

The feature type names or FeatureType objects to define a unique bbox filter per feature type name (in this case, options bbox and geometryName are ignored.).
srsName string | undefined

SRS name. No srsName attribute will be set on geometries when this is not provided.
handle string | undefined

Handle.
outputFormat string | undefined

Output format.
maxFeatures number | undefined

Maximum number of features to fetch.
geometryName string | undefined

Geometry name to use in a BBOX filter.
propertyNames Array.<string> | undefined

Optional list of property names to serialize.
viewParams string | undefined

viewParams GeoServer vendor parameter.
startIndex number | undefined

Start index to use for WFS paging. This is a WFS 2.0 feature backported to WFS 1.1.0 by some Web Feature Services.
count number | undefined

Number of features to retrieve when paging. This is a WFS 2.0 feature backported to WFS 1.1.0 by some Web Feature Services. Please note that some Web Feature Services have repurposed maxfeatures instead.
bbox Extent | undefined

Extent to use for the BBOX filter. The geometryName option must be set.
filter Filter | undefined

Filter condition. See ol/format/filter for more information.
resultType string | undefined

Indicates what response should be returned, e.g. hits only includes the numberOfFeatures attribute in the response and no features.
Returns:
Result.

writeTransaction(inserts, updates, deletes, options){Node}

format/WFS.js, line 603

Encode format as WFS Transaction and return the Node.

Name Type Description
inserts Array<Feature>

The features to insert.
updates Array<Feature>

The features to update.
deletes Array<Feature>

The features to delete.
options

Write options.

Name Type Description
featureNS string

The namespace URI used for features.
featurePrefix string

The prefix for the feature namespace.
featureType string

The feature type name.
srsName string | undefined

SRS name. No srsName attribute will be set on geometries when this is not provided.
handle string | undefined

Handle.
hasZ boolean | undefined

Must be set to true if the transaction is for a 3D layer. This will allow the Z coordinate to be included in the transaction.
nativeElements Array.<Object>

Native elements. Currently not supported.
gmlOptions Options | undefined

GML options for the WFS transaction writer.
version string (defaults to '1.1.0')

WFS version to use for the transaction. Can be either 1.0.0, 1.1.0 or 2.0.0.
Returns:
Result.