WebMapServiceImageryProvider

new WebMapServiceImageryProvider(options)

Provides tiled imagery hosted by a Web Map Service (WMS) server.
Name Type Description
options Object Object with the following properties:
Name Type Default Description
url String The URL of the WMS service.
layers String The layers to include, separated by commas.
parameters Object WebMapServiceImageryProvider.DefaultParameters optional Additional parameters to pass to the WMS server in the GetMap URL.
getFeatureInfoParameters Object WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters optional Additional parameters to pass to the WMS server in the GetFeatureInfo URL.
enablePickFeatures Boolean true optional If true, WebMapServiceImageryProvider#pickFeatures will invoke the GetFeatureInfo operation on the WMS server and return the features included in the response. If false, WebMapServiceImageryProvider#pickFeatures will immediately return undefined (indicating no pickable features) without communicating with the server. Set this property to false if you know your WMS server does not support GetFeatureInfo or if you don't want this provider's features to be pickable.
getFeatureInfoAsGeoJson Boolean true optional true if WebMapServiceImageryProvider#pickFeatures should try requesting feature info in GeoJSON format. If getFeatureInfoAsXml is true as well, feature information will be requested first as GeoJSON, and then as XML if the GeoJSON request fails. If both are false, this instance will not support feature picking at all.
getFeatureInfoAsXml Boolean true optional true if WebMapServiceImageryProvider#pickFeatures should try requesting feature info in XML format. If getFeatureInfoAsGeoJson is true as well, feature information will be requested first as GeoJSON, and then as XML if the GeoJSON request fails. If both are false, this instance will not support feature picking at all.
rectangle Rectangle Rectangle.MAX_VALUE optional The rectangle of the layer.
tilingScheme TilingScheme new GeographicTilingScheme() optional The tiling scheme to use to divide the world into tiles.
tileWidth Number 256 optional The width of each tile in pixels.
tileHeight Number 256 optional The height of each tile in pixels.
minimumLevel Number 0 optional The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems.
maximumLevel Number optional The maximum level-of-detail supported by the imagery provider. If not specified, there is no limit.
credit Credit | String optional A credit for the data source, which is displayed on the canvas.
proxy Object optional A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
Example:
var provider = new Cesium.WebMapServiceImageryProvider({
    url: '//sampleserver1.arcgisonline.com/ArcGIS/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer/WMSServer',
    layers : '0',
    proxy: new Cesium.DefaultProxy('/proxy/')
});

viewer.scene.imageryLayers.addImageryProvider(provider);

// This line is not required to use a WMS imagery layer, but adding it will enable automatic
// display of WMS feature information (if available) on click.
viewer.extend(Cesium.viewerEntityMixin);
See:
Source: Scene/WebMapServiceImageryProvider.js, line 101

Members

staticconstantWebMapServiceImageryProvider.DefaultParameters

The default parameters to include in the WMS URL to obtain images. The values are as follows: service=WMS version=1.1.1 request=GetMap styles= format=image/jpeg
Source: Scene/WebMapServiceImageryProvider.js, line 516

staticconstantWebMapServiceImageryProvider.GetFeatureInfoDefaultParameters

The default parameters to include in the WMS URL to get feature information. The values are as follows: service=WMS version=1.1.1 request=GetFeatureInfo
Source: Scene/WebMapServiceImageryProvider.js, line 532

credit :Credit

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Source: Scene/WebMapServiceImageryProvider.js, line 367

errorEvent :Event

Gets an event that is raised when the imagery provider encounters an asynchronous error. By subscribing to the event, you will be notified of the error and can potentially recover from it. Event listeners are passed an instance of TileProviderError.
Source: Scene/WebMapServiceImageryProvider.js, line 344

hasAlphaChannel :Boolean

Gets a value indicating whether or not the images provided by this imagery provider include an alpha channel. If this property is false, an alpha channel, if present, will be ignored. If this property is true, any images without an alpha channel will be treated as if their alpha is 1.0 everywhere. When this property is false, memory usage and texture upload time are reduced.
Source: Scene/WebMapServiceImageryProvider.js, line 382

layers :String

Gets the names of the WMS layers, separated by commas.
Source: Scene/WebMapServiceImageryProvider.js, line 203

maximumLevel :Number

Gets the maximum level-of-detail that can be requested. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Source: Scene/WebMapServiceImageryProvider.js, line 251

minimumLevel :Number

Gets the minimum level-of-detail that can be requested. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Source: Scene/WebMapServiceImageryProvider.js, line 269

proxy :Proxy

Gets the proxy used by this provider.
Source: Scene/WebMapServiceImageryProvider.js, line 192

ready :Boolean

Gets a value indicating whether or not the provider is ready for use.
Source: Scene/WebMapServiceImageryProvider.js, line 355

rectangle :Rectangle

Gets the rectangle, in radians, of the imagery provided by this instance. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Source: Scene/WebMapServiceImageryProvider.js, line 305

tileDiscardPolicy :TileDiscardPolicy

Gets the tile discard policy. If not undefined, the discard policy is responsible for filtering out "missing" tiles via its shouldDiscardImage function. If this function returns undefined, no tiles are filtered. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Source: Scene/WebMapServiceImageryProvider.js, line 325

tileHeight :Number

Gets the height of each tile, in pixels. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Source: Scene/WebMapServiceImageryProvider.js, line 233

tileWidth :Number

Gets the width of each tile, in pixels. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Source: Scene/WebMapServiceImageryProvider.js, line 215

tilingScheme :TilingScheme

Gets the tiling scheme used by this provider. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Source: Scene/WebMapServiceImageryProvider.js, line 287

url :String

Gets the URL of the WMS server.
Source: Scene/WebMapServiceImageryProvider.js, line 181

Methods

getTileCredits(x, y, level) → Array.<Credit>

Gets the credits to be displayed when a given tile is displayed.
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level;
Returns:
The credits to be displayed when the tile is displayed.
Throws:
  • DeveloperError : getTileCredits must not be called before the imagery provider is ready.
Source: Scene/WebMapServiceImageryProvider.js, line 399

pickFeatures(x, y, level, longitude, latitude) → Promise

Asynchronously determines what features, if any, are located at a given longitude and latitude within a tile. This function should not be called before ImageryProvider#ready returns true.
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level.
longitude Number The longitude at which to pick features.
latitude Number The latitude at which to pick features.
Returns:
A promise for the picked features that will resolve when the asynchronous picking completes. The resolved value is an array of ImageryLayerFeatureInfo instances. The array may be empty if no features are found at the given location.
Throws:
  • DeveloperError : pickFeatures must not be called before the imagery provider is ready.
Source: Scene/WebMapServiceImageryProvider.js, line 446

requestImage(x, y, level) → Promise

Requests the image for a given tile. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level.
Returns:
A promise for the image that will resolve when the image is available, or undefined if there are too many active requests to the server, and the request should be retried later. The resolved image may be either an Image or a Canvas DOM object.
Throws:
  • DeveloperError : requestImage must not be called before the imagery provider is ready.
Source: Scene/WebMapServiceImageryProvider.js, line 417