Skip to main content

Class: TileMatrixSetTileset

Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:33

A generic tileset implementation organized according to the OGC TileMatrixSet specification.

Handles tile lifecycle, caching, and viewport-based loading.

Extends

  • Tileset2D

Constructors

Constructor

new TileMatrixSetTileset(opts, tms, __namedParameters): TileMatrixSetTileset

Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:38

Parameters

opts

Tileset2DProps

tms

TileMatrixSetDefinition

__namedParameters
projectTo3857

ProjectionFunction

projectTo4326

ProjectionFunction

Returns

TileMatrixSetTileset

Overrides

Tileset2D.constructor

Properties

opts

protected opts: Required<Tileset2DProps>

Defined in: node_modules/.pnpm/@deck.gl+geo-layers@9.2.10_@deck.gl+core@9.2.10_@deck.gl+extensions@9.2.5_@deck.gl+core_0d6419e8d5cf8735e79697344b762206/node_modules/@deck.gl/geo-layers/dist/tileset-2d/tileset-2d.d.ts:49

Inherited from

Tileset2D.opts

Accessors

isLoaded

Get Signature

get isLoaded(): boolean

Defined in: node_modules/.pnpm/@deck.gl+geo-layers@9.2.10_@deck.gl+core@9.2.10_@deck.gl+extensions@9.2.5_@deck.gl+core_0d6419e8d5cf8735e79697344b762206/node_modules/@deck.gl/geo-layers/dist/tileset-2d/tileset-2d.d.ts:71

Returns

boolean

Inherited from

Tileset2D.isLoaded


needsReload

Get Signature

get needsReload(): boolean

Defined in: node_modules/.pnpm/@deck.gl+geo-layers@9.2.10_@deck.gl+core@9.2.10_@deck.gl+extensions@9.2.5_@deck.gl+core_0d6419e8d5cf8735e79697344b762206/node_modules/@deck.gl/geo-layers/dist/tileset-2d/tileset-2d.d.ts:72

Returns

boolean

Inherited from

Tileset2D.needsReload


selectedTiles

Get Signature

get selectedTiles(): Tile2DHeader<any>[] | null

Defined in: node_modules/.pnpm/@deck.gl+geo-layers@9.2.10_@deck.gl+core@9.2.10_@deck.gl+extensions@9.2.5_@deck.gl+core_0d6419e8d5cf8735e79697344b762206/node_modules/@deck.gl/geo-layers/dist/tileset-2d/tileset-2d.d.ts:70

Returns

Tile2DHeader<any>[] | null

Inherited from

Tileset2D.selectedTiles


tiles

Get Signature

get tiles(): Tile2DHeader<any>[]

Defined in: node_modules/.pnpm/@deck.gl+geo-layers@9.2.10_@deck.gl+core@9.2.10_@deck.gl+extensions@9.2.5_@deck.gl+core_0d6419e8d5cf8735e79697344b762206/node_modules/@deck.gl/geo-layers/dist/tileset-2d/tileset-2d.d.ts:69

Returns

Tile2DHeader<any>[]

Inherited from

Tileset2D.tiles

Methods

_getNearestAncestor()

_getNearestAncestor(tile): Tile2DHeader<any> | null

Defined in: node_modules/.pnpm/@deck.gl+geo-layers@9.2.10_@deck.gl+core@9.2.10_@deck.gl+extensions@9.2.5_@deck.gl+core_0d6419e8d5cf8735e79697344b762206/node_modules/@deck.gl/geo-layers/dist/tileset-2d/tileset-2d.d.ts:121

Parameters

tile

Tile2DHeader

Returns

Tile2DHeader<any> | null

Inherited from

Tileset2D._getNearestAncestor


finalize()

finalize(): void

Defined in: node_modules/.pnpm/@deck.gl+geo-layers@9.2.10_@deck.gl+core@9.2.10_@deck.gl+extensions@9.2.5_@deck.gl+core_0d6419e8d5cf8735e79697344b762206/node_modules/@deck.gl/geo-layers/dist/tileset-2d/tileset-2d.d.ts:74

Returns

void

Inherited from

Tileset2D.finalize


getParentIndex()

getParentIndex(index): TileIndex

Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:100

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:96

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:70

Get tile indices visible in viewport Uses frustum culling similar to OSM implementation

Overviews follow TileMatrixSet ordering: index 0 = coarsest, higher = finer

Parameters

opts
maxZoom?

number

minZoom?

number

modelMatrix?

Matrix4

modelMatrixInverse?

Matrix4

viewport

Viewport

zRange

ZRange | null

Returns

TileIndex[]

Overrides

Tileset2D.getTileIndices


getTileMetadata()

getTileMetadata(index): Record<string, unknown>

Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:122

Returns additional metadata to add to tile, bbox by default

Parameters

index

TileIndex

Returns

Record<string, unknown>

Overrides

Tileset2D.getTileMetadata


getTileZoom()

getTileZoom(index): number

Defined in: packages/deck.gl-raster/src/raster-tileset/raster-tileset-2d.ts:118

Returns a zoom level for a tile index

Parameters

index

TileIndex

Returns

number

Overrides

Tileset2D.getTileZoom


isTileVisible()

isTileVisible(tile, cullRect?, modelMatrix?): boolean

Defined in: node_modules/.pnpm/@deck.gl+geo-layers@9.2.10_@deck.gl+core@9.2.10_@deck.gl+extensions@9.2.5_@deck.gl+core_0d6419e8d5cf8735e79697344b762206/node_modules/@deck.gl/geo-layers/dist/tileset-2d/tileset-2d.d.ts:83

Parameters

tile

Tile2DHeader

cullRect?
height

number

width

number

x

number

y

number

modelMatrix?

Matrix4 | null

Returns

boolean

Inherited from

Tileset2D.isTileVisible


reloadAll()

reloadAll(): void

Defined in: node_modules/.pnpm/@deck.gl+geo-layers@9.2.10_@deck.gl+core@9.2.10_@deck.gl+extensions@9.2.5_@deck.gl+core_0d6419e8d5cf8735e79697344b762206/node_modules/@deck.gl/geo-layers/dist/tileset-2d/tileset-2d.d.ts:75

Returns

void

Inherited from

Tileset2D.reloadAll


setOptions()

setOptions(opts): void

Defined in: node_modules/.pnpm/@deck.gl+geo-layers@9.2.10_@deck.gl+core@9.2.10_@deck.gl+extensions@9.2.5_@deck.gl+core_0d6419e8d5cf8735e79697344b762206/node_modules/@deck.gl/geo-layers/dist/tileset-2d/tileset-2d.d.ts:73

Parameters

opts

Tileset2DProps

Returns

void

Inherited from

Tileset2D.setOptions


update()

update(viewport, __namedParameters?): number

Defined in: node_modules/.pnpm/@deck.gl+geo-layers@9.2.10_@deck.gl+core@9.2.10_@deck.gl+extensions@9.2.5_@deck.gl+core_0d6419e8d5cf8735e79697344b762206/node_modules/@deck.gl/geo-layers/dist/tileset-2d/tileset-2d.d.ts:79

Update the cache with the given viewport and model matrix and triggers callback onUpdate.

Parameters

viewport

Viewport

__namedParameters?
modelMatrix

NumericArray | null

zRange

ZRange | null

Returns

number

Inherited from

Tileset2D.update