On this page
Properties

Type Alias TilePreloadOptions

Options shared by all tile preloading APIs.

API Key Usage: Tile preloading issues one network request per tile per active source. These requests count against your MapTiler Cloud API key quota. Use onProgress to monitor consumption and prefer narrow zoom ranges and small bounds where possible.

type TilePreloadOptions = {
    maxTiles?: number;
    onError?: TilePreloadErrorCallback;
    onProgress?: TilePreloadProgressCallback;
}
Index

Properties

maxTiles? onError? onProgress?

Properties

maxTiles?: number

Maximum number of tiles to fetch across all sources. Tiles beyond this limit are silently dropped. Defaults to 512.

API Key Usage: Each tile counts against your MapTiler Cloud API key quota. Keep this value conservative, especially across wide zoom ranges.

512
onError?: TilePreloadErrorCallback

Called when a tile fails to load.

onProgress?: TilePreloadProgressCallback

Called after each tile fetch attempt, whether it succeeded or failed.

Was this helpful?
SDK JS
Reference
TilePreloadOptions