Skip to main content

Type Alias: RasterTileLayerProps<DataT>

RasterTileLayerProps<DataT> = CompositeLayerProps & Pick<TileLayerProps, "debounceTime" | "extent" | "maxCacheByteSize" | "maxCacheSize" | "maxRequests" | "maxZoom" | "minZoom" | "onTileError" | "onTileLoad" | "onTileUnload" | "onViewportLoad" | "refinementStrategy" | "tileSize" | "zoomOffset"> & object

Defined in: packages/deck.gl-raster/src/raster-tile-layer/raster-tile-layer.ts:62

Props for RasterTileLayer.

Type Declaration​

debug?​

optional debug?: boolean

Show triangulation mesh + tile outlines.

Default​

false

debugOpacity?​

optional debugOpacity?: number

Opacity of the debug mesh overlay (0–1).

Default​

0.5

getTileData?​

optional getTileData?: (tile, options) => Promise<DataT>

Load data for one tile. Runs once per (x, y, z); the resulting DataT is cached by the underlying TileLayer.

Subclasses may supply this via state by overriding _getTileDataCallback().

Parameters​

tile​

TileLoadProps

options​

GetTileDataOptions

Returns​

Promise<DataT>

maxError?​

optional maxError?: number

Maximum reprojection error in pixels for mesh refinement. Lower values create denser meshes.

Default​

0.125

renderTile?​

optional renderTile?: (data) => RenderTileResult | null

Turn cached tile data into a render result (image and/or shader pipeline). Called on every render; does not re-fetch.

To invalidate the inner TileLayer's rendered sub-layers when a dependency changes (e.g. a colormap choice), pass updateTriggers: { renderTile: [dep1, dep2] } on the layer props.

Subclasses may supply this via state by overriding _renderTileCallback().

Parameters​

data​

DataT

Returns​

RenderTileResult | null

signal?​

optional signal?: AbortSignal

AbortSignal applied to every tile fetch, composed with TileLayer's per-tile signal.

tilesetDescriptor?​

optional tilesetDescriptor?: RasterTilesetDescriptor

Tile pyramid + CRS projection descriptor.

Subclasses may supply this via state by overriding the protected _tilesetDescriptor() method.

Type Parameters​

DataT​

DataT extends MinimalTileData = MinimalTileData