Class: WebMapServiceImageryProvider

WebMapServiceImageryProvider

new WebMapServiceImageryProvider(options)

Provides tiled imagery hosted by a Web Map Service (WMS) server.
Parameters:
Name Type Description
options Object Object with the following properties:
Properties
Name Type Attributes Default Description
url 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.
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.
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.
Source:
See:
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);

Members

(static, constant) 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:

(static, constant) 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:

(readonly) 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.
Type:
Source:

(readonly) 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.
Type:
Source:

(readonly) 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.
Type:
  • Boolean
Source:

(readonly) layers :String

Gets the names of the WMS layers, separated by commas.
Type:
  • String
Source:

(readonly) maximumLevel :Number

Gets the maximum level-of-detail that can be requested. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Type:
  • Number
Source:

(readonly) minimumLevel :Number

Gets the minimum level-of-detail that can be requested. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Type:
  • Number
Source:

(readonly) proxy :Proxy

Gets the proxy used by this provider.
Type:
  • Proxy
Source:

(readonly) ready :Boolean

Gets a value indicating whether or not the provider is ready for use.
Type:
  • Boolean
Source:

(readonly) readyPromise :Promise.<Boolean>

Gets a promise that resolves to true when the provider is ready for use.
Type:
  • Promise.<Boolean>
Source:

(readonly) 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.
Type:
Source:

(readonly) 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.
Type:
Source:

(readonly) tileHeight :Number

Gets the height of each tile, in pixels. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Type:
  • Number
Source:

(readonly) tileWidth :Number

Gets the width of each tile, in pixels. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Type:
  • Number
Source:

(readonly) tilingScheme :TilingScheme

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

(readonly) url :String

Gets the URL of the WMS server.
Type:
  • String
Source:

Methods

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

Gets the credits to be displayed when a given tile is displayed.
Parameters:
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level;
Source:
Throws:
getTileCredits must not be called before the imagery provider is ready.
Type
DeveloperError
Returns:
The credits to be displayed when the tile is displayed.
Type
Array.<Credit>

pickFeatures(x, y, level, longitude, latitude) → {Promise.<Array.<ImageryLayerFeatureInfo>>|undefined}

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.
Parameters:
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.
Source:
Throws:
pickFeatures must not be called before the imagery provider is ready.
Type
DeveloperError
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.
Type
Promise.<Array.<ImageryLayerFeatureInfo>> | undefined

requestImage(x, y, level) → {Promise.<(Image|Canvas)>|undefined}

Requests the image for a given tile. This function should not be called before WebMapServiceImageryProvider#ready returns true.
Parameters:
Name Type Description
x Number The tile X coordinate.
y Number The tile Y coordinate.
level Number The tile level.
Source:
Throws:
requestImage must not be called before the imagery provider is ready.
Type
DeveloperError
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.
Type
Promise.<(Image|Canvas)> | undefined