mapbox-maps-android/com.mapbox.maps.extension.compose/MapState/tileCover

tileCover

@MapboxExperimental
@JvmOverloads
suspend fun tileCover(tileCoverOptions: TileCoverOptions, cameraOptions: CameraOptions? = null): List<OverscaledTileID>

Returns tileIDs that cover current map camera.

Note! This is an experimental API and behavior might change in future. As of v11.30, this returns OverscaledTileID (previously CanonicalTileID, which is still preserved as the canonical field) so that callers can distinguish overscaled tiles from their canonical zoom level, and distinguish tiles that repeat across the antimeridian via their wrap offset. Overscaling only happens when TileCoverOptions.maxZoom is set and the camera's zoom exceeds it: the tile is clamped to maxZoom, and canonical holds the coordinate at that clamped zoom level.

It will suspend until current MapState is set to the MapboxMap composable function.

Return

Returns a list of OverscaledTileID that cover the current map camera.

Parameters

tileCoverOptions

Options for the tile cover method.

cameraOptions

This is an extra parameter for future use. Has no effect for now.