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.
// Automatically generated - do not modify!
@file:JsModule("cesium")
@file:Suppress(
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)
package cesium
/**
* Provides tiled imagery served by [WMTS 1.0.0](http://www.opengeospatial.org/standards/wmts) compliant servers.
* This provider supports HTTP KVP-encoded and RESTful GetTile requests, but does not yet support the SOAP encoding.
* ```
* // Example 1. USGS shaded relief tiles (KVP)
* const shadedRelief1 = new WebMapTileServiceImageryProvider({
* url : 'http://basemap.nationalmap.gov/arcgis/rest/services/USGSShadedReliefOnly/MapServer/WMTS',
* layer : 'USGSShadedReliefOnly',
* style : 'default',
* format : 'image/jpeg',
* tileMatrixSetID : 'default028mm',
* // tileMatrixLabels : ['default028mm:0', 'default028mm:1', 'default028mm:2' ...],
* maximumLevel: 19,
* credit : new Credit('U. S. Geological Survey')
* });
* viewer.imageryLayers.addImageryProvider(shadedRelief1);
* ```
* ```
* // Example 2. USGS shaded relief tiles (RESTful)
* const shadedRelief2 = new WebMapTileServiceImageryProvider({
* url : 'http://basemap.nationalmap.gov/arcgis/rest/services/USGSShadedReliefOnly/MapServer/WMTS/tile/1.0.0/USGSShadedReliefOnly/{Style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.jpg',
* layer : 'USGSShadedReliefOnly',
* style : 'default',
* format : 'image/jpeg',
* tileMatrixSetID : 'default028mm',
* maximumLevel: 19,
* credit : new Credit('U. S. Geological Survey')
* });
* viewer.imageryLayers.addImageryProvider(shadedRelief2);
* ```
* ```
* // Example 3. NASA time dynamic weather data (RESTful)
* const times = TimeIntervalCollection.fromIso8601({
* iso8601: '2015-07-30/2017-06-16/P1D',
* dataCallback: function dataCallback(interval, index) {
* return {
* Time: JulianDate.toIso8601(interval.start)
* };
* }
* });
* const weather = new WebMapTileServiceImageryProvider({
* url : 'https://gibs.earthdata.nasa.gov/wmts/epsg4326/best/AMSR2_Snow_Water_Equivalent/default/{Time}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.png',
* layer : 'AMSR2_Snow_Water_Equivalent',
* style : 'default',
* tileMatrixSetID : '2km',
* maximumLevel : 5,
* format : 'image/png',
* clock: clock,
* times: times,
* credit : new Credit('NASA Global Imagery Browse Services for EOSDIS')
* });
* viewer.imageryLayers.addImageryProvider(weather);
* ```
* @see Online Documentation
*/
external class WebMapTileServiceImageryProvider(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 the URL of the service hosting the imagery.
* @see Online Documentation
*/
val url: 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 [WebMapTileServiceImageryProvider.ready] returns true.
* @see Online Documentation
*/
val tileWidth: Int
/**
* Gets the height of each tile, in pixels. This function should
* not be called before [WebMapTileServiceImageryProvider.ready] returns true.
* @see Online Documentation
*/
val tileHeight: Int
/**
* Gets the maximum level-of-detail that can be requested. This function should
* not be called before [WebMapTileServiceImageryProvider.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 [WebMapTileServiceImageryProvider.ready] returns true.
* @see Online Documentation
*/
val minimumLevel: Int
/**
* Gets the tiling scheme used by this provider. This function should
* not be called before [WebMapTileServiceImageryProvider.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 [WebMapTileServiceImageryProvider.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 [WebMapTileServiceImageryProvider.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 the mime type of images returned by this imagery provider.
* @see Online Documentation
*/
val format: String
/**
* 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 [WebMapTileServiceImageryProvider.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.
* @see Online Documentation
*/
val hasAlphaChannel: Boolean
/**
* Gets or sets a clock that is used to get keep the time used for time dynamic parameters.
* @see Online Documentation
*/
var clock: Clock
/**
* Gets or sets a time interval collection that is used to get time dynamic parameters. The data of each
* TimeInterval is an object containing the keys and values of the properties that are used during
* tile requests.
* @see Online Documentation
*/
var times: TimeIntervalCollection
/**
* Gets or sets an object that contains static dimensions and their values.
* @see Online Documentation
*/
var dimensions: 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 [WebMapTileServiceImageryProvider.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?
/**
* Picking features is not currently supported by this imagery provider, so this function simply returns
* undefined.
* @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 WebMapTileServiceImageryProvider constructor
* @property [url] The base URL for the WMTS GetTile operation (for KVP-encoded requests) or the tile-URL template (for RESTful requests). The tile-URL template should contain the following variables: {style}, {TileMatrixSet}, {TileMatrix}, {TileRow}, {TileCol}. The first two are optional if actual values are hardcoded or not required by the server. The {s} keyword may be used to specify subdomains.
* @property [format] The MIME type for images to retrieve from the server.
* Default value - `'image/jpeg'`
* @property [layer] The layer name for WMTS requests.
* @property [style] The style name for WMTS requests.
* @property [tileMatrixSetID] The identifier of the TileMatrixSet to use for WMTS requests.
* @property [tileMatrixLabels] A list of identifiers in the TileMatrix to use for WMTS requests, one per TileMatrix level.
* @property [clock] A Clock instance that is used when determining the value for the time dimension. Required when `times` is specified.
* @property [times] TimeIntervalCollection with its `data` property being an object containing time dynamic dimension and their values.
* @property [dimensions] A object containing static dimensions and their values.
* @property [tileWidth] The tile width in pixels.
* Default value - `256`
* @property [tileHeight] The tile height in pixels.
* Default value - `256`
* @property [tilingScheme] The tiling scheme corresponding to the organization of the tiles in the TileMatrixSet.
* @property [rectangle] The rectangle covered by the layer.
* Default value - [Rectangle.MAX_VALUE]
* @property [minimumLevel] The minimum level-of-detail supported by the imagery provider.
* Default value - `0`
* @property [maximumLevel] The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit.
* @property [ellipsoid] The ellipsoid. If not specified, the WGS84 ellipsoid is used.
* @property [credit] A credit for the data source, which is displayed on the canvas.
* @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'`
* @see Online Documentation
*/
interface ConstructorOptions {
var url: Resource
var format: String?
var layer: String
var style: String
var tileMatrixSetID: String
var tileMatrixLabels: Array?
var clock: Clock?
var times: TimeIntervalCollection?
var dimensions: Any?
var tileWidth: Int?
var tileHeight: Int?
var tilingScheme: TilingScheme?
var rectangle: Rectangle?
var minimumLevel: Int?
var maximumLevel: Int?
var ellipsoid: Ellipsoid?
var credit: Credit?
var subdomains: Array?
}
}
inline fun WebMapTileServiceImageryProvider(
block: WebMapTileServiceImageryProvider.ConstructorOptions.() -> Unit,
): WebMapTileServiceImageryProvider {
val options: WebMapTileServiceImageryProvider.ConstructorOptions = js("({})")
block(options)
return WebMapTileServiceImageryProvider(options)
}
