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.

To add the data, implement the CustomRasterSourceOptions.fetchTileFunction callback and call setTileData when needed.

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 invalidateRegion(coordinateBounds: CoordinateBounds)

Invalidate region for provided custom raster source.

Link copied to clipboard
fun invalidateTile(tileID: CanonicalTileID)

Invalidate tile for provided custom raster source.

Link copied to clipboard
fun setTileCacheBudget(value: TileCacheBudget)

The property allows to define source specific resource budget, either in tile units or in megabytes. Whenever tile cache goes over the defined limit, least recently used tile will be evicted from the in-memory cache. Note that the current implementation does not take into account resources allocated by the visible tiles.

Link copied to clipboard
fun setTileData(tileID: CanonicalTileID, bitmap: Bitmap?)
fun setTileData(tileID: CanonicalTileID, image: Image?)

Set tile data for a raster tile.

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 sourceId: String

The ID of the Source.

Link copied to clipboard
val tileCacheBudget: TileCacheBudget?

The property allows to define source specific resource budget, either in tile units or in megabytes. Whenever tile cache goes over the defined limit, least recently used tile will be evicted from the in-memory cache. Note that the current implementation does not take into account resources allocated by the visible tiles.