WebMapServiceImageryProvider

new WebMapServiceImageryProvider()

Provides tiled imagery hosted by a Web Map Service (WMS) server.
Name Type Default Description
options.url String The URL of the WMS service.
options.layers String The layers to include, separated by commas.
options.parameters Object WebMapServiceImageryProvider.DefaultParameters optional Additional parameters to pass to the WMS server in the GetMap URL.
options.rectangle Rectangle Rectangle.MAX_VALUE optional The rectangle of the layer.
options.maximumLevel Number optional The maximum level-of-detail supported by the imagery provider. If not specified, there is no limit.
options.credit Credit | String optional A credit for the data source, which is displayed on the canvas.
options.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/')
});
See:
Source: Scene/WebMapServiceImageryProvider.js, line 61

Members

staticWebMapServiceImageryProvider.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 429

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 352

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 329

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 367

layers

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

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 236

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 254

proxy :Proxy

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

ready :Boolean

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

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 290

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 310

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 218

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 272

url :String

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

Methods

getTileCredits(x, y, level) → 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 387

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 408