Class: BingMaps

ol/source/BingMaps~BingMaps 


import BingMaps from 'ol/source/BingMaps.js';

Layer source for Bing Maps tile data.

new BingMaps(options)

source/BingMaps.js, line 122
Name Type Description
cacheSize number | undefined

Deprecated. Use the cacheSize option on the layer instead.
hidpi boolean (defaults to false)

If true hidpi tiles will be requested.
culture string (defaults to 'en-us')

Culture code.
key string

Bing Maps API key. Get yours at https://www.bingmapsportal.com/.
imagerySet string

Type of imagery.
interpolate boolean (defaults to true)

Use interpolated values when resampling. By default, linear interpolation is used when resampling. Set to false to use the nearest neighbor instead.
maxZoom number (defaults to 21)

Max zoom. Default is what's advertized by the BingMaps service.
reprojectionErrorThreshold number (defaults to 0.5)

Maximum allowed reprojection error (in pixels). Higher values can increase reprojection performance, but decrease precision.
tileLoadFunction LoadFunction | undefined

Optional function to load a tile given a URL. The default is

function(imageTile, src) {
  imageTile.getImage().src = src;
};
wrapX boolean (defaults to true)

Whether to wrap the world horizontally.
transition number | undefined

Duration of the opacity transition for rendering. To disable the opacity transition, pass transition: 0.
zDirection number | NearestDirectionFunction (defaults to 0)

Choose whether to use tiles with a higher or lower zoom level when between integer zoom levels. See getZForResolution.
placeholderTiles boolean | undefined

Whether to show BingMaps placeholder tiles when zoomed past the maximum level provided in an area. When false, requests beyond the maximum zoom level will return no tile. When true, the placeholder tile will be returned. When not set, the default behaviour of the imagery set takes place, which is unique for each imagery set in BingMaps.
url string (defaults to 'https://dev.virtualearth.net/REST/v1/Imagery/Metadata/')

