Module: ol/format/WFS

ol/format/WFS


Classes

WFS

Methods

module:ol/format/WFS~writeFilter(filter){Node}

format/WFS.js, line 1063

Encode filter as WFS Filter and return the Node.

Name Type Description
filter module:ol/format/filter/Filter~Filter

Filter.

Returns:
Result.

Type Definitions

FeatureCollectionMetadata{Object}

Number of features; bounds/extent.

Properties:
Name Type Description
numberOfFeatures number
bounds module:ol/extent~Extent

Options{Object}

Properties:
Name Type Argument Description
featureNS Object.<string, string> | string <optional>

The namespace URI used for features.

featureType Array.<string> | string <optional>

The feature type to parse. Only used for read operations.

gmlFormat module:ol/format/GMLBase~GMLBase <optional>

The GML format to use to parse the response. Default is ol/format/GML3.

schemaLocation string <optional>

Optional schemaLocation to use for serialization, this will override the default.

TransactionResponse{Object}

Total deleted; total inserted; total updated; array of insert ids.

Properties:
Name Type Description
totalDeleted number
totalInserted number
totalUpdated number
insertIds Array.<string>

WriteGetFeatureOptions{Object}

Properties:
Name Type Argument Description
featureNS string

The namespace URI used for features.

featurePrefix string

The prefix for the feature namespace.

featureTypes Array.<string>

The feature type names.

srsName string <optional>

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

handle string <optional>

Handle.

outputFormat string <optional>

Output format.

maxFeatures number <optional>

Maximum number of features to fetch.

geometryName string <optional>

Geometry name to use in a BBOX filter.

propertyNames Array.<string> <optional>

Optional list of property names to serialize.

startIndex number <optional>

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 <optional>

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 module:ol/extent~Extent <optional>

Extent to use for the BBOX filter.

filter module:ol/format/filter/Filter~Filter <optional>

Filter condition. See module:ol/format/Filter for more information.

resultType string <optional>

Indicates what response should be returned, E.g. hits only includes the numberOfFeatures attribute in the response and no features.

WriteTransactionOptions{Object}

Properties:
Name Type Argument Default 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 <optional>

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

handle string <optional>

Handle.

hasZ boolean <optional>

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 module:ol/format/GMLBase~Options <optional>

GML options for the WFS transaction writer.

version string <optional>
'1.1.0'

WFS version to use for the transaction. Can be either 1.0.0 or 1.1.0.