kotlin-cesium-engine/cesium.engine/Google2DImageryProvider

Google2DImageryProvider

external class Google2DImageryProvider(options: Google2DImageryProvider.ConstructorOptions)(source)

This object is normally not instantiated directly, use [Google2DImageryProvider.fromIonAssetId] or [Google2DImageryProvider.fromUrl].

Provides 2D image tiles from Google 2D Tiles.

Google 2D Tiles can only be used with the Google geocoder.

// Google 2D imagery provider
const googleTilesProvider = Google2DImageryProvider.fromIonAssetId({
    assetId: 3830184
});

// Use your own Google api key
GoogleMaps.defaultApiKey = "your-api-key";

const googleTilesProvider = Google2DImageryProvider.fromUrl({
    mapType: "SATELLITE"
});

Constructors

Google2DImageryProvider

constructor(options: Google2DImageryProvider.ConstructorOptions)

Types

Companion

object Companion

ConstructorOptions

interface ConstructorOptions

Initialization options for the Google2DImageryProvider constructor

Properties

credit

val credit: Credit

Gets the credit to display when this imagery provider is active. Typically this is used to credit the source of the imagery.

errorEvent

val errorEvent: DefaultEvent

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.

hasAlphaChannel

val hasAlphaChannel: Boolean

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.

maximumLevel

val maximumLevel: Int?

Gets the maximum level-of-detail that can be requested.

minimumLevel

val minimumLevel: Int

Gets the minimum level-of-detail that can be requested. Generally, a minimum level should only be used when the rectangle of the imagery is small enough that the number of tiles at the minimum level is small. An imagery provider with more than a few tiles at the minimum level will lead to rendering problems.

proxy

val proxy: Proxy

Gets the proxy used by this provider.

rectangle

val rectangle: Rectangle

Gets the rectangle, in radians, of the imagery provided by the instance.

tileDiscardPolicy

val tileDiscardPolicy: TileDiscardPolicy

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.

tileHeight

val tileHeight: Int

Gets the height of each tile, in pixels.

tileWidth

val tileWidth: Int

Gets the width of each tile, in pixels.

tilingScheme

val tilingScheme: TilingScheme

Gets the tiling scheme used by the provider.

url

val url: String

Gets the URL of the Google 2D Imagery server.

Functions

getTileCredits

fun getTileCredits(x: Double, y: Double, level: Int): ERROR CLASS: Symbol not found for ReadonlyArray<cesium/engine/Credit>??

Gets the credits to be displayed when a given tile is displayed.

pickFeatures

fun pickFeatures(x: Double, y: Double, level: Int, longitude: Double, latitude: Double): ERROR CLASS: Symbol not found for Void

Picking features is not currently supported by this imagery provider, so this function simply returns undefined.

requestImage

suspend fun requestImage(x: Double, y: Double, level: Int, request: Request? = definedExternally): {cesium/engine/ImageryTypes?=} ERROR CLASS: Symbol not found for CanvasImageSource??

Requests the image for a given tile.

requestImageAsync

fun requestImageAsync(x: Double, y: Double, level: Int, request: Request? = definedExternally): ERROR CLASS: Symbol not found for Promise<{cesium/engine/ImageryTypes=} ERROR CLASS: Symbol not found for CanvasImageSource>??

Google2DImageryProvider

See also

Constructors

Types

Properties

Functions