Class/Object

cesium

UrlTemplateImageryProvider

Related Docs: object UrlTemplateImageryProvider | package cesium

Permalink

class UrlTemplateImageryProvider extends Object with ImageryProvider

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:

- {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:

- {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" )
Example:
  1. // Access Natural Earth II imagery, which uses a TMS tiling scheme and Geographic (EPSG:4326) project var tms = new Cesium.UrlTemplateImageryProvider({ url : 'https://cesiumjs.org/tilesets/imagery/naturalearthii/{z}/{x}/{reverse} jpg', credit : '© Analytical Graphics, Inc.', tilingScheme : new Cesium.GeographicTilingScheme(), maximumLevel : 5 }); // Access the CartoDB Positron basemap, which uses an OpenStreetMap-like tiling scheme. var positron = new Cesium.UrlTemplateImageryProvider({ url : 'http://{s basemaps.cartocdn.com/light_all/{z}/{x}/{y png', credit : 'Map tiles by CartoDB, under CC BY 3.0. Data by OpenStreetMap, under ODbL.' }); // Access a Web Map Service (WMS) server. var wms = new Cesium.UrlTemplateImageryProvider({ url : 'https://programs.communications.gov.au/geoserver/ows?tiled=true&' + 'transparent=true&format=image%2Fpng&exceptions=application%2Fvnd.ogc.se_xml&' + 'styles=&service=WMS&version=1.1.1&request=GetMap&' + 'layers=public%3AMyBroadband_Availability&srs=EPSG%3A3857&' + 'bbox={westProjected}%2C{southProjected}%2C{eastProjected}%2C{northProjected}&' + 'width=256&height=256', rectangle : Cesium.Rectangle.fromDegrees(96.799393, -43.598214999057824, 153.63925700000001, -9.2159219997013) });

See also

WebMapTileServiceImageryProvider

WebMapServiceImageryProvider

createTileMapServiceImageryProvider

SingleTileImageryProvider

createOpenStreetMapImageryProvider

GoogleEarthImageryProvider

BingMapsImageryProvider

ArcGisMapServerImageryProvider

Linear Supertypes
ImageryProvider, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UrlTemplateImageryProvider
  2. ImageryProvider
  3. Object
  4. Any
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UrlTemplateImageryProvider(options: UrlTemplateImageryProviderOptions)

    Permalink
  2. new UrlTemplateImageryProvider()

    Permalink
    Attributes
    protected

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. var credit: Credit

    Permalink
    Definition Classes
    ImageryProvider
  7. var defaultAlpha: Double

    Permalink
    Definition Classes
    ImageryProvider
  8. var defaultBrightness: Double

    Permalink
    Definition Classes
    ImageryProvider
  9. var defaultContrast: Double

    Permalink
    Definition Classes
    ImageryProvider
  10. var defaultGamma: Double

    Permalink
    Definition Classes
    ImageryProvider
  11. var defaultHue: Double

    Permalink
    Definition Classes
    ImageryProvider
  12. var defaultSaturation: Double

    Permalink
    Definition Classes
    ImageryProvider
  13. var enablePickFeatures: Boolean

    Permalink
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  16. var errorEvent: Event

    Permalink
    Definition Classes
    ImageryProvider
  17. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  19. def getTileCredits(x: Double, y: Double, level: Double): Array[Credit]

    Permalink
    Definition Classes
    ImageryProvider
  20. var hasAlphaChannel: Boolean

    Permalink
    Definition Classes
    ImageryProvider
  21. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  22. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  24. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  25. var maximumLevel: Double

    Permalink
    Definition Classes
    ImageryProvider
  26. var minimumLevel: Double

    Permalink
    Definition Classes
    ImageryProvider
  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. def pickFeatures(x: Double, y: Double, level: Double, longitude: Double, latitude: Double): |[Promise[Array[ImageryLayerFeatureInfo]], Unit]

    Permalink
    Definition Classes
    ImageryProvider
  31. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  32. var proxy: Proxy

    Permalink
    Definition Classes
    ImageryProvider
  33. var ready: Boolean

    Permalink
    Definition Classes
    ImageryProvider
  34. var readyPromise: Promise[Boolean]

    Permalink
    Definition Classes
    ImageryProvider
  35. var rectangle: Rectangle

    Permalink
    Definition Classes
    ImageryProvider
  36. def reinitialize(options: |[Promise[Any], Any]): Dynamic

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

    Permalink
    Definition Classes
    ImageryProvider
  38. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  39. var tileDiscardPolicy: TileDiscardPolicy

    Permalink
    Definition Classes
    ImageryProvider
  40. var tileHeight: Double

    Permalink
    Definition Classes
    ImageryProvider
  41. var tileWidth: Double

    Permalink
    Definition Classes
    ImageryProvider
  42. var tilingScheme: TilingScheme

    Permalink
    Definition Classes
    ImageryProvider
  43. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  44. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  45. var url: String

    Permalink
  46. def urlSchemeZeroPadding: Object

    Permalink
  47. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  48. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ImageryProvider

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped