# WebMapServiceImageryProvider

#### new Cesium.WebMapServiceImageryProvider(options)
Scene/WebMapServiceImageryProvider.js 79

Provides tiled imagery hosted by a Web Map Service (WMS) server.

Name | Type | Description
--- | --- | ---
`options` | WebMapServiceImageryProvider.ConstructorOptions | Object describing initialization options

##### Example:

    var provider = new Cesium.WebMapServiceImageryProvider({
        url : 'https://sampleserver1.arcgisonline.com/ArcGIS/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer/WMSServer',
        layers : '0',
        proxy: new Cesium.DefaultProxy('/proxy/')
    });

    viewer.imageryLayers.addImageryProvider(provider);

##### See:

- ArcGisMapServerImageryProvider
- BingMapsImageryProvider
- GoogleEarthEnterpriseMapsProvider
- OpenStreetMapImageryProvider
- SingleTileImageryProvider
- TileMapServiceImageryProvider
- WebMapTileServiceImageryProvider
- UrlTemplateImageryProvider
- ArcGIS Server REST API
- Cross-Origin Resource Sharing

### Members

#### static constant Cesium.WebMapServiceImageryProvider.DefaultParameters : Object
Scene/WebMapServiceImageryProvider.js 623

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

#### static constant Cesium.WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters : Object
Scene/WebMapServiceImageryProvider.js 640

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

#### clock : Clock
Scene/WebMapServiceImageryProvider.js 512

Gets or sets a clock that is used to get keep the time used for time dynamic parameters.

#### readonly credit : Credit
Scene/WebMapServiceImageryProvider.js 466

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.

#### defaultAlpha : Number|undefined
Scene/WebMapServiceImageryProvider.js 102

The default alpha blending value of this provider, with 0.0 representing fully transparent and 1.0 representing fully opaque.

Default Value: `undefined`

#### defaultBrightness : Number|undefined
Scene/WebMapServiceImageryProvider.js 129

The default brightness of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 makes the imagery darker while greater than 1.0 makes it brighter.

Default Value: `undefined`

#### defaultContrast : Number|undefined
Scene/WebMapServiceImageryProvider.js 138

The default contrast of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the contrast while greater than 1.0 increases it.

Default Value: `undefined`

#### defaultDayAlpha : Number|undefined
Scene/WebMapServiceImageryProvider.js 120

The default alpha blending value on the day side of the globe of this provider, with 0.0 representing fully transparent and 1.0 representing fully opaque.

Default Value: `undefined`

#### defaultGamma : Number|undefined
Scene/WebMapServiceImageryProvider.js 163

The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color.

Default Value: `undefined`

#### defaultHue : Number|undefined
Scene/WebMapServiceImageryProvider.js 146

The default hue of this provider in radians. 0.0 uses the unmodified imagery color.

Default Value: `undefined`

#### defaultMagnificationFilter : TextureMagnificationFilter
Scene/WebMapServiceImageryProvider.js 179

The default texture magnification filter to apply to this provider.

Default Value: `undefined`

#### defaultMinificationFilter : TextureMinificationFilter
Scene/WebMapServiceImageryProvider.js 171

The default texture minification filter to apply to this provider.

Default Value: `undefined`

#### defaultNightAlpha : Number|undefined
Scene/WebMapServiceImageryProvider.js 111

The default alpha blending value on the night side of the globe of this provider, with 0.0 representing fully transparent and 1.0 representing fully opaque.

Default Value: `undefined`

#### defaultSaturation : Number|undefined
Scene/WebMapServiceImageryProvider.js 155

The default saturation of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the saturation while greater than 1.0 increases it.

Default Value: `undefined`

#### enablePickFeatures : Boolean
Scene/WebMapServiceImageryProvider.js 498

Gets or sets a value indicating whether feature picking is enabled. If true, `WebMapServiceImageryProvider#pickFeatures` will invoke the `GetFeatureInfo` service on the WMS server and attempt to interpret 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 data source does not support picking features or if you don't want this provider's features to be pickable.

Default Value: `true`

#### readonly errorEvent : Event
Scene/WebMapServiceImageryProvider.js 429

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`.

#### readonly hasAlphaChannel : Boolean
Scene/WebMapServiceImageryProvider.js 482

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.

#### readonly layers : String
Scene/WebMapServiceImageryProvider.js 322

Gets the names of the WMS layers, separated by commas.

#### readonly maximumLevel : Number|undefined
Scene/WebMapServiceImageryProvider.js 361

Gets the maximum level-of-detail that can be requested. This function should not be called before `WebMapServiceImageryProvider#ready` returns true.

#### readonly minimumLevel : Number
Scene/WebMapServiceImageryProvider.js 374

Gets the minimum level-of-detail that can be requested. This function should not be called before `WebMapServiceImageryProvider#ready` returns true.

#### readonly proxy : Proxy
Scene/WebMapServiceImageryProvider.js 310

