- MBTilesRasterSource
- MBTilesRasterOptions
- MBTilesVectorSource
- MBTilesVectorOptions
- SQLOptions
- importMBTiles
Extends ImageTileSource
A tile source in a remote .mbtiles file accessible by HTTP
WARNING If your application continuously creates and removes MBTilesSource objects, special care must be taken to properly dispose of them. An MBTilesSource creates a thread pool that the JS engine is unable to automatically garbage-collect unless the dispose() method is invoked. If you need to dispose a map that can potentially contain MBTilesSource objects, check loadExample() in https://github.com/mmomtchev/ol-mbtiles/blob/main/examples/index.ts#L15
optionsMBTilesRasterOptions options
Extends ImageTileOptions
Options for creating a MBTilesRasterSource
Number of parallel workers to use for retrieving tiles, @default 4
Type: number
List of layer names to selectively include, @default everything
Alternative method of specifying minZoom, mutually exclusive with tileGrid, requires explicit projection. This refers to the available zoom levels of the tiled data and it is different from the OpenLayers minZoom parameter that applies to the layer.
Type: number
Alternative method of specifying maxZoom, mutually exclusive with tileGrid, requires explicit projection This refers to the available zoom levels of the tiled data and it is different from the OpenLayers maxZoom parameter that applies to the layer.
Type: number
Optional tile grid, refer to the Openlayers manual
Type: TileGrid
Optional already open SQLiteHTTP pool (mutually exclusive with url)
Type: Promise<SQLiteHTTPPool>
Optional MIME type for loaded tiles (see #68)
Type: string
Extends VectorTileSource
A tile source in a remote .mbtiles file accessible by HTTP
WARNING If your application continuously creates and removes MBTilesSource objects, special care must be taken to properly dispose of them. An MBTilesSource creates a thread pool that the JS engine is unable to automatically garbage-collect unless the dispose() method is invoked. If you need to dispose a map that can potentially contain MBTilesSource objects, check loadExample() in https://github.com/mmomtchev/ol-mbtiles/blob/main/examples/index.ts#L15
optionsMBTilesVectorOptions options
Extends VectorTileOptions
Options for creating a MBTilesVectorSource
Number of parallel workers to use for retrieving tiles, @default 4
Type: number
List of layer names to selectively include, @default everything
Minimum available zoom level. This refers to the available zoom levels of the tiled data and it is different from the OpenLayers minZoom parameter that applies to the layer.
Type: number
Maximum available zoom level. This refers to the available zoom levels of the tiled data and it is different from the OpenLayers maxZoom parameter that applies to the layer.
Type: number
Optional already open SQLiteHTTP pool (mutually exclusive with url)
Type: Promise<SQLiteHTTPPool>
Shared options for all MBTiles
URL of the remote MBTiles source
Type: string
Number of parallel workers to use for retrieving tiles, @default 4
Type: number
Maximum expected page size in bytes for SQLite3 files, @default 4096
Type: number
Memory to use for SQLite cache in KB, @default 4096
Type: number
Use a specific backend type, @default 'shared'
Type: any
Automatically import MBTiles metadata and return an options object compatible with the source constructors.
optany
Returns (MBTilesRasterOptions | MBTilesVectorOptions)