Class: RasterTileLayer<DataT, ExtraProps, SourceT, InputT>
Defined in: packages/deck.gl-raster/src/raster-tile-layer/raster-tile-layer.ts:286
Base layer that renders a tiled raster source driven by a generic RasterTilesetDescriptor.
Usable directly (provide tilesetDescriptor, getTileData, and renderTile
as props) or as a base class (override the protected _tilesetDescriptor,
_getTileDataCallback, _renderTileCallback accessors to source them from
state).
A subclass that draws a RasterSource declares source and
onSourceLoad props, and overrides RasterTileLayer._openSource to
open its other inputs, such as a URL. The base layer draws an opened source
at once, opens other input in RasterTileLayer.loadMetadata, and takes
the tile grid from the source.
The generic parameters:
ExtraPropslets a subclass redeclare any of the overridable fields with a domain-specific signature (e.g.COGLayer'sgetTileData(image, options)).SourceTandInputTtype a subclass'ssource: the opened source it draws and the input it opens. They default to what thesourceprop inExtraPropstakes, so a subclass doesn't pass them: COGLayer'ssource: COGSource | COGInputmakes themCOGSourceandCOGInput. A layer without asourcegetsnever.
Extends
default<RasterTileLayerBaseProps<DataT> &SourceProps<SourceT,InputT> &ExtraProps>
Type Parameters
DataT
DataT extends MinimalTileData = MinimalTileData
ExtraProps
ExtraProps extends object = RasterTileLayerDefaultExtraProps<DataT>
SourceT
SourceT extends RasterSource = Extract<SourcePropOf<ExtraProps>, RasterSource>
InputT
InputT = Exclude<SourcePropOf<ExtraProps>, RasterSource>
Properties
state
state:
object
Defined in: packages/deck.gl-raster/src/raster-tile-layer/raster-tile-layer.ts:302
loadingMetadata?
optionalloadingMetadata?:boolean
True while the latest metadata load is in flight.
metadataAbortController?
optionalmetadataAbortController?:AbortController
Aborts the metadata load in flight when a newer one starts or the layer is removed.
refetchCount?
optionalrefetchCount?:number
The number of refetches, part of the inner TileLayer's id.
source?
optionalsource?:SourceT
The source the layer draws: source itself, or the one opened from it.
Overrides
CompositeLayer.state
defaultProps
staticdefaultProps:DefaultProps<RasterTileLayerProps<MinimalTileData>>
Defined in: packages/deck.gl-raster/src/raster-tile-layer/raster-tile-layer.ts:300
Overrides
CompositeLayer.defaultProps
layerName
staticlayerName:string="RasterTileLayer"
Defined in: packages/deck.gl-raster/src/raster-tile-layer/raster-tile-layer.ts:299
Overrides
CompositeLayer.layerName
Accessors
isLoaded
Get Signature
get isLoaded():
boolean
Defined in: packages/deck.gl-raster/src/raster-tile-layer/raster-tile-layer.ts:547
Whether the layer has finished loading its data.
We override this to return false while metadata is still loading.
Returns
boolean
Overrides
CompositeLayer.isLoaded
Methods
finalizeState()
finalizeState(
context):void
Defined in: packages/deck.gl-raster/src/raster-tile-layer/raster-tile-layer.ts:335
Called once when layer is no longer matched and state will be discarded. Layers can destroy WebGL resources here.
Parameters
context
LayerContext
Returns
void
Overrides
CompositeLayer.finalizeState
loadMetadata()
loadMetadata(
signal):Promise<void>
Defined in: packages/deck.gl-raster/src/raster-tile-layer/raster-tile-layer.ts:370
Load this layer's metadata and store it in state, like deck.gl's
updateState.
Called when RasterTileLayer.shouldLoadMetadata returns true.
deck.gl hands every new instance of a layer the old instance's state, so
a load started by an earlier render can finish after a newer one has
begun. To drop such a load, pass signal to the requests it makes, and
call signal.throwIfAborted() after the last await, before setState or
callbacks.
By default, it opens source with RasterTileLayer._openSource,
calls onSourceLoad with the opened source, and draws it.
Parameters
signal
Returns
Promise<void>
renderLayers()
renderLayers():
Layer<{ }> |null
Defined in: packages/deck.gl-raster/src/raster-tile-layer/raster-tile-layer.ts:624
Returns
Layer<{ }> | null
Overrides
CompositeLayer.renderLayers
shouldLoadMetadata()
shouldLoadMetadata(
__namedParameters):boolean
Defined in: packages/deck.gl-raster/src/raster-tile-layer/raster-tile-layer.ts:349
Whether updateState should load this layer's metadata again, like
deck.gl's shouldUpdateState.
By default, the layer loads when source changes to input it has to open,
such as a URL. An opened RasterSource needs no loading, and
neither does undefined or null, which draw nothing. Subclasses that
load other metadata return true when a prop it depends on has changed.
Parameters
__namedParameters
UpdateParameters<RasterTileLayer<DataT, ExtraProps, SourceT, InputT>>
Returns
boolean
updateState()
updateState(
params):void
Defined in: packages/deck.gl-raster/src/raster-tile-layer/raster-tile-layer.ts:314
Default implementation, all attributes will be invalidated and updated when data changes
Parameters
params
UpdateParameters<RasterTileLayer<DataT, ExtraProps, SourceT, InputT>>
Returns
void
Overrides
CompositeLayer.updateState