top
all js glsl

OpenStreetMapImageryProvider

OpenStreetMapImageryProvider

new

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>
 'http://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.extent Extent <optional>
 Extent.MAX_VALUE The extent of the layer.
description.maximumLevel Number <optional>
 18 The maximum level-of-detail supported by the imagery provider.
description.credit String <optional>
 'MapQuest, Open Street Map and contributors, CC-BY-SA' A string crediting the data source, which is displayed on the canvas.
Example
// OpenStreetMap tile provider
var osm = new OpenStreetMapImageryProvider({
    url : 'http://tile.openstreetmap.org/'
});
See:
Source:

Methods

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.

Returns:
Event The event.

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

Throws:
DeveloperError : getExtent must not be called before the imagery provider is ready.
Returns:
Extent The extent.

Gets the logo 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#isReady returns true.

Throws:
DeveloperError : getLogo must not be called before the imagery provider is ready.
Returns:
Image | Canvas A canvas or image containing the log to display, or undefined if there is no logo.

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

Throws:
DeveloperError : getMaximumLevel must not be called before the imagery provider is ready.
Returns:
Number The maximum level.

Gets the proxy used by this provider.

Returns:
Proxy The proxy.
See:

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

Throws:
DeveloperError : getTileDiscardPolicy must not be called before the imagery provider is ready.
Returns:
TileDiscardPolicy The discard policy.
See:

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

Throws:
DeveloperError : getTileHeight must not be called before the imagery provider is ready.
Returns:
Number The height.

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

Throws:
DeveloperError : getTileWidth must not be called before the imagery provider is ready.
Returns:
Number The width.

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

Throws:
DeveloperError : getTilingScheme must not be called before the imagery provider is ready.
Returns:
TilingScheme The tiling scheme.
See:

Gets the URL of the service hosting the imagery.

Returns:
String The URL.

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

Returns:
Boolean True if the provider is ready to use; otherwise, false.

Requests the image for a given tile. This function should not be called before OpenStreetMapImageryProvider#isReady 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.