The Map
component is responsible for initializing the mapbox-gl-js
instance and making this available to any map layers rendered within it.
Prop | Description |
---|---|
optional props | |
children | @carbonplan/maps JSX elements or regular components |
style | style object used on div container node of mapboxgl.Map |
zoom | zoom parameter passed to mapboxgl.Map |
minZoom | minZoom parameter passed to mapboxgl.Map |
maxZoom | maxZoom parameter passed to mapboxgl.Map |
maxBounds | maxBounds parameter passed to mapboxgl.Map |
center | center parameter passed to mapboxgl.Map |
debug | debug parameter passed to mapboxgl.Map , controls whether tile grid lines are shown |
glyphs | glyphs parameter passed to mapboxgl.Map |
setLoading | Tracks any pending requests made by containing Raster layers |
setMetadataLoading | Tracks any metadata and coordinate requests made on initialization by containing Raster layers |
setChunkLoading | Tracks any requests of new chunks by containing Raster layers |
You may use any combination of the loading callback props to track the loading state of raster layers rendered as children of a Map
. The last value passed to each of the three callbacks, setLoading
, setMetadataLoading
, and setChunkLoading
are overlaid on the map below.