Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
main.cesium.UrlTemplateImageryProvider.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:JsModule("cesium")
@file:Suppress(
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)
package cesium
/**
* Provides imagery by requesting tiles using a specified URL template.
* ```
* // Access Natural Earth II imagery, which uses a TMS tiling scheme and Geographic (EPSG:4326) project
* const tms = new UrlTemplateImageryProvider({
* url : buildModuleUrl('Assets/Textures/NaturalEarthII') + '/{z}/{x}/{reverseY}.jpg',
* credit : '© Analytical Graphics, Inc.',
* tilingScheme : new GeographicTilingScheme(),
* maximumLevel : 5
* });
* // Access the CartoDB Positron basemap, which uses an OpenStreetMap-like tiling scheme.
* const positron = new 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.
* const wms = new 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 : Rectangle.fromDegrees(96.799393, -43.598214999057824, 153.63925700000001, -9.2159219997013)
* });
* // Using custom tags in your template url.
* const custom = new UrlTemplateImageryProvider({
* url : 'https://yoururl/{Time}/{z}/{y}/{x}.png',
* customTags : {
* Time: function(imageryProvider, x, y, level) {
* return '20171231'
* }
* }
* });
* ```
* @see Online Documentation
*/
external class UrlTemplateImageryProvider(options: ConstructorOptions) {
/**
* The default alpha blending value of this provider, with 0.0 representing fully transparent and
* 1.0 representing fully opaque.
* @see Online Documentation
*/
var defaultAlpha: Double?
/**
* The default alpha blending value on the night side of the globe of this provider, with 0.0 representing fully transparent and
* 1.0 representing fully opaque.
* @see Online Documentation
*/
var defaultNightAlpha: Double?
/**
* The default alpha blending value on the day side of the globe of this provider, with 0.0 representing fully transparent and
* 1.0 representing fully opaque.
* @see Online Documentation
*/
var defaultDayAlpha: Double?
/**
* The default brightness of this provider. 1.0 uses the unmodified imagery color. Less than 1.0
* makes the imagery darker while greater than 1.0 makes it brighter.
* @see Online Documentation
*/
var defaultBrightness: Double?
/**
* The default contrast of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces
* the contrast while greater than 1.0 increases it.
* @see Online Documentation
*/
var defaultContrast: Double?
/**
* The default hue of this provider in radians. 0.0 uses the unmodified imagery color.
* @see Online Documentation
*/
var defaultHue: Double?
/**
* The default saturation of this provider. 1.0 uses the unmodified imagery color. Less than 1.0 reduces the
* saturation while greater than 1.0 increases it.
* @see Online Documentation
*/
var defaultSaturation: Double?
/**
* The default gamma correction to apply to this provider. 1.0 uses the unmodified imagery color.
* @see Online Documentation
*/
var defaultGamma: Double?
/**
* The default texture minification filter to apply to this provider.
* @see Online Documentation
*/
var defaultMinificationFilter: TextureMinificationFilter
/**
* The default texture magnification filter to apply to this provider.
* @see Online Documentation
*/
var defaultMagnificationFilter: TextureMagnificationFilter
/**
* Gets or sets a value indicating whether feature picking is enabled. 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.
* @see Online Documentation
*/
var enablePickFeatures: Boolean
/**
* 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.
* @see Online Documentation
*/
val url: String
/**
* 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.
* @see Online Documentation
*/
val urlSchemeZeroPadding: Any
/**
* Gets the URL template to use to use to pick features. If this property is not specified,
* [UrlTemplateImageryProvider.pickFeatures] will immediately return undefined, indicating no
* features picked. The URL template supports all of the keywords supported by the
* [UrlTemplateImageryProvider.url] property, 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].
* @see Online Documentation
*/
val pickFeaturesUrl: String
/**
* Gets the proxy used by this provider.
* @see Online Documentation
*/
val proxy: Proxy
/**
* Gets the width of each tile, in pixels. This function should
* not be called before [UrlTemplateImageryProvider.ready] returns true.
* @see Online Documentation
*/
val tileWidth: Int
/**
* Gets the height of each tile, in pixels. This function should
* not be called before [UrlTemplateImageryProvider.ready] returns true.
* @see Online Documentation
*/
val tileHeight: Int
/**
* Gets the maximum level-of-detail that can be requested, or undefined if there is no limit.
* This function should not be called before [UrlTemplateImageryProvider.ready] returns true.
* @see Online Documentation
*/
val maximumLevel: Int?
/**
* Gets the minimum level-of-detail that can be requested. This function should
* not be called before [UrlTemplateImageryProvider.ready] returns true.
* @see Online Documentation
*/
val minimumLevel: Int
/**
* Gets the tiling scheme used by this provider. This function should
* not be called before [UrlTemplateImageryProvider.ready] returns true.
* @see Online Documentation
*/
val tilingScheme: TilingScheme
/**
* Gets the rectangle, in radians, of the imagery provided by this instance. This function should
* not be called before [UrlTemplateImageryProvider.ready] returns true.
* @see Online Documentation
*/
val rectangle: Rectangle
/**
* Gets the tile discard policy. If not undefined, the discard policy is responsible
* for filtering out "missing" tiles via its shouldDiscardImage function. If this function
* returns undefined, no tiles are filtered. This function should
* not be called before [UrlTemplateImageryProvider.ready] returns true.
* @see Online Documentation
*/
val tileDiscardPolicy: TileDiscardPolicy
/**
* 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].
* @see Online Documentation
*/
val errorEvent: Event
/**
* Gets a value indicating whether or not the provider is ready for use.
* @see Online Documentation
*/
val ready: Boolean
/**
* Gets a promise that resolves to true when the provider is ready for use.
* @see Online Documentation
*/
val readyPromise: kotlin.js.Promise
/**
* 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.
* @see Online Documentation
*/
val credit: Credit
/**
* 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. This function should
* not be called before [ImageryProvider.ready] returns true.
* @see Online Documentation
*/
val hasAlphaChannel: Boolean
/**
* 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.
* @param [options] Any of the options that may be passed to the [UrlTemplateImageryProvider] constructor.
* @see Online Documentation
*/
fun reinitialize(options: kotlin.js.Promise)
fun reinitialize(options: Any)
/**
* Gets the credits to be displayed when a given tile is displayed.
* @param [x] The tile X coordinate.
* @param [y] The tile Y coordinate.
* @param [level] The tile level;
* @return The credits to be displayed when the tile is displayed.
* @see Online Documentation
*/
fun getTileCredits(
x: Double,
y: Double,
level: Int,
): Array
/**
* Requests the image for a given tile. This function should
* not be called before [UrlTemplateImageryProvider.ready] returns true.
* @param [x] The tile X coordinate.
* @param [y] The tile Y coordinate.
* @param [level] The tile level.
* @param [request] The request object. Intended for internal use only.
* @return 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.
* @see Online Documentation
*/
fun requestImage(
x: Double,
y: Double,
level: Int,
request: Request? = definedExternally,
): kotlin.js.Promise?
/**
* Asynchronously determines what features, if any, are located at a given longitude and latitude within
* a tile. This function should not be called before [ImageryProvider.ready] returns true.
* @param [x] The tile X coordinate.
* @param [y] The tile Y coordinate.
* @param [level] The tile level.
* @param [longitude] The longitude at which to pick features.
* @param [latitude] The latitude at which to pick features.
* @return 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.
* @see Online Documentation
*/
fun pickFeatures(
x: Double,
y: Double,
level: Int,
longitude: Double,
latitude: Double,
): kotlin.js.Promise>?
/**
* Initialization options for the UrlTemplateImageryProvider constructor
* @property [options] Object with the following properties:
* @property [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.
* @property [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].
* @property [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 the passed object 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.
* @property [subdomains] 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.
* Default value - `'abc'`
* @property [credit] A credit for the data source, which is displayed on the canvas.
* Default value - `''`
* @property [minimumLevel] 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.
* Default value - `0`
* @property [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
* @property [rectangle] The rectangle, in radians, covered by the image.
* Default value - [Rectangle.MAX_VALUE]
* @property [tilingScheme] The tiling scheme specifying how the ellipsoidal
* surface is broken into tiles. If this parameter is not provided, a [WebMercatorTilingScheme]
* is used.
* Default value - [WebMercatorTilingScheme]
* @property [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.
* @property [tileWidth] Pixel width of image tiles.
* Default value - `256`
* @property [tileHeight] Pixel height of image tiles.
* Default value - `256`
* @property [hasAlphaChannel] 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.
* Default value - `true`
* @property [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.
* @property [enablePickFeatures] If true, [UrlTemplateImageryProvider.pickFeatures] will
* request the `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 [UriTemplateImageryProvider.enablePickFeatures]
* property.
* Default value - `true`
* @property [customTags] Allow to replace custom keywords in the URL template. The object must have strings as keys and functions as values.
* @see Online Documentation
*/
interface ConstructorOptions {
var options: dynamic
var url: Resource
var pickFeaturesUrl: Resource?
var urlSchemeZeroPadding: Any?
var subdomains: Array?
var credit: Credit?
var minimumLevel: Int?
var maximumLevel: Int?
var rectangle: Rectangle?
var tilingScheme: TilingScheme?
var ellipsoid: Ellipsoid?
var tileWidth: Int?
var tileHeight: Int?
var hasAlphaChannel: Boolean?
var getFeatureInfoFormats: Array?
var enablePickFeatures: Boolean?
var customTags: Any?
}
}
inline fun UrlTemplateImageryProvider(
block: UrlTemplateImageryProvider.ConstructorOptions.() -> Unit,
): UrlTemplateImageryProvider {
val options: UrlTemplateImageryProvider.ConstructorOptions = js("({})")
block(options)
return UrlTemplateImageryProvider(options)
}
