main.cesium.OpenStreetMapImageryProvider.kt Maven / Gradle / Ivy
The newest version!
// Automatically generated - do not modify!
@file:JsModule("cesium")
@file:Suppress(
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)
package cesium
/**
* An imagery provider that provides tiled imagery hosted by OpenStreetMap
* or another provider of Slippy tiles. The default url connects to OpenStreetMap's volunteer-run
* servers, so you must conform to their
* [Tile Usage Policy](http://wiki.openstreetmap.org/wiki/Tile_usage_policy).
* ```
* const osm = new OpenStreetMapImageryProvider({
* url : 'https://a.tile.openstreetmap.org/'
* });
* ```
* @see Online Documentation
*/
external class OpenStreetMapImageryProvider(options: ConstructorOptions) {
/**
* Initialization options for the OpenStreetMapImageryProvider constructor
* @property [url] The OpenStreetMap server url.
* Default value - `'https://a.tile.openstreetmap.org'`
* @property [fileExtension] The file extension for images on the server.
* Default value - `'png'`
* @property [rectangle] The rectangle of 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.
* Default value - `'MapQuest, Open Street Map and contributors, CC-BY-SA'`
* @see Online Documentation
*/
interface ConstructorOptions {
var url: String?
var fileExtension: String?
var rectangle: Rectangle?
var minimumLevel: Int?
var maximumLevel: Int?
var ellipsoid: Ellipsoid?
var credit: Credit?
}
}
inline fun OpenStreetMapImageryProvider(
block: OpenStreetMapImageryProvider.ConstructorOptions.() -> Unit,
): OpenStreetMapImageryProvider {
val options: OpenStreetMapImageryProvider.ConstructorOptions = js("({})")
block(options)
return OpenStreetMapImageryProvider(options)
}