Sources

RasterSource

The RasterSource component is used to add raster image tiles to your map.

These raster tiles can be any image data—satellite imagery, aerial photographs, scanned maps, or custom image tiles—that are rendered on the map as a series of grid-based tiles.

This source is ideal for displaying visually rich imagery or backgrounds that don’t require vector data.

Reference: Raster

Usage

The RasterSource component loads image tiles from a specified URL template and displays them across the map based on the current zoom level and bounds.

Each tile is a square image that fits within the tile grid at the given zoom level.

The RasterSource works well in conjunction with other layers and controls, such as the RasterLayer, to display detailed raster images.

Please navigate to RasterLayer for an example.

API

Props

The RasterSource component’s props.

While an id is typically required for MapLibre sources, the RasterDemSource component automatically generates a unique id if none is provided.

PropDescriptionType
idThe id for the source. Must not be used by any existing source.Optional string
urlA URL to a TileJSON resource. Supported protocols are http: and https:.Optional string
tilesAn array of one or more tile source URLs, as in the TileJSON spec.Optional array
boundsAn array containing the longitude and latitude of the southwest and northeast corners of the source’s bounding box in the following order: [sw.lng, sw.lat, ne.lng, ne.lat]. When this property is included in a source, no tiles outside of the given bounds are requested by MapLibre.Optional array default is -180,-85.051129,180,85.051129
minzoomMinimum zoom level for which tiles are available, as in the TileJSON spec.Optional number. default is 0
maxzoomMaximum zoom level for which tiles are available, as in the TileJSON spec. Data from tiles at the maxzoom are used when displaying the map at higher zoom levels.Optional number. default is to 22.
tileSizeThe minimum visual size to display tiles for this layer. Only configurable for raster layers.Optional number. Units in pixels. default is 512
schemeInfluences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed.Optional number. Possible values xyz, tms. Defaults to xyz.
attributionContains an attribution to be displayed when the map is shown to a user.Optional number. Units in pixels. default is 512
volatileA setting to determine whether a source’s tiles are cached locally.Optional boolean. default is false.