kotlin-cesium-engine/cesium.engine/Resource/Companion/FetchImageOptions

FetchImageOptions

external interface FetchImageOptions(source)

Properties

abstract external val flipY: Boolean?

Whether to vertically flip the image during fetch and decode. Only applies when requesting an image and the browser supports createImageBitmap. Default value - false

headers

abstract external val headers: JsAny?

Additional HTTP headers that will be sent. Default value - {}

preferBlob

abstract external val preferBlob: Boolean?

If true, we will load the image via a blob. Default value - false

preferImageBitmap

abstract external val preferImageBitmap: Boolean?

If true, image will be decoded during fetch and an ImageBitmap is returned. Default value - false

proxy

abstract external val proxy: Proxy?

A proxy to be used when loading the resource.

queryParameters

abstract external val queryParameters: JsAny?

An object containing query parameters that will be sent when retrieving the resource.

request

abstract external val request: Request?

A Request object that will be used. Intended for internal use only.

retryAttempts

abstract external val retryAttempts: Int?

The number of times the retryCallback should be called before giving up. Default value - 0

retryCallback

abstract external val retryCallback: RetryCallback?

The Function to call when a request for this resource fails. If it returns true, the request will be retried.

skipColorSpaceConversion

abstract external val skipColorSpaceConversion: Boolean?

If true, any custom gamma or color profiles in the image will be ignored. Only applies when requesting an image and the browser supports createImageBitmap. Default value - false

templateValues

abstract external val templateValues: JsAny?

Key/Value pairs that are used to replace template values (eg. {x}).

url

abstract external val url: String

The url of the resource.