The Bing Map Metadata API URL.
Deprecated
  • Bing Maps for Enterprise is being retired on June 30th, 2028. Use `ol/source/ImageTile` with the Azure Maps tile API instead. See the azure-maps example for guidance.
    Fires:

    Extends

    Methods

    changed() inherited

    Observable.js, line 68

    Increases the revision counter and dispatches a 'change' event.

    clear() inherited

    source/Tile.js, line 258

    Remove all cached reprojected tiles from the source. The next render cycle will create new tiles.

    dispatchEvent(event){boolean | undefined} inherited

    events/Target.js, line 85

    Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

    Name Type Description
    event BaseEvent | string

    Event object.
    Returns:
    false if anyone called preventDefault on the event object or if any of the listeners returned false.

    get(key){*} inherited

    Object.js, line 136

    Gets a value.

    Name Type Description
    key string

    Key name.
    Returns:
    Value.

    getApiKey(){string}

    source/BingMaps.js, line 199

    Get the api key used for this source.

    Returns:
    The api key.

    getAttributions(){Attribution} inherited

    source/Source.js, line 129

    Get the attribution function for the source.

    Returns:
    Attribution function.

    getAttributionsCollapsible(){boolean} inherited

    source/Source.js, line 137
    Returns:
    Attributions are collapsible.

    getImagerySet(){string}

    source/BingMaps.js, line 209

    Get the imagery set associated with this source.

    Returns:
    The imagery set.

    getKeys(){Array.<string>} inherited

    Object.js, line 149

    Get a list of object property names.

    Returns:
    List of property names.

    getProjection(){Projection | null} inherited

    source/Source.js, line 146

    Get the projection of the source.

    Returns:
    Projection.

    getProperties(){NoInfer.<Properties>} inherited

    Object.js, line 158

    Get an object of all property names and values.

    Returns:
    Object.

    getRevision(){number} inherited

    Observable.js, line 79

    Get the version number for this object. Each time the object is modified, its version number will be incremented.

    Returns:
    Revision.

    getState(){State} inherited

    source/Source.js, line 201

    Get the state of the source, see State for possible states.

    Returns:
    State.

    getTileGrid(){TileGrid | null} inherited

    source/Tile.js, line 190

    Return the tile grid of the tile source.

    Returns:
    Tile grid.

    getTileLoadFunction(){LoadFunction} inherited

    source/UrlTile.js, line 100

    Deprecated. Use an ImageTile source instead. Return the tile load function of the source.

    Returns:
    TileLoadFunction

    getTileUrlFunction(){UrlFunction} inherited

    source/UrlTile.js, line 110

    Deprecated. Use an ImageTile source instead. Return the tile URL function of the source.

    Returns:
    TileUrlFunction

    getUrls(){!Array.<string> | null} inherited

    source/UrlTile.js, line 124

    Deprecated. Use an ImageTile source instead. Return the URLs used for this source. When a tileUrlFunction is used instead of url or urls, null will be returned.

    Returns:
    URLs.

    on(type, listener){EventsKey | Array<EventsKey>} inherited

    Observable.js, line 152

    Listen for a certain type of event.

    Name Type Description
    type string | Array.<string>

    The event type or array of event types.
    listener function

    The listener function.
    Returns:
    Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

    once(type, listener){EventsKey | Array<EventsKey>} inherited

    Observable.js, line 164

    Listen once for a certain type of event.

    Name Type Description
    type string | Array.<string>

    The event type or array of event types.
    listener function

    The listener function.
    Returns:
    Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

    refresh() inherited

    source/Source.js, line 223

    Refreshes the source. The source will be cleared, and data from the server will be reloaded.

    set(key, value, silent) inherited

    Object.js, line 218

    Sets a value.

    Name Type Description
    key string

    Key name.
    value *

    Value.
    silent boolean | undefined

    Update without triggering an event.

    setAttributions(attributions) inherited

    source/Source.js, line 234

    Set the attributions of the source.

    Name Type Description
    attributions AttributionLike | undefined

    Attributions. Can be passed as string, Array<string>, Attribution, or undefined.

    setProperties(values, silent) inherited

    Object.js, line 238

    Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

    Name Type Description
    values Partial.<NoInfer.<Properties>>

    Values.
    silent boolean | undefined

    Update without triggering an event.

    setRenderReprojectionEdges(render) inherited

    source/TileImage.js, line 301

    Sets whether to render reprojection edges or not (usually for debugging).

    Name Type Description
    render boolean

    Render the edges.

    setTileGridForProjection(projection, tilegrid) inherited

    source/TileImage.js, line 321

    Sets the tile grid to use when reprojecting the tiles to the given projection instead of the default tile grid for the projection.

    This can be useful when the default tile grid cannot be created (e.g. projection has no extent defined) or for optimization reasons (custom tile size, resolutions, ...).

    Name Type Description
    projection ProjectionLike

    Projection.
    tilegrid TileGrid

    Tile grid to use for the projection.

    setTileLoadFunction(tileLoadFunction) inherited

    source/UrlTile.js, line 161

    Deprecated. Use an ImageTile source instead. Set the tile load function of the source.

    Name Type Description
    tileLoadFunction LoadFunction

    Tile load function.

    setTileUrlFunction(tileUrlFunction, key) inherited

    source/UrlTile.js, line 173

    Deprecated. Use an ImageTile source instead. Set the tile URL function of the source.

    Name Type Description
    tileUrlFunction UrlFunction

    Tile URL function.
    key string | undefined

    Optional new tile key for the source.

    setUrl(url) inherited

    source/UrlTile.js, line 187

    Set the URL to use for requests.

    Name Type Description
    url string

    URL.

    setUrls(urls) inherited

    source/UrlTile.js, line 199

    Deprecated. Use an ImageTile source instead. Set the URLs to use for requests.

    Name Type Description
    urls Array.<string>

    URLs.

    un(type, listener) inherited

    Observable.js, line 173

    Unlisten for a certain type of event.

    Name Type Description
    type string | Array.<string>

    The event type or array of event types.
    listener function

    The listener function.

    unset(key, silent) inherited

    Object.js, line 262

    Unsets a property.

    Name Type Description
    key string

    Key name.
    silent boolean | undefined

    Unset without triggering an event.