org.cesiumjs.cs.scene.providers

Class UrlTemplateImageryProvider

java.lang.Object

org.cesiumjs.cs.scene.providers.UrlTemplateImageryProvider

All Implemented Interfaces:

ImageryProvider

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

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
boolean	enablePickFeatures If true, UrlTemplateImageryProvider#pickFeatures will invoke the Identify service on the MapServer and return the features included in the response.

Constructor Summary

Constructors

Constructor and Description
UrlTemplateImageryProvider(Promise<UrlTemplateImageryProviderOptions,Void> options) Provides imagery by requesting tiles using a specified URL template.
UrlTemplateImageryProvider(UrlTemplateImageryProviderOptions options) Provides imagery by requesting tiles using a specified URL template.

Method Summary

Modifier and Type	Method and Description
Credit	credit() Gets the credit to display when this imagery provider is active.
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.
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)
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() The rectangle of the layer.
void	reinitialize(Promise<UrlTemplateImageryProviderOptions,Void> options) Reinitializes this instance.
void	reinitialize(UrlTemplateImageryProviderOptions options) Reinitializes 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() The height of each tile in pixels.
int	tileWidth() The width of each tile in pixels.
TilingScheme	tilingScheme() The tiling scheme to use to divide the world into tiles.
String	url() Gets the URL template to use to request tiles.
String	urlSchemeZeroPadding() Gets the URL scheme zero padding for each tile coordinate.

Methods inherited from class java.lang.Object

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

Field Detail

enablePickFeatures

@JsProperty
public boolean enablePickFeatures

If true, UrlTemplateImageryProvider#pickFeatures will invoke the Identify service on the MapServer and return the features included in the response. If false, UrlTemplateImageryProvider#pickFeatures will immediately return undefined (indicating no pickable features) without communicating with the server. Set this property to false if you don't want this provider's features to be pickable. Can be overridden by setting the UrlTemplateImageryProvider#enablePickFeatures property on the object. Default: true

Constructor Detail

UrlTemplateImageryProvider

@JsConstructor
public UrlTemplateImageryProvider(UrlTemplateImageryProviderOptions options)

Provides imagery by requesting tiles using a specified URL template.

Parameters:

options - Options

UrlTemplateImageryProvider

@JsConstructor
public UrlTemplateImageryProvider(Promise<UrlTemplateImageryProviderOptions,Void> options)

Provides imagery by requesting tiles using a specified URL template.

Parameters:

options - 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 UrlTemplateImageryProvider#ready returns true.

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. When this property is false, memory usage and texture upload time are reduced. Default: true

maximumLevel

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

Gets the maximum level-of-detail that can be requested. This function should not be called before UrlTemplateImageryProvider#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 UrlTemplateImageryProvider#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()

The rectangle of the layer. This parameter is ignored when accessing a tiled layer. Default: Rectangle.MAX_VALUE()

tileDiscardPolicy

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

The policy that determines if a tile is invalid and should be discarded. If this value is not specified, a default DiscardMissingTileImagePolicy is used for tiled map servers, and a NeverTileDiscardPolicy is used for non-tiled map servers. In the former case, we request tile 0,0 at the maximum tile level and check pixels (0,0), (200,20), (20,200), (80,110), and (160, 130). If all of these pixels are transparent, the discard check is disabled and no tiles are discarded. If any of them have a non-transparent color, any tile that has the same values in these pixel locations is discarded. The end result of these defaults should be correct tile discarding for a standard ArcGIS Server. To ensure that no tiles are discarded, construct and pass a NeverTileDiscardPolicy for this parameter.

tileWidth

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

The width of each tile in pixels. This parameter is ignored when accessing a tiled server. Default: 256

tileHeight

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

The height of each tile in pixels. This parameter is ignored when accessing a tiled server. Default: 256

tilingScheme

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

The tiling scheme to use to divide the world into tiles. This parameter is ignored when accessing a tiled server. Default: new GeographicTilingScheme

url

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

Gets the URL template to use to request tiles. It has the following keywords: {z}: The level of the tile in the tiling scheme. Level zero is the root of the quadtree pyramid. {x}: The tile X coordinate in the tiling scheme, where 0 is the Westernmost tile. {y}: The tile Y coordinate in the tiling scheme, where 0 is the Northernmost tile. {s}: One of the available subdomains, used to overcome browser limits on the number of simultaneous requests per host. {reverseX}: The tile X coordinate in the tiling scheme, where 0 is the Easternmost tile. {reverseY}: The tile Y coordinate in the tiling scheme, where 0 is the Southernmost tile. {reverseZ}: The level of the tile in the tiling scheme, where level zero is the maximum level of the quadtree pyramid. In order to use reverseZ, maximumLevel must be defined. {westDegrees}: The Western edge of the tile in geodetic degrees. {southDegrees}: The Southern edge of the tile in geodetic degrees. {eastDegrees}: The Eastern edge of the tile in geodetic degrees. {northDegrees}: The Northern edge of the tile in geodetic degrees. {westProjected}: The Western edge of the tile in projected coordinates of the tiling scheme. {southProjected}: The Southern edge of the tile in projected coordinates of the tiling scheme. {eastProjected}: The Eastern edge of the tile in projected coordinates of the tiling scheme. {northProjected}: The Northern edge of the tile in projected coordinates of the tiling scheme. {width}: The width of each tile in pixels. {height}: The height of each tile in pixels.

urlSchemeZeroPadding

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

Gets the URL scheme zero padding for each tile coordinate. The format is '000' where each coordinate will be padded on the left with zeros to match the width of the passed string of zeros. e.g. Setting: urlSchemeZeroPadding : { '{x}' : '0000'} will cause an 'x' value of 12 to return the string '0012' for {x} in the generated URL. It has the following keywords: {z}: The zero padding for the level of the tile in the tiling scheme. {x}: The zero padding for the tile X coordinate in the tiling scheme. {y}: The zero padding for the the tile Y coordinate in the tiling scheme. {reverseX}: The zero padding for the tile reverseX coordinate in the tiling scheme. {reverseY}: The zero padding for the tile reverseY coordinate in the tiling scheme. {reverseZ}: The zero padding for the reverseZ coordinate of the tile in the tiling scheme.

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)

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.

reinitialize

@JsMethod
public void reinitialize(UrlTemplateImageryProviderOptions options)

Reinitializes this instance. Reinitializing an instance already in use is supported, but it is not recommended because existing tiles provided by the imagery provider will not be updated.

Parameters:

options - Any of the options that may be passed to the UrlTemplateImageryProvider constructor.

reinitialize

@JsMethod
public void reinitialize(Promise<UrlTemplateImageryProviderOptions,Void> options)

Reinitializes this instance. Reinitializing an instance already in use is supported, but it is not recommended because existing tiles provided by the imagery provider will not be updated.

Parameters:

options - Any of the options that may be passed to the UrlTemplateImageryProvider constructor.

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 UrlTemplateImageryProvider#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.