Skip to main content

Class: MosaicLayer<MosaicT, DataT>

Defined in: packages/deck.gl-geotiff/src/mosaic-layer/mosaic-layer.ts:48

A deck.gl layer for rendering a mosaic of raster sources.

The renderSource prop is called whenever a source is present in the current viewport.

Extends

Type Parameters

MosaicT

MosaicT extends MosaicSource = MosaicSource

DataT

DataT = any

Constructors

Constructor

new MosaicLayer<MosaicT, DataT>(...propObjects): MosaicLayer<MosaicT, DataT>

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lifecycle/component.d.ts:17

Parameters

propObjects

...Partial<LayerProps & object & Pick<TileLayerProps, "extent" | "maxZoom" | "minZoom" | "maxCacheSize" | "maxCacheByteSize" | "maxRequests"> & object & Required<CompositeLayerProps> & Required<LayerProps>>[]

Returns

MosaicLayer<MosaicT, DataT>

Inherited from

CompositeLayer<MosaicLayerProps<MosaicT, DataT>>.constructor

Properties

context

context: LayerContext

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:38

Inherited from

CompositeLayer.context


count

count: number

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lifecycle/component.d.ts:16

Inherited from

CompositeLayer.count


id

id: string

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lifecycle/component.d.ts:14

Inherited from

CompositeLayer.id


internalState

internalState: LayerState<MosaicLayer<MosaicT, DataT>> | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:36

Inherited from

CompositeLayer.internalState


lifecycle

lifecycle: Lifecycle

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:37

Inherited from

CompositeLayer.lifecycle


parent

parent: Layer<{ }> | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:40

Inherited from

CompositeLayer.parent


props

props: StatefulComponentProps<LayerProps & object & Pick<TileLayerProps, "extent" | "maxZoom" | "minZoom" | "maxCacheSize" | "maxCacheByteSize" | "maxRequests"> & object & Required<CompositeLayerProps> & Required<LayerProps>>

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lifecycle/component.d.ts:15

Inherited from

CompositeLayer.props


state

state: SharedLayerState

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:39

Inherited from

CompositeLayer.state


defaultProps

static defaultProps: Partial<MosaicLayerProps<MosaicSource, any>>

Defined in: packages/deck.gl-geotiff/src/mosaic-layer/mosaic-layer.ts:53

Overrides

CompositeLayer.defaultProps


layerName

static layerName: string = "MosaicLayer"

Defined in: packages/deck.gl-geotiff/src/mosaic-layer/mosaic-layer.ts:52

Overrides

CompositeLayer.layerName

Accessors

isComposite

Get Signature

get isComposite(): boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:11

true if this layer renders other layers

Returns

boolean

Inherited from

CompositeLayer.isComposite


isDrawable

Get Signature

get isDrawable(): boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:13

true if the layer renders to screen

Returns

boolean

Inherited from

CompositeLayer.isDrawable


isLoaded

Get Signature

get isLoaded(): boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:15

Returns true if all async resources are loaded

Returns

boolean

Inherited from

CompositeLayer.isLoaded


root

Get Signature

get root(): Layer

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:41

Returns

Layer

Inherited from

CompositeLayer.root


wrapLongitude

Get Signature

get wrapLongitude(): boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:76

Returns true if using shader-based WGS84 longitude wrapping

Returns

boolean

Inherited from

CompositeLayer.wrapLongitude


componentName

Get Signature

get static componentName(): string

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:35

Returns

string

Inherited from

CompositeLayer.componentName

Methods

_disablePickingIndex()

protected _disablePickingIndex(objectIndex): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:169

Parameters

objectIndex

number

Returns

void

Inherited from

CompositeLayer._disablePickingIndex


_drawLayer()

_drawLayer(__namedParameters): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:180

Parameters

__namedParameters
parameters

Parameters

renderPass

RenderPass

shaderModuleProps

any

uniforms

any

Returns

void

Inherited from

CompositeLayer._drawLayer


_finalize()

_finalize(): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:179

(Internal) Called by manager when layer is about to be disposed Note: not guaranteed to be called on application shutdown

Returns

void

Inherited from

CompositeLayer._finalize


_getAttributeManager()

protected _getAttributeManager(): AttributeManager | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:50

Override base Layer method

Returns

