new UrlTemplateImageryProvider(options)
Provides imagery by requesting tiles using a specified URL template.
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
optional
Object with the following properties:
|
Example:
// Access Natural Earth II imagery, which uses a TMS tiling scheme and Geographic (EPSG:4326) project
var tms = new Cesium.UrlTemplateImageryProvider({
url : '//cesiumjs.org/tilesets/imagery/naturalearthii/{z}/{x}/{reverseY}.jpg',
credit : '© Analytical Graphics, Inc.',
tilingScheme : new Cesium.GeographicTilingScheme(),
maximumLevel : 5
});
// Access the CartoDB Positron basemap, which uses an OpenStreetMap-like tiling scheme.
var positron = new Cesium.UrlTemplateImageryProvider({
url : 'http://{s}.basemaps.cartocdn.com/light_all/{z}/{x}/{y}.png',
credit : 'Map tiles by CartoDB, under CC BY 3.0. Data by OpenStreetMap, under ODbL.'
});
// Access a Web Map Service (WMS) server.
var wms = new Cesium.UrlTemplateImageryProvider({
url : 'https://programs.communications.gov.au/geoserver/ows?tiled=true&' +
'transparent=true&format=image%2Fpng&exceptions=application%2Fvnd.ogc.se_xml&' +
'styles=&service=WMS&version=1.1.1&request=GetMap&' +
'layers=public%3AMyBroadband_Availability&srs=EPSG%3A3857&' +
'bbox={westProjected}%2C{southProjected}%2C{eastProjected}%2C{northProjected}&' +
'width=256&height=256',
rectangle : Cesium.Rectangle.fromDegrees(96.799393, -43.598214999057824, 153.63925700000001, -9.2159219997013)
});
See:
Members
-
readonlycredit :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
UrlTemplateImageryProvider#ready
returns true.-
Default Value:
undefined
-
readonlyerrorEvent :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
. -
readonlyhasAlphaChannel :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.
-
Default Value:
true
-
readonlymaximumLevel :Number
-
Gets the maximum level-of-detail that can be requested, or undefined if there is no limit. This function should not be called before
UrlTemplateImageryProvider#ready
returns true.-
Default Value:
undefined
-
readonlyminimumLevel :Number
-
Gets the minimum level-of-detail that can be requested. This function should not be called before
UrlTemplateImageryProvider#ready
returns true.-
Default Value:
0
-
readonlyproxy :Proxy
-
Gets the proxy used by this provider.
-
Default Value:
undefined
-
readonlyready :Boolean
-
Gets a value indicating whether or not the provider is ready for use.
-
readonlyrectangle :Rectangle
-
Gets the rectangle, in radians, of the imagery provided by this instance. This function should not be called before
UrlTemplateImageryProvider#ready
returns true.-
Default Value:
tilingScheme.rectangle
-
readonlytileDiscardPolicy :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
UrlTemplateImageryProvider#ready
returns true.-
Default Value:
undefined
-
readonlytileHeight :Number
-
Gets the height of each tile, in pixels. This function should not be called before
UrlTemplateImageryProvider#ready
returns true.-
Default Value:
256
-
readonlytileWidth :Number
-
Gets the width of each tile, in pixels. This function should not be called before
UrlTemplateImageryProvider#ready
returns true.-
Default Value:
256
-
readonlytilingScheme :TilingScheme
-
Gets the tiling scheme used by this provider. This function should not be called before
UrlTemplateImageryProvider#ready
returns true.-
Default Value:
new WebMercatorTilingScheme()
-
readonlyurl :String
-
Gets the URL template to use to request tiles. It has the following keywords:
-
{z}
: The level of the tile in the tiling scheme. Level zero is the root of the quadtree pyramid. -
{x}
: The tile X coordinate in the tiling scheme, where 0 is the Westernmost tile. -
{y}
: The tile Y coordinate in the tiling scheme, where 0 is the Northernmost tile. -
{s}
: One of the available subdomains, used to overcome browser limits on the number of simultaneous requests per host. -
{reverseX}
: The tile X coordinate in the tiling scheme, where 0 is the Easternmost tile. -
{reverseY}
: The tile Y coordinate in the tiling scheme, where 0 is the Southernmost tile. -
{westDegrees}
: The Western edge of the tile in geodetic degrees. -
{southDegrees}
: The Southern edge of the tile in geodetic degrees. -
{eastDegrees}
: The Eastern edge of the tile in geodetic degrees. -
{northDegrees}
: The Northern edge of the tile in geodetic degrees. -
{westProjected}
: The Western edge of the tile in projected coordinates of the tiling scheme. -
{southProjected}
: The Southern edge of the tile in projected coordinates of the tiling scheme. -
{eastProjected}
: The Eastern edge of the tile in projected coordinates of the tiling scheme. -
{northProjected}
: The Northern edge of the tile in projected coordinates of the tiling scheme.
-
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.
-
-
pickFeatures(x, y, level, longitude, latitude) → Promise
-
Picking features is not currently supported by this imagery provider, so this function simply returns undefined.
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 ofImageryLayerFeatureInfo
instances. The array may be empty if no features are found at the given location. It may also be undefined if picking is not supported. -
requestImage(x, y, level) → Promise
-
Requests the image for a given tile. This function should not be called before
UrlTemplateImageryProvider#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.