Class: BingMaps

ol.source.BingMaps

Layer source for Bing Maps tile data.

new ol.source.BingMaps(options)

Name Type Description
options

Bing Maps options.

Name Type Description
culture string | undefined

Culture code. Default is en-us.

key string

Bing Maps API key. Get yours at http://bingmapsportal.com/.

imagerySet string

Type of imagery.

maxZoom number | undefined experimental

Max zoom. Default is what's advertized by the BingMaps service (21 currently).

tileLoadFunction ol.TileLoadFunctionType | undefined experimental

Optional function to load a tile given a URL.

wrapX boolean | undefined experimental

Whether to wrap the world horizontally. Default is true.

Fires:

Extends

Members

ol.source.BingMaps.TOS_ATTRIBUTION{ol.Attribution} experimental

The attribution containing a link to the Microsoft® Bing™ Maps Platform APIs’ Terms Of Use.

Methods

changed() inherited experimental

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

Fires:
  • change experimental

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

Get the attributions of the source.

Returns:
Attributions.

getKeys(){Array.<string>} inherited

Get a list of object property names.

Returns:
List of property names.

Get the logo of the source.

Returns:
Logo.

Get the projection of the source.

Returns:
Projection.

getProperties(){Object.<string, *>} inherited

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

Returns:
Revision.

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

Returns:
State.

Return the tile grid of the tile source.

Returns:
Tile grid.

Return the tile load function of the source.

Returns:
TileLoadFunction

Return the tile URL function of the source.

Returns:
TileUrlFunction

on(type, listener, opt_this){goog.events.Key} inherited

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.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

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.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

setProperties(values) inherited

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 Object.<string, *>

Values.

setTileLoadFunction(tileLoadFunction) inherited experimental

Set the tile load function of the source.

Name Type Description
tileLoadFunction ol.TileLoadFunctionType

Tile load function.

setTileUrlFunction(tileUrlFunction) inherited experimental

Set the tile URL function of the source.

Name Type Description
tileUrlFunction ol.TileUrlFunctionType

Tile URL function.

un(type, listener, opt_this) inherited

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.

this Object

The object which was used as this by the listener.

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key goog.events.Key

The key returned by on() or once().

Unsets a property.

Name Type Description
key string

Key name.