Gets the proxy used by this provider.

#### readonly ready : Boolean
Scene/WebMapServiceImageryProvider.js 441

Gets a value indicating whether or not the provider is ready for use.

#### readonly readyPromise : Promise.<Boolean>
Scene/WebMapServiceImageryProvider.js 453

Gets a promise that resolves to true when the provider is ready for use.

#### readonly rectangle : Rectangle
Scene/WebMapServiceImageryProvider.js 400

Gets the rectangle, in radians, of the imagery provided by this instance. This function should not be called before `WebMapServiceImageryProvider#ready` returns true.

#### readonly tileDiscardPolicy : TileDiscardPolicy
Scene/WebMapServiceImageryProvider.js 415

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.

#### readonly tileHeight : Number
Scene/WebMapServiceImageryProvider.js 348

Gets the height of each tile, in pixels. This function should not be called before `WebMapServiceImageryProvider#ready` returns true.

#### readonly tileWidth : Number
Scene/WebMapServiceImageryProvider.js 335

Gets the width of each tile, in pixels. This function should not be called before `WebMapServiceImageryProvider#ready` returns true.

#### readonly tilingScheme : TilingScheme
Scene/WebMapServiceImageryProvider.js 387

Gets the tiling scheme used by this provider. This function should not be called before `WebMapServiceImageryProvider#ready` returns true.

#### times : TimeIntervalCollection
Scene/WebMapServiceImageryProvider.js 527

Gets or sets a time interval collection that is used to get time dynamic parameters. The data of each TimeInterval is an object containing the keys and values of the properties that are used during tile requests.

#### readonly url : String
Scene/WebMapServiceImageryProvider.js 298

Gets the URL of the WMS server.

### Methods

#### getTileCredits(x, y, level) → Array.<Credit>
Scene/WebMapServiceImageryProvider.js 547

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.

#### pickFeatures(x, y, level, longitude, latitude) → Promise.<Array.<ImageryLayerFeatureInfo>>|undefined
Scene/WebMapServiceImageryProvider.js 605

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.

#### requestImage(x, y, level, request) → Promise.<(HTMLImageElement|HTMLCanvasElement)>|undefined
Scene/WebMapServiceImageryProvider.js 566

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.
`request` | Request | optional The request object. Intended for internal use only.

##### 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.

### Type Definitions

#### Cesium.WebMapServiceImageryProvider.ConstructorOptions
Scene/WebMapServiceImageryProvider.js 11

Initialization options for the WebMapServiceImageryProvider constructor

##### Properties:

Name | Type | Attributes | Default | Description
--- | --- | --- | --- | ---
`url` | Resource | String |  |  | The URL of the WMS service. The URL supports the same keywords as the `UrlTemplateImageryProvider`.
`layers` | String |  |  | The layers to include, separated by commas.
`parameters` | Object | <optional> | WebMapServiceImageryProvider.DefaultParameters | Additional parameters to pass to the WMS server in the GetMap URL.
`getFeatureInfoParameters` | Object | <optional> | WebMapServiceImageryProvider.GetFeatureInfoDefaultParameters | Additional parameters to pass to the WMS server in the GetFeatureInfo URL.

`enablePickFeatures`

Boolean

<optional>

true

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. Note that this can be dynamically overridden by modifying the WebMapServiceImageryProvider#enablePickFeatures property.

`getFeatureInfoFormats` | Array.<GetFeatureInfoFormat> | <optional> | WebMapServiceImageryProvider.DefaultGetFeatureInfoFormats | The formats in which to try WMS GetFeatureInfo requests.
`rectangle` | Rectangle | <optional> | Rectangle.MAX_VALUE | The rectangle of the layer.
`tilingScheme` | TilingScheme | <optional> | new GeographicTilingScheme() | The tiling scheme to use to divide the world into tiles.
`ellipsoid` | Ellipsoid | <optional> |  | The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.
`tileWidth` | Number | <optional> | 256 | The width of each tile in pixels.
`tileHeight` | Number | <optional> | 256 | The height of each tile in pixels.
`minimumLevel` | Number | <optional> | 0 | 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, or undefined if there is no limit. If not specified, there is no limit.
`crs` | String | <optional> |  | CRS specification, for use with WMS specification >= 1.3.0.
`srs` | String | <optional> |  | SRS specification, for use with WMS specification 1.1.0 or 1.1.1
`credit` | Credit | String | <optional> |  | A credit for the data source, which is displayed on the canvas.
`subdomains` | String | Array.<String> | <optional> | 'abc' | The subdomains to use for the `{s}` placeholder in the URL template. If this parameter is a single string, each character in the string is a subdomain. If it is an array, each element in the array is a subdomain.
`clock` | Clock | <optional> |  | A Clock instance that is used when determining the value for the time dimension. Required when `times` is specified.
`times` | TimeIntervalCollection | <optional> |  | TimeIntervalCollection with its data property being an object containing time dynamic dimension and their values.