AttributeManager | null

Inherited from

CompositeLayer._getAttributeManager


_initialize()

_initialize(): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:172

Returns

void

Inherited from

CompositeLayer._initialize


_postUpdate()

protected _postUpdate(updateParams, forceUpdate): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:52

(Internal) Called after an update to rerender sub layers

Parameters

updateParams

UpdateParameters<MosaicLayer<MosaicT, DataT>>

forceUpdate

boolean

Returns

void

Inherited from

CompositeLayer._postUpdate


_setModelAttributes()

protected _setModelAttributes(model, changedAttributes, bufferLayoutChanged?): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:163

Apply changed attributes to model

Parameters

model

Model

changedAttributes
bufferLayoutChanged?

boolean

Returns

void

Inherited from

CompositeLayer._setModelAttributes


_transferState()

_transferState(oldLayer): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:174

(Internal) Called by layer manager to transfer state from an old layer

Parameters

oldLayer

Layer<LayerProps & object & Pick<TileLayerProps, "extent" | "maxZoom" | "minZoom" | "maxCacheSize" | "maxCacheByteSize" | "maxRequests"> & object & Required<CompositeLayerProps>>

Returns

void

Inherited from

CompositeLayer._transferState


_update()

_update(): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:176

(Internal) Called by layer manager when a new layer is added or an existing layer is matched with a new instance

Returns

void

Inherited from

CompositeLayer._update


_updateAttributes()

protected _updateAttributes(): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:153

Recalculate any attributes if needed

Returns

void

Inherited from

CompositeLayer._updateAttributes


_updateAutoHighlight()

protected _updateAutoHighlight(info): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:48

Update sub layers to highlight the hovered object

Parameters

info
color

Uint8Array | null

coordinate?

number[]

devicePixel?

[number, number]

index

number

layer

Layer<{ }> | null

object?

any

picked

boolean

pixel?

[number, number]

pixelRatio

number

sourceLayer?

Layer<{ }> | null

viewport?

Viewport

x

number

y

number

Returns

void

Inherited from

CompositeLayer._updateAutoHighlight


activateViewport()

activateViewport(viewport): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:145

Called when this layer is rendered into the given viewport

Parameters

viewport

Viewport

Returns

void

Inherited from

CompositeLayer.activateViewport


calculateInstancePickingColors()

protected calculateInstancePickingColors(attribute, __namedParameters): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:159

Updater for the automatically populated instancePickingColors attribute

Parameters

attribute

Attribute

__namedParameters
numInstances

number

Returns

void

Inherited from

CompositeLayer.calculateInstancePickingColors


clone()

clone(newProps): any

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lifecycle/component.d.ts:18

Parameters

newProps

Partial<PropsT>

Returns

any

Inherited from

CompositeLayer.clone


decodePickingColor()

decodePickingColor(color): number

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:95

Parameters

color

any

Returns

number

Inherited from

CompositeLayer.decodePickingColor


disablePickingIndex()

disablePickingIndex(objectIndex): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:168

(Internal) Sets the picking color at the specified index to null picking color. Used for multi-depth picking. This method may be overriden by layer implementations

Parameters

objectIndex

number

Returns

void

Inherited from

CompositeLayer.disablePickingIndex


draw()

draw(opts): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:117

Parameters

opts

DrawOptions

Returns

void

Inherited from

CompositeLayer.draw


encodePickingColor()

encodePickingColor(i, target?): [number, number, number]

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:94

Parameters

i

any

target?

number[]

Returns

[number, number, number]

Inherited from

CompositeLayer.encodePickingColor


filterSubLayer()

filterSubLayer(context): boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:29

Filters sub layers at draw time. Return true if the sub layer should be drawn.

Parameters

context

FilterContext

Returns

boolean

Inherited from

CompositeLayer.filterSubLayer


finalizeState()

finalizeState(context): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:116

Called once when layer is no longer matched and state will be discarded. Layers can destroy WebGL resources here.

Parameters

context

LayerContext

Returns

void

Inherited from

CompositeLayer.finalizeState


getAttributeManager()

getAttributeManager(): AttributeManager | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:84

Returns the attribute manager of this layer

Returns

AttributeManager | null

Inherited from

CompositeLayer.getAttributeManager


getBounds()

getBounds(): [number[], number[]] | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:107

