Skip to main content
TiledImageBackgroundComponentProps
Props for the tiled image background component
NameTypeDescription
heightnumberRequired. Indicates the height of the full image.
maxZoomnumberRequired. Indicates the maximum zoom level. Zoom starts at 0 - fully zoomed out - and
increases in integer values from there. Each successive zoom level is twice the zoom of the previous level,
meaning two times as many tiles in each direction.
panDebounceTimeout?numberHow long to wait after a pan before reloading tiles.
tileSizeSizeFor tiled backgrounds, provides the width and height of tiles. Every tile is assumed to have these dimensions,
even if the tile has whitespace in it. Required.
tiling?TilingStrategyDefault is TilingStrategies.logarithmic. See notes for TilingStrategies enum.
url?stringURL for the background. You can supply this, or you can supply a urlGenerator function instead. If you supply url and no urlGenerator, the url you supply is treated as a template for the url for any given tile, and is expected to contain {z}, {x} and {y} placeholders. The form of the URL can be anything you like as long as it has the placeholders for z, x and y. For instance:

http://foo.com/{z}/{x}/{y}
https://bar.com?zoom={z}&x={x}&y={y}

etc
urlGenerator?(z:number, x:number, y:number) => stringFor tiled backgrounds, an optional function you can supply to generate the URL for a given tile. See url for
an explanation of the default syntax for urls when using a tiled background.
widthnumberRequired. Indicates the width of the full image.
zoomDebounceTimeout?numberHow long to wait after a zoom before reloading tiles.