Class: RasterTileset2D
Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:161
A generic tileset implementation organized according to the OGC TileMatrixSet specification.
Handles tile lifecycle, caching, and viewport-based loading.
Extends
Tileset2D
Constructors
Constructor
new RasterTileset2D(
opts,descriptor,__namedParameters?):RasterTileset2D
Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:178
Parameters
opts
Tileset2DProps
descriptor
__namedParameters?
RasterTileset2DOptions = {}
Returns
RasterTileset2D
Overrides
Tileset2D.constructor
Methods
finalize()
finalize():
void
Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:282
Unloads every cached tile. deck.gl's Tileset2D.finalize clears its cache
without calling onTileUnload, so GPU resources that getTileData made
for those tiles, like textures, would be freed only by garbage collection.
A tile still loading is unloaded once its load finishes, since deck.gl
keeps the data that getTileData returns after an abort. Not needed once
https://github.com/visgl/deck.gl/pull/10883 lands.
Returns
void
Overrides
Tileset2D.finalize
getParentIndex()
getParentIndex(
index):TileIndex
Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:379
Returns index of the parent tile
Parameters
index
TileIndex
Returns
TileIndex
Overrides
Tileset2D.getParentIndex
getTileId()
getTileId(
index):string
Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:375
Returns unique string key for a tile index
Parameters
index
TileIndex
Returns
string
Overrides
Tileset2D.getTileId
getTileIndices()
getTileIndices(
opts):TileIndex[]
Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:315
Get tile indices visible in viewport Uses frustum culling similar to OSM implementation
Overviews follow TileMatrixSet ordering: index 0 = coarsest, higher = finer
minZoom and maxZoom gate against viewport.zoom (not the tileset
z-index, which is an overview level in our descriptor). When the
viewport zoom is outside these bounds this method returns an empty
list — no new tile fetches, and because deck.gl's updateTileStates
marks unselected cached tiles invisible, no rendering either.
visibleMinZoom / visibleMaxZoom (deck.gl 9.3+) are deliberately
not honored: their documented "fetch but don't render" semantic
requires a notion of clamping to a coarser z, which doesn't
generalize to descriptors with sparse or single overviews. See
dev-docs/zoom-terminology.md for the rationale.
Unlike in deck.gl's default tileset, extent does not keep tiles loading
below minZoom.
Parameters
opts
maxZoom?
number
minZoom?
number
modelMatrix?
Matrix4
modelMatrixInverse?
Matrix4
viewport
Viewport
zRange
ZRange | null
Returns
TileIndex[]
Overrides
Tileset2D.getTileIndices
getTileMetadata()
getTileMetadata(
index):RasterTileMetadata
Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:426
Returns additional metadata to add to tile, bbox by default
Parameters
index
TileIndex
Returns
Overrides
Tileset2D.getTileMetadata
getTileZoom()
getTileZoom(
index):number
Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:422
Returns a zoom level for a tile index
Parameters
index
TileIndex
Returns
number
Overrides
Tileset2D.getTileZoom
setOptions()
setOptions(
opts):void
Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:236
deck.gl's options, with two callbacks wrapped:
onTileUnloadaborts a still-loading tile first when RasterTileset2DOptions.abortUnwantedLoads is on: deck.gl evicts such tiles insideupdate, before update's own pass sees them.onTileLoadunloads a tile whose load finishes after the tile was unloaded, such as one evicted mid-load, instead of reporting it loaded. See visgl/deck.gl#10883.
Parameters
opts
Tileset2DProps
Returns
void
Overrides
Tileset2D.setOptions
update()
update(...
args):number
Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:262
deck.gl's update, then the abort of every loading tile that is neither selected nor visible, when RasterTileset2DOptions.abortUnwantedLoads is on.
Parameters
args
...[viewport: Viewport, { modelMatrix: NumericArray | null; zRange: ZRange | null; }?]
Returns
number
Overrides
Tileset2D.update