Class: UrlTemplateImageryProvider

// Access Natural Earth II imagery, which uses a TMS tiling scheme and Geographic (EPSG:4326) project
var tms = new SuperMap3D.UrlTemplateImageryProvider({
    url : 'https://cesiumjs.org/tilesets/imagery/naturalearthii/{z}/{x}/{reverseY}.jpg',
    credit : '© Analytical Graphics, Inc.',
    tilingScheme : new SuperMap3D.GeographicTilingScheme(),
    maximumLevel : 5
});
// Access the CartoDB Positron basemap, which uses an OpenStreetMap-like tiling scheme.
var positron = new SuperMap3D.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 SuperMap3D.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 : SuperMap3D.Rectangle.fromDegrees(96.799393, -43.598214999057824, 153.63925700000001, -9.2159219997013)
});

Members

readonly creditCredit

Obtain the copyright statement to be displayed when this image provider is active. This is usually used to prove the source of the image. This function should not be called before the URL Template ImageryProvider # ready returns true.

Default Value:

undefined

Methods

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

Obtain the copyright statement to be displayed when displaying a given tile.

Name	Type	Description
x	Number	The X-coordinate of the tile.
y	Number	The Y coordinate of the tile.
level	Number	The level of tiles.

Throws:

GetTileCredits must not be called before the video provider is ready.

Type

DeveloperError

Returns:

Type	Description
Array.<Credit>	The copyright statement to be displayed when displaying tiles.

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

Asynchronous determination of the terrain features (if any) at the given longitude and latitude in the tile. This function should not be called before ImageryProvider # ready returns true.

Name	Type	Description
x	Number	The X-coordinate of the tile.
y	Number	The Y coordinate of the tile.
level	Number	The level of tiles.
longitude	Number	Select the longitude of the feature.
latitude	Number	Select the latitude of the feature.

Returns:

Type	Description
Promise.<Array.<ImageryLayerFeatureInfo>> | undefined	The Promise for the selected feature will be resolved upon completion of asynchronous selection. The parsed value is an array of ImageryLayerElementInfo instances. If no features are found at the given location, the array may be empty. If selection is not supported, it may also be undefined.

reinitialize(options)

Reinitialize the instance. Support reinitializing instances that are already in use, but it is not recommended as the existing tiles provided by the image provider will not be updated.

Name	Type	Description
options	Promise.<Object> | Object	Any options that can be passed to the UrlTemplateImageryProvider constructor.

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

Request to specify the image of the tile. This function should not be called before UrlTemplateImageryProvider # ready returns true.

Name	Type	Description
x	Number	The X-coordinate of the tile.
y	Number	The Y coordinate of the tile.
level	Number	The level of tiles.
request	Request	optional Request object. For internal use only.

Returns:

Type	Description
Promise.<(Image|Canvas)> | undefined	A promise for the image, which will be parsed when the image is available. If there are too many active requests to the server, it will not be defined and the request should be retried later. The parsed image can be an image object or a Canvas DOM object.