new ol.format.WFS(opt_options)
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Optional configuration object.
|
Extends
Methods
-
ol.format.WFS.writeFilter(filter){Node}
src/ol/format/wfs.js, line 903 -
Encode filter as WFS
Filter
and return the Node.Name Type Description filter
ol.format.filter.Filter Filter.
Returns:
Result.
-
readFeatureCollectionMetadata(source){ol.WFSFeatureCollectionMetadata|undefined}
src/ol/format/wfs.js, line 201 -
Read feature collection metadata of the source.
Name Type Description source
Document | Node | Object | string Source.
Returns:
FeatureCollection metadata.
-
Read all features from a WFS FeatureCollection.
Name Type Description source
Document | Node | Object | string Source.
options
Read options.
Name Type Description dataProjection
ol.ProjectionLike Projection of the data we are reading. If not provided, the projection will be derived from the data (where possible) or the
defaultDataProjection
of the format is assigned (where set). If the projection can not be derived from the data and if nodefaultDataProjection
is set for a format, the features will not be reprojected.extent
ol.Extent Tile extent of the tile being read. This is only used and required for
ol.format.MVT
. Required.featureProjection
ol.ProjectionLike Projection of the feature geometries created by the format reader. If not provided, features will be returned in the
dataProjection
.Returns:
Features.
-
Read the projection from a WFS source.
Name Type Description source
Document | Node | Object | string Source.
Returns:
Projection.
-
Read transaction response of the source.
Name Type Description source
Document | Node | Object | string Source.
Returns:
Transaction response.
-
writeGetFeature(options){Node}
src/ol/format/wfs.js, line 934 -
Encode format as WFS
GetFeature
and return the Node.Name Type Description options
Options.
Name Type Description featureNS
string The namespace URI used for features. Required.
featurePrefix
string The prefix for the feature namespace. Required.
featureTypes
Array.<string> The feature type names. Required.
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.
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
ol.Extent | undefined Extent to use for the BBOX filter.
filter
ol.format.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 thenumberOfFeatures
attribute in the response and no features.Returns:
Result.
-
writeTransaction(inserts, updates, deletes, options){Node}
src/ol/format/wfs.js, line 1001 -
Encode format as WFS
Transaction
and return the Node.Name Type Description inserts
Array.<ol.Feature> The features to insert.
updates
Array.<ol.Feature> The features to update.
deletes
Array.<ol.Feature> The features to delete.
options
Write options.
Name Type Description featureNS
string The namespace URI used for features. Required.
featurePrefix
string The prefix for the feature namespace. Required.
featureType
string The feature type name. Required.
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. Required.
gmlOptions
olx.format.GMLOptions | undefined GML options for the WFS transaction writer.
version
string | undefined WFS version to use for the transaction. Can be either
1.0.0
or1.1.0
. Default is1.1.0
.Returns:
Result.