UrlTemplateImageryProvider - Cesium Documentation

# UrlTemplateImageryProvider

#### new UrlTemplateImageryProvider(options)

  Provides imagery by requesting tiles using a specified URL template.

  Name | Type | Description
  --- | --- | ---

  `options`

  Object

  optional Object with the following properties:

  Name | Type | Default | Description
  --- | --- | --- | ---

  `url`

  String

  optional 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.
  - `{width}`: The width of each tile in pixels.
  - `{height}`: The height of each tile in pixels.

  `pickFeaturesUrl`

  String

  optional The URL template to use to pick features. If this property is not specified, {@see UrlTemplateImageryProvider#pickFeatures} will immediately returned undefined, indicating no features picked. The URL template supports all of the keywords supported by the `url` parameter, plus the following:
  - `{i}`: The pixel column (horizontal coordinate) of the picked position, where the Westernmost pixel is 0.
  - `{j}`: The pixel row (vertical coordinate) of the picked position, where the Northernmost pixel is 0.
  - `{reverseI}`: The pixel column (horizontal coordinate) of the picked position, where the Easternmost pixel is 0.
  - `{reverseJ}`: The pixel row (vertical coordinate) of the picked position, where the Southernmost pixel is 0.
  - `{longitudeDegrees}`: The longitude of the picked position in degrees.
  - `{latitudeDegrees}`: The latitude of the picked position in degrees.
  - `{longitudeProjected}`: The longitude of the picked position in the projected coordinates of the tiling scheme.
  - `{latitudeProjected}`: The latitude of the picked position in the projected coordinates of the tiling scheme.
  - `{format}`: The format in which to get feature information, as specified in the {@see GetFeatureInfoFormat}.

  `subdomains` | String | Array.<String> | `'abc'` | optional 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.
  `proxy` | Object |  | optional A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL.
  `credit` | Credit | String | `''` | optional A credit for the data source, which is displayed on the canvas.
  `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, or undefined if there is no limit.
  `rectangle` | Rectangle | `Rectangle.MAX_VALUE` | optional The rectangle, in radians, covered by the image.
  `tilingScheme` | TilingScheme | `WebMercatorTilingScheme` | optional The tiling scheme specifying how the ellipsoidal surface is broken into tiles. If this parameter is not provided, a `WebMercatorTilingScheme` is used.
  `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 | `256` | optional Pixel width of image tiles.
  `tileHeight` | Number | `256` | optional Pixel height of image tiles.
  `hasAlphaChannel` | Boolean | `true` | optional true if the images provided by this imagery provider include an alpha channel; otherwise, false. 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 potentially reduced.
  `getFeatureInfoFormats` | Array.<GetFeatureInfoFormat> |  | optional The formats in which to get feature information at a specific location when {@see UrlTemplateImageryProvider#pickFeatures} is invoked. If this parameter is not specified, feature picking is disabled.

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

  - ArcGisMapServerImageryProvider
  - BingMapsImageryProvider
  - GoogleEarthImageryProvider
  - OpenStreetMapImageryProvider
  - SingleTileImageryProvider
  - TileMapServiceImageryProvider
  - WebMapServiceImageryProvider
  - WebMapTileServiceImageryProvider
  Source: Scene/UrlTemplateImageryProvider.js, line 151

### 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`
  Source: Scene/UrlTemplateImageryProvider.js, line 397

#### 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`.
  Source: Scene/UrlTemplateImageryProvider.js, line 371

#### 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`
  Source: Scene/UrlTemplateImageryProvider.js, line 414

#### 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`
  Source: Scene/UrlTemplateImageryProvider.js, line 299

#### 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`
  Source: Scene/UrlTemplateImageryProvider.js, line 313

#### readonlyproxy :Proxy

  Gets the proxy used by this provider.
  Default Value: `undefined`
  Source: Scene/UrlTemplateImageryProvider.js, line 257

#### readonlyready :Boolean

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

#### 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`
  Source: Scene/UrlTemplateImageryProvider.js, line 341

#### 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`
  Source: Scene/UrlTemplateImageryProvider.js, line 357

#### readonlytileHeight :Number

  Gets the height of each tile, in pixels. This function should not be called before `UrlTemplateImageryProvider#ready` returns true.
  Default Value: `256`
  Source: Scene/UrlTemplateImageryProvider.js, line 285

#### readonlytileWidth :Number

  Gets the width of each tile, in pixels. This function should not be called before `UrlTemplateImageryProvider#ready` returns true.
  Default Value: `256`
  Source: Scene/UrlTemplateImageryProvider.js, line 271

#### 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()`
  Source: Scene/UrlTemplateImageryProvider.js, line 327

#### 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.
  - `{width}`: The width of each tile in pixels.
  - `{height}`: The height of each tile in pixels.
  Source: Scene/UrlTemplateImageryProvider.js, line 219

### 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/UrlTemplateImageryProvider.js, line 431

#### 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 of `ImageryLayerFeatureInfo` 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.
  Source: Scene/UrlTemplateImageryProvider.js, line 466

#### 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.
  Source: Scene/UrlTemplateImageryProvider.js, line 447