Returns

[number[], number[]] | null

Inherited from

CompositeLayer.getBounds


getChangeFlags()

getChangeFlags(): ChangeFlags | undefined

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:187

Returns the current change flags

Returns

ChangeFlags | undefined

Inherited from

CompositeLayer.getChangeFlags


getCurrentLayer()

getCurrentLayer(): Layer<LayerProps & object & Pick<TileLayerProps, "extent" | "maxZoom" | "minZoom" | "maxCacheSize" | "maxCacheByteSize" | "maxRequests"> & object & Required<CompositeLayerProps>> | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:87

Returns the most recent layer that matched to this state (When reacting to an async event, this layer may no longer be the latest)

Returns

Layer<LayerProps & object & Pick<TileLayerProps, "extent" | "maxZoom" | "minZoom" | "maxCacheSize" | "maxCacheByteSize" | "maxRequests"> & object & Required<CompositeLayerProps>> | null

Inherited from

CompositeLayer.getCurrentLayer


getLoadOptions()

getLoadOptions(): any

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:89

Returns the default parse options for async props

Returns

any

Inherited from

CompositeLayer.getLoadOptions


getModels()

getModels(): Model[]

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:80

Returns an array of models used by this layer, can be overriden by layer subclass

Returns

Model[]

Inherited from

CompositeLayer.getModels


getNeedsRedraw()

getNeedsRedraw(opts?): string | false

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:136

(Internal) Checks if this layer needs redraw

Parameters

opts?
clearRedrawFlags

boolean

Reset redraw flags to false after the check

Returns

string | false

Inherited from

CompositeLayer.getNeedsRedraw


getNumInstances()

getNumInstances(): number

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:101

Deduces number of instances. Intention is to support:

  • Explicit setting of numInstances
  • Auto-deduction for ES6 containers that define a size member
  • Auto-deduction for Classic Arrays via the built-in length attribute
  • Auto-deduction via arrays

Returns

number

Inherited from

CompositeLayer.getNumInstances


getPickingInfo()

getPickingInfo(__namedParameters): object

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:24

called to augment the info object that is bubbled up from a sublayer override Layer.getPickingInfo() because decoding / setting uniform do not apply to a composite layer.

Parameters

__namedParameters

GetPickingInfoParams

Returns

object

color

color: Uint8Array | null

coordinate?

optional coordinate: number[]

devicePixel?

optional devicePixel: [number, number]

index

index: number

layer

layer: Layer<{ }> | null

object?

optional object: any

picked

picked: boolean

pixel?

optional pixel: [number, number]

pixelRatio

pixelRatio: number

sourceLayer?

optional sourceLayer: Layer<{ }> | null

viewport?

optional viewport: Viewport

x

x: number

y

y: number

Inherited from

CompositeLayer.getPickingInfo


getShaders()

getShaders(shaders): any

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:110

Parameters

shaders

any

Returns

any

Inherited from

CompositeLayer.getShaders


getStartIndices()

getStartIndices(): NumericArray | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:106

Buffer layout describes how many attribute values are packed for each data object The default (null) is one value each object. Some data formats (e.g. paths, polygons) have various length. Their buffer layout is in the form of [L0, L1, L2, ...]

Returns

NumericArray | null

Inherited from

CompositeLayer.getStartIndices


getSubLayerAccessor()

protected getSubLayerAccessor<In, Out>(accessor): Accessor<In, Out>

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:40

Some composite layers cast user data into another format before passing to sublayers We need to unwrap them before calling the accessor so that they see the original data objects

Type Parameters

In

In

Out

Out

Parameters

accessor

Accessor<In, Out>

Returns

Accessor<In, Out>

Inherited from

CompositeLayer.getSubLayerAccessor


getSubLayerClass()

protected getSubLayerClass<T>(subLayerId, DefaultLayerClass): ConstructorOf<T>

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:33

Returns sub layer class for a specific sublayer

Type Parameters

T

T extends Layer<{ }>

Parameters

subLayerId

string

DefaultLayerClass

ConstructorOf<T>

Returns

ConstructorOf<T>

Inherited from

CompositeLayer.getSubLayerClass


getSubLayerProps()

protected getSubLayerProps(sublayerProps?): any

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:42

Returns sub layer props for a specific sublayer

