UrlTemplateImageryProvider

Provides imagery by requesting tiles using a specified URL template.

alias UrlTemplateImageryProvider

{Promise.<Object>|Object} [options] Object with the following properties:
{String} options.url 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.
{String} [options.pickFeaturesUrl] The URL template to use to pick features. If this property is not specified, UrlTemplateImageryProvider#pickFeatures will immediately returned undefined, indicating no features picked. The URL template supports all of the keywords supported by the url parameter, plus the following:
{i}: The pixel column (horizontal coordinate) of the picked position, where the Westernmost pixel is 0.
{j}: The pixel row (vertical coordinate) of the picked position, where the Northernmost pixel is 0.
{reverseI}: The pixel column (horizontal coordinate) of the picked position, where the Easternmost pixel is 0.
{reverseJ}: The pixel row (vertical coordinate) of the picked position, where the Southernmost pixel is 0.
{longitudeDegrees}: The longitude of the picked position in degrees.
{latitudeDegrees}: The latitude of the picked position in degrees.
{longitudeProjected}: The longitude of the picked position in the projected coordinates of the tiling scheme.
{latitudeProjected}: The latitude of the picked position in the projected coordinates of the tiling scheme.
{format}: The format in which to get feature information, as specified in the GetFeatureInfoFormat
{String|String[]} [options.subdomains='abc'] The subdomains to use for the {s} placeholder in the URL template. If this parameter is a single string, each character in the string is a subdomain. If it is an array, each element in the array is a subdomain.
{Object} [options.proxy] A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL.
{Credit|String} [options.credit= ] A credit for the data source, which is displayed on the canvas.
{Number} [options.minimumLevel=0] The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems.
{Number} [options.maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
{Rectangle} [options.rectangle=Rectangle.MAX_VALUE] The rectangle, in radians, covered by the image.
{TilingScheme} [options.tilingScheme=WebMercatorTilingScheme] The tiling scheme specifying how the ellipsoidal surface is broken into tiles. If this parameter is not provided, a WebMercatorTilingScheme is used.
{Ellipsoid} [options.ellipsoid] The ellipsoid. If the tilingScheme is specified, this parameter is ignored and the tiling scheme's ellipsoid is used instead. If neither parameter is specified, the WGS84 ellipsoid is used.
{Number} [options.tileWidth=256] Pixel width of image tiles.
{Number} [options.tileHeight=256] Pixel height of image tiles.
{Boolean} [options.hasAlphaChannel=true] true if the images provided by this imagery provider include an alpha channel; otherwise, false. 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 potentially reduced.
{GetFeatureInfoFormat[]} [options.getFeatureInfoFormats] The formats in which to get feature information at a specific location when UrlTemplateImageryProvider#pickFeatures is invoked. If this parameter is not specified, feature picking is disabled.
{Boolean} [options.enablePickFeatures=true] If true, UrlTemplateImageryProvider#pickFeatures will request the options.pickFeaturesUrl and attempt to interpret 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 know your data source does not support picking features or if you don't want this provider's features to be pickable. Note that this can be dynamically overridden by modifying the UrlTemplateImageryProvider property.

Annotations: @RawJSType() @native() @JSName( "Cesium.UrlTemplateImageryProvider" )
See also: WebMapTileServiceImageryProvider
WebMapServiceImageryProvider
createTileMapServiceImageryProvider
SingleTileImageryProvider
createOpenStreetMapImageryProvider
GoogleEarthImageryProvider
BingMapsImageryProvider
ArcGisMapServerImageryProvider

Linear Supertypes

Object, Any, AnyRef, Any

Instance Constructors

new UrlTemplateImageryProvider(options: UrlTemplateImageryProviderOptions)
new UrlTemplateImageryProvider()

Attributes
protected

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
var credit: Credit
var enablePickFeatures: Boolean
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
var errorEvent: Event
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getTileCredits(x: Double, y: Double, level: Double): Array[Credit]
var hasAlphaChannel: Boolean
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
var maximumLevel: Double
var minimumLevel: Double
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def pickFeatures(x: Double, y: Double, level: Double, longitude: Double, latitude: Double): |[Promise[Array[ImageryLayerFeatureInfo]], Unit]
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
var proxy: Proxy
var ready: Boolean
var readyPromise: Promise[Boolean]
var rectangle: Rectangle
def reinitialize(options: |[Promise[Any], Any]): Dynamic
def requestImage(x: Double, y: Double, level: Double): |[Promise[|[HTMLImageElement, HTMLCanvasElement]], Unit]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
var tileDiscardPolicy: TileDiscardPolicy
var tileHeight: Double
var tileWidth: Double
var tilingScheme: TilingScheme
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
var url: String
def valueOf(): Any

Definition Classes
Object
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package cesium

class UrlTemplateImageryProvider extends Object

Instance Constructors

new UrlTemplateImageryProvider(options: UrlTemplateImageryProviderOptions)

new UrlTemplateImageryProvider()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

var credit: Credit

var enablePickFeatures: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

var errorEvent: Event

def finalize(): Unit

final def getClass(): Class[_]

def getTileCredits(x: Double, y: Double, level: Double): Array[Credit]

var hasAlphaChannel: Boolean

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

var maximumLevel: Double

var minimumLevel: Double

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def pickFeatures(x: Double, y: Double, level: Double, longitude: Double, latitude: Double): |[Promise[Array[ImageryLayerFeatureInfo]], Unit]

def propertyIsEnumerable(v: String): Boolean

var proxy: Proxy

var ready: Boolean

var readyPromise: Promise[Boolean]

var rectangle: Rectangle

def reinitialize(options: |[Promise[Any], Any]): Dynamic

def requestImage(x: Double, y: Double, level: Double): |[Promise[|[HTMLImageElement, HTMLCanvasElement]], Unit]

final def synchronized[T0](arg0: ⇒ T0): T0

var tileDiscardPolicy: TileDiscardPolicy

var tileHeight: Double

var tileWidth: Double

var tilingScheme: TilingScheme

def toLocaleString(): String

def toString(): String

var url: String

def valueOf(): Any

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped