OpenStreetMapImageryProvider

new Cesium.OpenStreetMapImageryProvider(options)
Scene/OpenStreetMapImageryProvider.js 71

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 Description
options Object optional Object with the following properties:
Name Type Default Description
url String 'https://a.tile.openstreetmap.org' optional The OpenStreetMap server url.
fileExtension String 'png' optional The file extension for images on the server.
proxy Object optional A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL.
rectangle Rectangle Rectangle.MAX_VALUE optional The rectangle of the layer.
minimumLevel Number 0 optional The minimum level-of-detail supported by the imagery provider.
maximumLevel Number optional The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
ellipsoid Ellipsoid optional The ellipsoid. If not specified, the WGS84 ellipsoid is used.
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.
Deprecated: true
Example:
// OpenStreetMap tile provider
var osm = new Cesium.OpenStreetMapImageryProvider({
    url : 'https://a.tile.openstreetmap.org/'
});
See:

Members

readonlycredit : Credit
Scene/OpenStreetMapImageryProvider.js 334

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.

readonlyerrorEvent : Event
Scene/OpenStreetMapImageryProvider.js 297

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
Scene/OpenStreetMapImageryProvider.js 350

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.

readonlymaximumLevel : Number
Scene/OpenStreetMapImageryProvider.js 199

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

readonlyminimumLevel : Number
Scene/OpenStreetMapImageryProvider.js 218

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

readonlyproxy : Proxy
Scene/OpenStreetMapImageryProvider.js 148

Gets the proxy used by this provider.

readonlyready : Boolean
Scene/OpenStreetMapImageryProvider.js 309

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

readonlyreadyPromise : Boolean
Scene/OpenStreetMapImageryProvider.js 321

Gets a promise that resolves to true when the provider is ready for use.

readonlyrectangle : Rectangle
Scene/OpenStreetMapImageryProvider.js 256

Gets the rectangle, in radians, of the imagery provided by this instance. This function should not be called before OpenStreetMapImageryProvider#ready returns true.

readonlytileDiscardPolicy : TileDiscardPolicy
Scene/OpenStreetMapImageryProvider.js 277

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.

readonlytileHeight : Number
Scene/OpenStreetMapImageryProvider.js 180

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

readonlytileWidth : Number
Scene/OpenStreetMapImageryProvider.js 161

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

readonlytilingScheme : TilingScheme
Scene/OpenStreetMapImageryProvider.js 237

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

readonlyurl : String
Scene/OpenStreetMapImageryProvider.js 136

Gets the URL of the service hosting the imagery.

Methods

getTileCredits(x, y, level) → Array.<Credit>
Scene/OpenStreetMapImageryProvider.js 367

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.<Array.<ImageryLayerFeatureInfo>>|undefined
Scene/OpenStreetMapImageryProvider.js 410

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.

requestImage(x, y, level) → Promise.<(Image|Canvas)>|undefined
Scene/OpenStreetMapImageryProvider.js 385

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.