Parameters

sublayerProps?
id?

string

updateTriggers?

Record<string, any>

Returns

any

Inherited from

CompositeLayer.getSubLayerProps


getSubLayerRow()

protected getSubLayerRow<T>(row, sourceObject, sourceObjectIndex): T

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:36

When casting user data into another format to pass to sublayers, add reference to the original object and object index

Type Parameters

T

T

Parameters

row

T

sourceObject

any

sourceObjectIndex

number

Returns

T

Inherited from

CompositeLayer.getSubLayerRow


getSubLayers()

getSubLayers(): Layer<{ }>[]

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:17

Return last rendered sub layers

Returns

Layer<{ }>[]

Inherited from

CompositeLayer.getSubLayers


hasUniformTransition()

hasUniformTransition(): boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:143

Checks if this layer has ongoing uniform transition

Returns

boolean

Inherited from

CompositeLayer.hasUniformTransition


initializeState()

initializeState(context): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:18

Called once to set up the initial state. Layers can create WebGL resources here.

Parameters

context

LayerContext

Returns

void

Inherited from

CompositeLayer.initializeState


invalidateAttribute()

protected invalidateAttribute(name?): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:147

Default implementation of attribute invalidation, can be redefined

Parameters

name?

string

Returns

void

Inherited from

CompositeLayer.invalidateAttribute


isPickable()

isPickable(): boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:78

Returns

boolean

Deprecated

Returns true if the layer is visible in the picking pass

Inherited from

CompositeLayer.isPickable


needsUpdate()

needsUpdate(): boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:141

(Internal) Checks if this layer needs a deep update

Returns

boolean

Inherited from

CompositeLayer.needsUpdate


nullPickingColor()

nullPickingColor(): number[]

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:93

Returns

number[]

Inherited from

CompositeLayer.nullPickingColor


onClick()

onClick(info, pickingEvent): boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:92

Parameters

info
color

Uint8Array | null

coordinate?

number[]

devicePixel?

[number, number]

index

number

layer

Layer<{ }> | null

object?

any

picked

boolean

pixel?

[number, number]

pixelRatio

number

sourceLayer?

Layer<{ }> | null

viewport?

Viewport

x

number

y

number

pickingEvent

any

Returns

boolean

Inherited from

CompositeLayer.onClick


onHover()

onHover(info, pickingEvent): boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:91

Parameters

info
color

Uint8Array | null

coordinate?

number[]

devicePixel?

[number, number]

index

number

layer

Layer<{ }> | null

object?

any

picked

boolean

pixel?

[number, number]

pixelRatio

number

sourceLayer?

Layer<{ }> | null

viewport?

Viewport

x

number

y

number

pickingEvent

any

Returns

boolean

Inherited from

CompositeLayer.onHover


project()

project(xyz): number[]

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:44

Projects a point with current view state from the current layer's coordinate system to screen

Parameters

xyz

number[]

Returns

number[]

Inherited from

CompositeLayer.project


projectPosition()

projectPosition(xyz, params?): [number, number, number]

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:49

Projects a point with current view state from the current layer's coordinate system to the world space

Parameters

xyz

number[]

params?
autoOffset?

boolean

Whether to apply offset mode automatically as does the project shader module. Offset mode places the origin of the common space at the given viewport's center. It is used in some use cases to improve precision in the vertex shader due to the fp32 float limitation. Use autoOffset:false if the returned position should not be dependent on the current viewport. Default true

fromCoordinateOrigin?

[number, number, number]

The coordinate origin that the supplied position is in. Default to the same as coordinateOrigin.

fromCoordinateSystem?

CoordinateSystem

The coordinate system that the supplied position is in. Default to the same as coordinateSystem.

viewport?

Viewport

The viewport to use

Returns

[number, number, number]

Inherited from

CompositeLayer.projectPosition


raiseError()

raiseError(error, message): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:134

(Internal) Propagate an error event through the system

Parameters

error

Error

message

string

Returns

void

Inherited from

CompositeLayer.raiseError


renderLayers()

renderLayers(): LayersList | Layer<{ }> | null

Defined in: packages/deck.gl-geotiff/src/mosaic-layer/mosaic-layer.ts:112

Returns

LayersList | Layer<{ }> | null

Overrides

