OpenStreetMapImageryProvider

new OpenStreetMapImageryProvider

Provides tiled imagery hosted by OpenStreetMap or another provider of Slippy tiles. Please be aware that a default-constructed instance of this class will connect to OpenStreetMap's volunteer-run servers, so you must conform to their Tile Usage Policy.

Parameters:

Name	Type	Argument	Default	Description
`description.url`	String	<optional>	'//a.tile.openstreetmap.org'	The OpenStreetMap server url.
`description.fileExtension`	String	<optional>	'png'	The file extension for images on the server.
`description.proxy`	Object	<optional>		A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL.
`description.rectangle`	Rectangle	<optional>	Rectangle.MAX_VALUE	The rectangle of the layer.
`description.minimumLevel`	Number	<optional>	0	The minimum level-of-detail supported by the imagery provider.
`description.maximumLevel`	Number	<optional>	18	The maximum level-of-detail supported by the imagery provider.
`description.credit`	Credit \| String	<optional>	'MapQuest, Open Street Map and contributors, CC-BY-SA'	A credit for the data source, which is displayed on the canvas.

Example

// OpenStreetMap tile provider
var osm = new Cesium.OpenStreetMapImageryProvider({
    url : '//a.tile.openstreetmap.org/'
});

See:

Source:

treetMapImageryProvider.js

Members

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 OpenStreetMapImageryProvider#ready returns true.

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.

maximumLevel :Number

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

minimumLevel :Number

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

ready :Boolean

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

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 OpenStreetMapImageryProvider#ready returns true.

tileHeight :Number

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

tileWidth :Number

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

tilingScheme :TilingScheme

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

url :String

Gets the URL of the service hosting the imagery.

<static> proxy :Proxy

Gets the proxy used by this provider.

Methods

getTileCredits

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;

Throws:

DeveloperError : getTileCredits must not be called before the imagery provider is ready.

Returns:

Credit[] The credits to be displayed when the tile is displayed.

requestImage

Requests the image for a given tile. This function should not be called before OpenStreetMapImageryProvider#ready returns true.

Parameters:

Name	Type	Description
`x`	Number	The tile X coordinate.
`y`	Number	The tile Y coordinate.
`level`	Number	The tile level.

Throws:

DeveloperError : requestImage must not be called before the imagery provider is ready.

Returns:

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