WMS
- Last UpdatedMar 04, 2025
- 2 minute read
Uses images provided by a GIS Server that supports the Web Map Service (WMS) standard protocol. This protocol allows to you get server-side rendered images produced from information in a GIS Database. Optionally, you can retrieve feature properties on click, provided the server supports the GetFeatureInfo method.
The time option can be used to retrieve data from the layers for a specific time moment or time range, but only for layers that support this configuration (layers with time dimension).
If you are using a third-party URL, ensure your usage is in compliance with the provider's terms of use.
Some open-source servers that support this specification are:
-
deegree
-
GeoServer
-
MapServer
-
MapGuide Open Source
-
QGIS Server
And some of the proprietary servers supporting WMS are:
-
ArcGIS Server
-
ArcIMS
-
Cubeserv from Terrapixel
-
GeoWebPublisher from Bentley Systems
-
GeognoSIS from Cadcorp
-
GeoMedia
-
Oracle MapViewer
-
SIAS (Smallworld Internet Application Server) from GE Energy
-
Autodesk's Infrastructure Map Server
-
Manifold System
The following table provides the specific configurable options available for this layer:
Property
Type
Description
assetNameTemplate [Optional]
String
Defines template string to generate each feature asset name which is used to set CurrentAsset control property when clicked.
When merge is enabled, the generated asset name is used to match the properties derived from the Features control property.
getFeatureOnClick [Optional]
Boolean
Enables feature information lookup on click (issuing a server request).
layers
String
Layers to display on map.
Value is a comma-separated list of layer names.params [Optional]
{ [key: string]: string;}
Defines WMS GetMap extra parameters.
For more information, refer https://docs.geoserver.org/2.22.x/en/user/services/wms/reference.html#getmap.
popup [Optional]
Popup
Defines layer popup configuration.
For more information, refer Popup.
ratio [Optional]
Number
A value 1 indicates image requests matching the size of the map viewport, 2 indicates an image twice the width and height of the viewport, and so on.
-
Min: 1
-
Default: 1.5
serverType [Optional]
serverType
Describes the type of the remote WMS server.
-
Values: "mapserver" | "geoserver" | "carmentaserver" | "qgis"
styles [Optional]
String
Provides styles in which layers are to be rendered. Value is a comma-separated list of style names, or empty if default styling is required.
tiled [Optional]
Boolean
Gets layers in tile mode (small pieces).
time [Optional]
TimeOrRange
Defines time value or range for layers data.
-
Time
-
TimeNumber (Number): Number of Milliseconds since 1970-1-1.
-
TimeString (String): Represents date and time in ISO 8601 format. Other formats might be supported depending on the browser used.
-
-
TimeRange
-
[Time, Time]
-
type
wms
A type of Layer.
url
String
Defines WMS service URL.
Version [Optional]
String
Provides service version.
-
Example of WMS
Below is an example of a WMS layer:
-
Configuration and map preview

-
Configuration JSON string
{
"layers": "topp:states",
"title": "WMS States",
"type": "wms",
"url": "https://ahocevar.com/geoserver/wms",
"getFeatureOnClick": true,
"tiled": true
}