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

Members

staticOpenStreetMapImageryProvider.proxy :Proxy

Gets the proxy used by this provider.
Source: Scene/OpenStreetMapImageryProvider.js, line 132

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.
Source: Scene/OpenStreetMapImageryProvider.js, line 296

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.
Source: Scene/OpenStreetMapImageryProvider.js, line 273

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.
Source: Scene/OpenStreetMapImageryProvider.js, line 311

maximumLevel :Number

Gets the maximum level-of-detail that can be requested. This function should not be called before OpenStreetMapImageryProvider#ready returns true.
Source: Scene/OpenStreetMapImageryProvider.js, line 180

minimumLevel :Number

Gets the minimum level-of-detail that can be requested. This function should not be called before OpenStreetMapImageryProvider#ready returns true.
Source: Scene/OpenStreetMapImageryProvider.js, line 198

ready :Boolean

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

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.
Source: Scene/OpenStreetMapImageryProvider.js, line 254

tileHeight :Number

Gets the height of each tile, in pixels. This function should not be called before OpenStreetMapImageryProvider#ready returns true.
Source: Scene/OpenStreetMapImageryProvider.js, line 162

tileWidth :Number

Gets the width of each tile, in pixels. This function should not be called before OpenStreetMapImageryProvider#ready returns true.
Source: Scene/OpenStreetMapImageryProvider.js, line 144

tilingScheme :TilingScheme

Gets the tiling scheme used by this provider. This function should not be called before OpenStreetMapImageryProvider#ready returns true.
Source: Scene/OpenStreetMapImageryProvider.js, line 216

url :String

Gets the URL of the service hosting the imagery.
Source: Scene/OpenStreetMapImageryProvider.js, line 121

Methods

getTileCredits(x, y, level) → 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/OpenStreetMapImageryProvider.js, line 331

requestImage(x, y, level) → Promise

Requests the image for a given tile. This function should not be called before OpenStreetMapImageryProvider#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.
Throws:
  • DeveloperError : requestImage must not be called before the imagery provider is ready.
Source: Scene/OpenStreetMapImageryProvider.js, line 352