mapbox-maps-android/com.mapbox.maps.extension.style.sources/CustomRasterSource

CustomRasterSource

@MapboxExperimental
class CustomRasterSource(id: String, options: CustomRasterSourceOptions) : Source

Describes the Custom Raster Source to be used in the style.

Note: the provided data is not cached, and the implementation will call com.mapbox.maps.CustomRasterSourceTileStatusChangedCallback each time the tile reappears.

Constructors

Link copied to clipboard

Functions

Link copied to clipboard
open override fun bindTo(delegate: MapboxStyleManager)

Add the source to the Style.

Link copied to clipboard
fun setMaxOverscaleFactorForParentTiles(value: Long)

When a set of tiles for a current zoom level is being rendered and some of the ideal tiles that cover the screen are not yet loaded, parent tile could be used instead. This might introduce unwanted rendering side-effects, especially for raster tiles that are overscaled multiple times. This property sets the maximum limit for how much a parent tile can be overscaled.

Link copied to clipboard
fun setTileData(tileData: List<CustomRasterSourceTileData>)

Set tile data for raster tiles.

Link copied to clipboard
open override fun toString(): String

Returns a human readable string that includes the cached properties of the source.

Properties

Link copied to clipboard
val maxOverscaleFactorForParentTiles: Long?

When a set of tiles for a current zoom level is being rendered and some of the ideal tiles that cover the screen are not yet loaded, parent tile could be used instead. This might introduce unwanted rendering side-effects, especially for raster tiles that are overscaled multiple times. This property sets the maximum limit for how much a parent tile can be overscaled.

Link copied to clipboard
val sourceId: String

The ID of the Source.