Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/opsdashboard
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: WFSLayer
[ AMD Module Require | Legacy Module Require ]
require(["esri/layers/WFSLayer"], function(WFSLayer) { /* code goes here */ });
Description
(Added at v3.14)
(Currently in beta)
A layer for OGC Web Feature Services (WFS). WFSLayer requires using a proxy page. See the Using the proxy guide page for details about setting up a proxy. Note that WFSLayer was updated for 3.17 and the API Reference have changed to reflect the new WFSLayer.Samples
Search for samples that use this class.Class hierarchy
esri/layers/Layer |_esri/layers/GraphicsLayer |_esri/layers/WFSLayer
Constructors
| Name | Summary |
|---|---|
| new WFSLayer(options) | Creates a new WFSLayer object. |
Properties
| Name | Type | Summary |
|---|---|---|
| className | String | class attribute of the layer's node. |
| customParameters | Object | Use this to append custom parameters to WFS requests. |
| fields | Field[] | An array of fields in the layer. |
| graphics | Graphic[] | An array of features in the layer. |
| id | String | ID assigned to the layer. |
| infoTemplate | InfoTemplate | The InfoTemplate for the layer. |
| loadError | Error | Set if the layer failed to load. |
| loaded | Boolean | When the layer is loaded, the value becomes "true", and layer properties can be accessed. |
| maxScale | Number | Maximum visible scale for the layer. |
| minScale | Number | Minimum visible scale for the layer. |
| opacity | Number | Opacity or transparency of layer. |
| renderer | Renderer | The renderer to apply to the layer. |
| showAttribution | Boolean | When true, the layer's attribution is displayed on the map. |
| suspended | Boolean | When true, the layer is suspended. |
| url | String | URL to the ArcGIS Server REST resource that represents a map service. |
| visible | Boolean | The visibility of the layer. |
| visibleAtMapScale | Boolean | When true, the layer is visible at the current map scale. |
Methods
| Name | Return type | Summary |
|---|---|---|
| clear() | None | Clears all graphics. |
| disableMouseEvents() | None | Disables all mouse events on the graphics layer. |
| enableMouseEvents() | None | Enables all mouse events on the graphics layer. |
| fromJson(json) | None | Creates a WFSLayer using the provided JSON object. |
| getMap() | Map | Returns reference to the map control the layer is added to. |
| getNode() | HTMLElement | Returns the layer's DOM node. |
| hide() | None | Sets the visibility of the layer to "false". |
| isVisibleAtScale(scale) | Boolean | Returns true if the layer is visible at the given scale. |
| redraw() | None | Redraws all the graphics in the layer. |
| refresh() | None | Refreshes the features in the WFS layer. |
| remove(graphic) | Graphic | Removes a graphic. |
| resume() | None | Resumes layer drawing. |
| setCustomParameters(customParameters) | None | Sets the custom parameters used on the WFS layer. |
| setInfoTemplate(infoTemplate) | None | Specify or change the info template for a layer. |
| setLineSymbol() | None | Sets the default line symbol to be used if no renderer is specified. |
| setMaxScale(scale) | None | Set the maximum scale for the layer. |
| setMinScale(scale) | None | Set the minimum scale for the layer. |
| setOpacity(opacity) | None | Initial opacity or transparency of layer. |
| setPointSymbol() | None | Sets the default point symbol to be used if no renderer is specified. |
| setPolygonSymbol() | None | Sets the default polygon symbol to be used if no renderer is specified. |
| setRenderer(renderer) | None | Sets the renderer for the graphics layer. |
| setScaleRange(minScale, maxScale) | None | Set the scale range for the layer. |
| setVisibility(isVisible) | None | Sets the visibility of the layer. |
| show() | None | Sets the visibility of the layer to "true". |
| suspend() | None | Suspends layer drawing. |
| toJson() | Object | Converts the WFSLayer instance to a JSON object. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| click | {
event: < | Fires when a graphic has been clicked. |
| dbl-click | Fires when a graphic has been double clicked. | |
| error | {
error: < | Fires when there is a problem retrieving a layer. |
| graphic-add | {
graphic: < | Fires when a graphic is added to the GraphicsLayer. |
| graphic-draw | {
graphic: < | Fires when a graphic is drawn. |
| graphic-node-add | {
graphic: < | Fires when a graphic's DOM node is created and added to the layer. |
| graphic-node-remove | {
graphic: < | This event is fired when a graphic's DOM node is removed (consider the node destroyed). |
| graphic-remove | {
graphic: < | Fires when a graphic is removed from the GraphicsLayer. |
| graphics-clear | Fires when all graphics in the GraphicsLayer are cleared. | |
| mouse-down | <MouseEvent> mouseEvent | Fires when a mouse button is pressed down and the mouse cursor is on a graphic. |
| mouse-drag | <MouseEvent> mouseEvent | Fires while the mouse is being dragged until the mouse button is released. |
| mouse-move | <MouseEvent> mouseEvent | Fires as the mouse moves through a graphic on the GraphicsLayer. |
| mouse-out | <MouseEvent> mouseEvent | Fires as the mouse exits a graphic on the GraphicsLayer. |
| mouse-over | <MouseEvent> mouseEvent | Fires when the mouse first enters into a graphic on the GraphicsLayer. |
| mouse-up | <MouseEvent> mouseEvent | Fires when a mouse button is released and the mouse cursor is on a graphic. |
| opacity-change | {
opacity: < | Fires when the layer opacity has been changed, and returns an object with the opacity value. |
| resume | Fires when a layer resumes drawing. | |
| scale-range-change | Fires when a layer's minScale and/or maxScale is changed. | |
| scale-visibility-change | Fires when a layer's scale visibility changes. | |
| suspend | Fires when a layer suspends drawing. | |
| update | Fires any time a layer has finished loading or updating itself. | |
| update-end | {
error: < | Fires when a layer has finished updating its content. |
| update-start | Fires when a layer begins to update its content. | |
| visibility-change | {
visible: < | Fires when the layer visibility has been changed, and returns an object with a Boolean visible property containing the new visibility value of the layer. |
Constructor Details
Creates a new WFSLayer object
Parameters:
< |
Required | See options table below for full descriptions of the properties needed for this object. |
options properties: < |
Optional | Use this to append custom parameters to WFS requests. For example, if the service requires an access key, the key can be included as a custom parameter for all the requests.
"customParameters" : {"key": "1R-ADNF-6NCD"}
The custom parameters are applied to
GetCapabilities, DescribeFeatureInfo, and GetFeature |
< |
Optional | The template that defines the content to display in the map info window when the user clicks on a feature. If not specified, the info window will not be displayed. |
< |
Optional | Specifies the maximum number of features to return in one response. The recommended value depends on the effect the WFS server implementation and data size has on performance. The default value is 100.The suggested value range for "ondemand" mode is 1 - 100. The suggested range for "snapshot" mode is 100 - 1000. |
< |
Optional | The query mode for the WFS layer. Each mode determines when and how many features are sent to the client. The default mode is "snapshot".Known values: "snapshot" | "ondemand". |
< |
Optional | The simple layer name (excluding the namespace). Use the | character as a deliminator. The default is the first layer in the service.Example: "name": "citylimits" |
< |
Required | URL to the WFS server. |
< |
Optional | OGC WFS version number. The default is "1.1.0". Known values: "1.0.0" | "1.1.0" | "2.0.0". |
< |
Optional | The well-known ID of the spatial reference used by the WFSLayer. The default is 3857.Supported WKIDs: 3857 | 4326 | 3785. |
Property Details
<Object
ObjectUse this to append custom parameters to WFS requests. For example, if the service requires an access key, the key can be included as a custom parameter for all the requests. The custom parameters are applied to
GetCapabilities, DescribeFeatureInfo, and GetFeature. (Added at v3.18)Sample:
"customParameters" : {"key": "1R-ADNF-6NCD"}
<Field[]
Field[]An array of fields in the layer.
<Graphic[]
Graphic[]An array of features in the layer.
<InfoTemplate
InfoTemplateThe InfoTemplate for the layer.
<Error
ErrorSet if the layer failed to load. (Added at v3.9)
<Boolean
BooleanWhen the layer is loaded, the value becomes "true", and layer properties can be accessed. The onLoad event is also fired.
Known values:
true | false<Number
NumberMaximum visible scale for the layer. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. (Added at v3.1)
Default value:
0<Number
NumberMinimum visible scale for the layer. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a visible scale. (Added at v3.1)
Default value:
0<Number
NumberOpacity or transparency of layer. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency.
Known values:
0.0 - 1.0Default value:
1.0<Boolean
BooleanWhen true, the layer's attribution is displayed on the map. (Added at v3.1)
Known values:
true | falseDefault value:
true<Boolean
BooleanWhen true, the layer is suspended. A layer is considered to be suspended when one of the following is true:
- The layer is hidden.
- The layer is not visible at the current map scale.
- The layer is explicitly suspended by calling the
Layer.suspendmethod.
Known values:
true | false<String
StringURL to the ArcGIS Server REST resource that represents a map service. To obtain the URL, use Services Directory. An example URL for the Street Map service on ArcGIS Online is:
http://server.arcgisonline.com/ArcGIS/rest/services/ESRI_StreetMap_World_2D/MapServer. (Added at v1.2)
http://server.arcgisonline.com/ArcGIS/rest/services/ESRI_StreetMap_World_2D/MapServer. (Added at v1.2)
<Boolean
BooleanWhen true, the layer is visible at the current map scale. (Added at v3.1)
Known values:
true | falseMethod Details
Creates a WFSLayer using the provided JSON object. (Added at v3.17)
Parameters:
< |
Required | The input JSON. |
Returns reference to the map control the layer is added to. Returns
null or undefined if it is not added to a map. (Added at v3.7)Return type:
MapSets the visibility of the layer to "false". The layer is not removed, but it is hidden from view.
Returns true if the layer is visible at the given scale. (Added at v3.1)
Return type:
BooleanParameters:
< |
Required | The scale at which to check if the layer is visible. |
Removes a graphic.
Return type:
GraphicParameters:
< |
Required | The graphic to remove. |
Sets the custom parameters used on the WFS layer. It applies to
NOTE: This will update the properties and refresh the layer. (Added at v3.18)
GetCapabilities, DescribeFeatureType, and GetFeature methods. NOTE: This will update the properties and refresh the layer. (Added at v3.18)
Parameters:
< |
Required | The customParameters object used append WFS requests. |
Specify or change the info template for a layer. (Added at v2.2)
Parameters:
< |
Required | The new info template. |
Sample:
require([
"esri/layers/GraphicsLayer", "esri/InfoTemplate", ...
], function(GraphicsLayer, InfoTemplate, ... ) {
var cityLayer = new GraphicsLayer();
var infoTemplate = new InfoTemplate("${CITY_NAME}","${*}");
cityLayer.setInfoTemplate(infoTemplate);
...
});
Set the maximum scale for the layer. (Added at v3.1)
Parameters:
< |
Required | The maximum scale at which the layer is visible. |
Set the minimum scale for the layer. (Added at v3.1)
Parameters:
< |
Required | The minimum scale at which the layer is visible. |
Initial opacity or transparency of layer. Not supported in Internet Explorer.
Parameters:
< |
Required | Value from 0 to 1, where 0 is 100% transparent and 1 has no transparency. The default value is 1. |
Sets the renderer for the graphics layer.
Parameters:
< |
Required | The renderer used for the graphic. |
Set the scale range for the layer. If
minScale and maxScale are set to 0 then the layer will be visible at all scales. (Added at v3.1)Sets the visibility of the layer. When true, the layer is visible.
Parameters:
< |
Required | Set the visibility of the layer. |
Event Details
[ On Style Events | Connect Style Event ]
Fires when a graphic has been clicked. Should be used in favor of onClick. (Added at v3.5)
Fires when a graphic has been double clicked. Should be used in favor of onDblClick. (Added at v3.5)
Fires when there is a problem retrieving a layer. Should be used in favor of onError. (Added at v3.5)
Event Object Properties:
< |
ArcGIS Server error message returned in a JavaScript error object. |
Fires when a graphic is added to the GraphicsLayer. Should be used in favor of onGraphicAdd. (Added at v3.5)
Event Object Properties:
< |
The added graphic. |
Fires when a graphic is drawn. A graphic is drawn or redrawn when: (Added at v3.7)
Event Object Properties:
< |
Graphic being drawn. When the layer surfaceType is "svg" or "vml", the graphic's DOM node is accessible with graphic.getNode(). |
Fires when a graphic's DOM node is created and added to the layer. Fires only when the layer surfaceType is
"svg" or "vml". (Added at v3.7)Event Object Properties:
< |
Graphic being drawn. |
< |
Graphic's DOM node. |
This event is fired when a graphic's DOM node is removed (consider the node destroyed). The DOM node of a graphic is removed when:
- Graphic is removed from the layer.
- Graphic exits the viewport on map navigation.
- When a symbol change cannot be applied to the Graphic without replacing the current node with a new one. For example: when a marker symbol is changed from SimpleMarkerSymbol to PictureMarkerSymbol, onGraphicNodeRemove will be fired for the node that is being replaced (SVG Circle) and onGraphicNodeAdd will be fired for the new node (SVG Image).
"svg" or "vml". (Added at v3.7)Event Object Properties:
< |
Graphic being drawn. |
< |
Graphic's DOM node. |
Fires when a graphic is removed from the GraphicsLayer. Should be used in favor of onGraphicRemove. (Added at v3.5)
Event Object Properties:
< |
The removed graphic. |
Fires when all graphics in the GraphicsLayer are cleared. Should be used in favor of onGraphicsClear. (Added at v3.5)
Fires when a mouse button is pressed down and the mouse cursor is on a graphic. Should be used in favor of onMouseDown. (Added at v3.5)
Event Object:
< |
A standard DOM MouseEvent with additional properties mapPoint and screenPoint. |
Fires while the mouse is being dragged until the mouse button is released. Should be used in favor of onMouseDrag. (Added at v3.5)
Event Object:
< |
A standard DOM MouseEvent with additional properties mapPoint and screenPoint. |
Fires as the mouse moves through a graphic on the GraphicsLayer. Should be used in favor of onMouseMove. (Added at v3.5)
Event Object:
< |
A standard DOM MouseEvent with additional properties mapPoint and screenPoint. |
Fires as the mouse exits a graphic on the GraphicsLayer. Should be used in favor of onMouseOut. (Added at v3.5)
Event Object:
< |
A standard DOM MouseEvent with additional properties mapPoint and screenPoint. |
Fires when the mouse first enters into a graphic on the GraphicsLayer. Should be used in favor of onMouseOver. (Added at v3.5)
Event Object:
< |
A standard DOM MouseEvent with additional properties mapPoint and screenPoint. |
Fires when a mouse button is released and the mouse cursor is on a graphic. Should be used in favor of onMouseUp. (Added at v3.5)
Event Object:
< |
A standard DOM MouseEvent with additional properties mapPoint and screenPoint. |
Fires when the layer opacity has been changed, and returns an object with the opacity value. Should be used in favor of onOpacityChange. (Added at v3.5)
Event Object Properties:
< |
Fires when the layer opacity (transparency) changes. A number property named opacity that indicates the new opacity. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency. |
Fires when a layer's minScale and/or maxScale is changed. Should be used in favor of onScaleRangeChange. (Added at v3.5)
Fires when a layer's scale visibility changes. The scale visibility changes when a layer is initially visible and becomes invisible because the map scale does not intersect the layer's scale range or vice versa. Should be used in favor of onScaleVisibilityChange. (Added at v3.5)
Fires any time a layer has finished loading or updating itself.
For an ArcGISTiledMapServiceLayer,
the event fires when all required tiles have been retrieved and displayed. For an
ArcGISDynamicMapServiceLayer or
ArcGISImageServiceLayer, the event fires
when the map image has been retrieved and displayed. For a GraphicsLayer,
the event fires when all graphics have been redrawn after a pan or zoom.
Deprecated at v2.0. Use update-start and update-end instead. (Added at v3.6)
Fires when a layer has finished updating its content. It is the responsibility of the subclass to determine when this event is fired. Should be used in favor of onUpdateEnd. (Added at v3.5)
Event Object Properties:
< |
Optional argument. The error object is available when an error occurs during the update. |
Fires when a layer begins to update its content. It is the responsibility of the subclass to determine when this event is fired. Should be used in favor of onUpdateStart. (Added at v3.5)
Fires when the layer visibility has been changed, and returns an object with a Boolean visible property containing the new visibility value of the layer. Should be used in favor of onVisibilityChange. (Added at v3.5)
Event Object Properties:
< |
Fires when the layer visibility changes. A boolean property named visible indicates whether or not the layer is visible after visibility changed. |