mapbox-maps-android/com.mapbox.maps/Style/addImage

addImage

Adds an image to be used in the style. This API can also be used for updating an image. If the image id was already added, it gets replaced by the new image.

The image can be used in icon-image, fill-pattern, and line-pattern.

See https://www.mapbox.com/mapbox-gl-js/style-spec/#layout-symbol-icon-image See https://www.mapbox.com/mapbox-gl-js/style-spec/#paint-line-line-pattern See https://www.mapbox.com/mapbox-gl-js/style-spec/#paint-fill-fill-pattern

Return

A string describing an error if the operation was not successful, empty otherwise.

Parameters

image

Pixel data of the image.

imageId

ID of the image.

sdf

Option to treat whether image is SDF(signed distance field) or not.

fun addImage(imageId: String, image: Image, sdf: Boolean): Expected<String, None>

Adds an image to be used in the style. This API can also be used for updating an image. If the image id was already added, it gets replaced by the new image.

The image can be used in icon-image, fill-pattern, and line-pattern.

Return

A string describing an error if the operation was not successful, empty otherwise.

Parameters

image

Pixel data of the image.

imageId

ID of the image.

fun addImage(imageId: String, image: Image): Expected<String, None>

Adds an image to be used in the style. This API can also be used for updating an image. If the image id was already added, it gets replaced by the new image.

The image can be used in icon-image, fill-pattern, and line-pattern.

Return

A string describing an error if the operation was not successful, empty otherwise.

Parameters

bitmap

The bitmap image.

imageId

ID of the image.

sdf

Option to treat whether image is SDF(signed distance field) or not.

fun addImage(imageId: String, bitmap: Bitmap, sdf: Boolean): Expected<String, None>

Adds an image to be used in the style. This API can also be used for updating an image. If the image id was already added, it gets replaced by the new image.

The image can be used in icon-image, fill-pattern, and line-pattern.

Return

A string describing an error if the operation was not successful, empty otherwise.

Parameters

bitmap

The bitmap image.

imageId

ID of the image.

open override fun addImage(imageId: String, bitmap: Bitmap): Expected<String, None>