org.cesiumjs.cs.scene.providers

Class BingMapsImageryProvider

java.lang.Object

org.cesiumjs.cs.scene.providers.BingMapsImageryProvider

All Implemented Interfaces:

ImageryProvider

@JsType(isNative=true,
        namespace="Cesium",
        name="BingMapsImageryProvider")
public class BingMapsImageryProvider
extends Object
implements ImageryProvider

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
double	defaultGamma The default ImageryLayer#gamma to use for imagery layers created for this provider.

Constructor Summary

Constructors

Constructor and Description
BingMapsImageryProvider(BingMapsImageryProviderOptions options) Provides tiled imagery using the Bing Maps Imagery REST API.

Method Summary

Modifier and Type	Method and Description
Credit	credit() Gets the credit to display when this imagery provider is active.
String	culture() The culture to use when requesting Bing Maps imagery.
Event	errorEvent() Gets an event that is raised when the imagery provider encounters an asynchronous error.
Credit[]	getTileCredits(int x, int y, int level) Gets the credits to be displayed when a given tile is displayed.
boolean	hasAlphaChannel() Gets a value indicating whether or not the images provided by this imagery provider include an alpha channel.
String	key() Gets the Bing Maps key.
String	mapStyle() Gets the type of Bing Maps imagery to load.
int	maximumLevel() Gets the maximum level-of-detail that can be requested.
int	minimumLevel() Gets the minimum level-of-detail that can be requested.
Promise<ImageryLayerFeatureInfo,Void>	pickFeatures(int x, int y, int level, double longitude, double latitude) Picking features is not currently supported by this imagery provider, so this function simply returns undefined.
static Object	quadKeyToTileXY(String quadkey) Converts a tile's quadkey used to request an image from a Bing Maps server into the (x, y, level) position.
boolean	ready() Gets a value indicating whether or not the provider is ready for use.
Promise<Boolean,Void>	readyPromise() Gets a promise that resolves to true when the provider is ready for use.
Rectangle	rectangle() Gets the rectangle, in radians, of the imagery provided by this instance.
Promise<JsImage,Void>	requestImage(int x, int y, int level) Requests the image for a given tile.
TileDiscardPolicy	tileDiscardPolicy() The policy that determines if a tile is invalid and should be discarded.
int	tileHeight() Gets the height of each tile, in pixels.
int	tileWidth() Gets the width of each tile, in pixels.
static String	tileXYToQuadKey(int x, int y, int level) Converts a tiles (x, y, level) position into a quadkey used to request an image from a Bing Maps server.
TilingScheme	tilingScheme() Gets the tiling scheme used by this provider.
String	url() Gets the name of the BingMaps server url hosting the imagery.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultGamma

@JsProperty
public double defaultGamma

The default ImageryLayer#gamma to use for imagery layers created for this provider. Changing this value after creating an ImageryLayer for this provider will have no effect. Instead, set the layer's ImageryLayer#gamma property. Default: 1.0

Constructor Detail

BingMapsImageryProvider

@JsConstructor
public BingMapsImageryProvider(BingMapsImageryProviderOptions options)

Provides tiled imagery using the Bing Maps Imagery REST API.

Parameters:

options - Options

                Example:
                
                BingMapsImageryProviderOptions options = new BingMapsImageryProviderOptions();
                options.url = "https://dev.virtualearth.net";
                options.key = "get-yours-at-https://www.bingmapsportal.com/";
                options.mapStyle = BingMapsStyle.AERIAL();
                ImageryProvider bing = new BingMapsImageryProvider(options);
                
 

Method Detail

credit

@JsProperty(name="credit")
public 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 BingMapsImageryProvider#ready returns true.

culture

@JsProperty(name="culture")
public String culture()

The culture to use when requesting Bing Maps imagery. Not all cultures are supported. See http://msdn.microsoft.com/en-us/library/hh441729.aspx for information on the supported cultures.

errorEvent

@JsProperty(name="errorEvent")
public Event errorEvent()

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.

hasAlphaChannel

@JsProperty(name="hasAlphaChannel")
public boolean hasAlphaChannel()

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. Setting this property to false reduces memory usage and texture upload time.

key

@JsProperty(name="key")
public String key()

Gets the Bing Maps key.

mapStyle

@JsProperty(name="mapStyle")
public String mapStyle()

Gets the type of Bing Maps imagery to load.

maximumLevel

@JsProperty(name="maximumLevel")
public int maximumLevel()

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

minimumLevel

@JsProperty(name="minimumLevel")
public int minimumLevel()

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

ready

@JsProperty(name="ready")
public boolean ready()

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

readyPromise

@JsProperty(name="readyPromise")
public Promise<Boolean,Void> readyPromise()

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

rectangle

@JsProperty(name="rectangle")
public Rectangle rectangle()

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

tileDiscardPolicy

@JsProperty(name="tileDiscardPolicy")
public TileDiscardPolicy tileDiscardPolicy()

The policy that determines if a tile is invalid and should be discarded. By default, a DiscardEmptyTileImagePolicy will be used, with the expectation that the Bing Maps server will send a zero-length response for missing tiles. To ensure that no tiles are discarded, construct and pass a NeverTileDiscardPolicy for this parameter.

tileHeight

@JsProperty(name="tileHeight")
public int tileHeight()

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

tileWidth

@JsProperty(name="tileWidth")
public int tileWidth()

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

tilingScheme

@JsProperty(name="tilingScheme")
public TilingScheme tilingScheme()

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

url

@JsProperty(name="url")
public String url()

Gets the name of the BingMaps server url hosting the imagery.

quadKeyToTileXY

@JsMethod
public static Object quadKeyToTileXY(String quadkey)

Converts a tile's quadkey used to request an image from a Bing Maps server into the (x, y, level) position.

Parameters:

quadkey - The tile's quad key

Returns:

(x, y, level) position

See Also:

Bing Maps Tile System, tileXYToQuadKey(int, int, int)

tileXYToQuadKey

@JsMethod
public static String tileXYToQuadKey(int x,
                                               int y,
                                               int level)

Converts a tiles (x, y, level) position into a quadkey used to request an image from a Bing Maps server.

Parameters:

x - The tile's x coordinate.

y - The tile's y coordinate.

level - The tile's zoom level.

Returns:

QuadKey

See Also:

Bing Maps Tile System, quadKeyToTileXY(String)

getTileCredits

@JsMethod
public Credit[] getTileCredits(int x,
                                         int y,
                                         int level)

Gets the credits to be displayed when a given tile is displayed.

Parameters:

x - The tile X coordinate.

y - The tile Y coordinate.

level - The tile level;

Returns:

The credits to be displayed when the tile is displayed.

pickFeatures

@JsMethod
public Promise<ImageryLayerFeatureInfo,Void> pickFeatures(int x,
                                                                    int y,
                                                                    int level,
                                                                    double longitude,
                                                                    double latitude)

Picking features is not currently supported by this imagery provider, so this function simply returns undefined.

Parameters:

x - The tile X coordinate.

y - The tile Y coordinate.

level - The tile level.

longitude - The longitude at which to pick features.

latitude - 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

@JsMethod
public Promise<JsImage,Void> requestImage(int x,
                                                    int y,
                                                    int level)

Requests the image for a given tile. This function should not be called before BingMapsImageryProvider#ready returns true.

Parameters:

x - The tile X coordinate.

y - The tile Y coordinate.

level - 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.