TiledImageBackgroundComponentProps
Props for the tiled image background component
| Name | Type | Description |
|---|---|---|
| height | number | Required. Indicates the height of the full image. |
| maxZoom | number | Required. 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? | number | How long to wait after a pan before reloading tiles. |
| tileSize | Size | 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? | TilingStrategy | Default is TilingStrategies.logarithmic. See notes for enum. |
| url? | string | URL for the background. You can supply this, or you can supply a function instead. If you supply and no , the url you supply is treated as a template for the url for any given tile, and is expected to contain , and 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) => string | For tiled backgrounds, an optional function you can supply to generate the URL for a given tile. See foran explanation of the default syntax for urls when using a tiled background. |
| width | number | Required. Indicates the width of the full image. |
| zoomDebounceTimeout? | number | How long to wait after a zoom before reloading tiles. |