CompositeLayer.renderLayers


renderTileLayer()

renderTileLayer(mosaicSources, renderSource): TileLayer

Defined in: packages/deck.gl-geotiff/src/mosaic-layer/mosaic-layer.ts:55

Parameters

mosaicSources

MosaicT[]

renderSource

(source, opts) => LayersList | Layer<{ }> | null

Returns

TileLayer


restorePickingColors()

restorePickingColors(): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:171

(Internal) Re-enable all picking indices after multi-depth picking

Returns

void

Inherited from

CompositeLayer.restorePickingColors


setChangeFlags()

setChangeFlags(flags): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:189

Dirty some change flags, will be handled by updateLayer

Parameters

flags

Partial<ChangeFlags>

Returns

void

Inherited from

CompositeLayer.setChangeFlags


setNeedsRedraw()

setNeedsRedraw(): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:70

Sets the redraw flag for this layer, will trigger a redraw next animation frame

Returns

void

Inherited from

CompositeLayer.setNeedsRedraw


setNeedsUpdate()

setNeedsUpdate(): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:72

Mark this layer as needs a deep update

Returns

void

Inherited from

CompositeLayer.setNeedsUpdate


setShaderModuleProps()

setShaderModuleProps(...props): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:82

Update shader input parameters

Parameters

props

...[Partial<{[key: string]: Partial<Record<string, unknown> | undefined>; }>]

Returns

void

Inherited from

CompositeLayer.setShaderModuleProps


setState()

setState(updateObject): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:20

Updates selected state members and marks the composite layer to need rerender

Parameters

updateObject

any

Returns

void

Inherited from

CompositeLayer.setState


shouldRenderSubLayer()

protected shouldRenderSubLayer(subLayerId, data): boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/composite-layer.d.ts:31

Returns true if sub layer needs to be rendered

Parameters

subLayerId

string

data

any

Returns

boolean

Inherited from

CompositeLayer.shouldRenderSubLayer


shouldUpdateState()

shouldUpdateState(params): boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:112

Controls if updateState should be called. By default returns true if any prop has changed

Parameters

params

UpdateParameters<Layer<LayerProps & object & Pick<TileLayerProps, "extent" | "maxZoom" | "minZoom" | "maxCacheSize" | "maxCacheByteSize" | "maxRequests"> & object & Required<CompositeLayerProps>>>

Returns

boolean

Inherited from

CompositeLayer.shouldUpdateState


toString()

toString(): string

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:42

Returns a string representation of an object.

Returns

string

Inherited from

CompositeLayer.toString


unproject()

unproject(xy): number[]

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:47

Unprojects a screen pixel to the current view's default coordinate system Note: this does not reverse project.

Parameters

xy

number[]

Returns

number[]

Inherited from

CompositeLayer.unproject


updateAttributes()

protected updateAttributes(changedAttributes): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:149

Send updated attributes to the WebGL model

Parameters

changedAttributes

Returns

void

Inherited from

CompositeLayer.updateAttributes


updateAutoHighlight()

updateAutoHighlight(info): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:199

(Internal) Called by deck picker when the hovered object changes to update the auto highlight

Parameters

info
color

Uint8Array | null

coordinate?

number[]

devicePixel?

[number, number]

index

number

layer

Layer<{ }> | null

object?

any

picked

boolean

pixel?

[number, number]

pixelRatio

number

sourceLayer?

Layer<{ }> | null

viewport?

Viewport

x

number

y

number

Returns

void

Inherited from

CompositeLayer.updateAutoHighlight


updateState()

updateState(params): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:114

Default implementation, all attributes will be invalidated and updated when data changes

Parameters

params

UpdateParameters<Layer<LayerProps & object & Pick<TileLayerProps, "extent" | "maxZoom" | "minZoom" | "maxCacheSize" | "maxCacheByteSize" | "maxRequests"> & object & Required<CompositeLayerProps>>>

Returns

void

Inherited from

CompositeLayer.updateState


use64bitPositions()

use64bitPositions(): boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:90

Returns

boolean

Inherited from

CompositeLayer.use64bitPositions


validateProps()

validateProps(): void

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/lib/layer.d.ts:197

(Internal) called by layer manager to perform extra props validation (in development only)

Returns

void

Inherited from

CompositeLayer.validateProps