Skip to main content

Interface: RasterLayerProps

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

Props for RasterLayer.

Extends​

  • CompositeLayerProps

Properties​

_dataDiff?​

optional _dataDiff: <LayerDataT>(newData, oldData?) => object[] | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:83

Callback to determine the difference between two data values, in order to perform a partial update.

Inherited from​

CompositeLayerProps._dataDiff

_subLayerProps?​

optional _subLayerProps: {[subLayerId: string]: object; } | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:222

(Experimental) override sub layer props. Only works on a composite layer.

Inherited from​

CompositeLayerProps._subLayerProps

autoHighlight?​

optional autoHighlight: boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:175

Enable GPU-based object highlighting. Default false.

Inherited from​

CompositeLayerProps.autoHighlight

colorFormat?​

optional colorFormat: "RGBA" | "RGB"

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

The format of colors, default 'RGBA'.

Inherited from​

CompositeLayerProps.colorFormat

coordinateOrigin?​

optional coordinateOrigin: [number, number, number]

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:129

The coordinate origin of the data.

Inherited from​

CompositeLayerProps.coordinateOrigin

coordinateSystem?​

optional coordinateSystem: CoordinateSystem

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:125

The coordinate system of the data. Default to COORDINATE_SYSTEM.LNGLAT in a geospatial view or COORDINATE_SYSTEM.CARTESIAN in a non-geospatial view.

Inherited from​

CompositeLayerProps.coordinateSystem

data?​

optional data: unknown

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:75

The data to visualize.

Inherited from​

CompositeLayerProps.data

dataComparator?​

optional dataComparator: <LayerDataT>(newData, oldData?) => boolean | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:79

Callback to determine if two data values are equal.

Inherited from​

CompositeLayerProps.dataComparator

dataTransform?​

optional dataTransform: <LayerDataT>(data, previousData?) => LayerDataT | null

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

Callback to manipulate remote data when it's fetched and parsed.

Inherited from​

CompositeLayerProps.dataTransform

debug?​

optional debug: boolean

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

If set, enables debug mode for visualizing the mesh and reprojection process.

debugOpacity?​

optional debugOpacity: number

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

Opacity of the debug overlay.

extensions?​

optional extensions: LayerExtension<unknown>[]

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:157

Add additional functionalities to this layer.

Inherited from​

CompositeLayerProps.extensions

fetch()?​

optional fetch: (url, context) => any

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

Custom implementation to fetch and parse content from URLs.

Parameters​

url​

string

context​
layer​

Layer

loaders?​

Loader[]

loadOptions?​

any

propName​

string

signal?​

AbortSignal

Returns​

any

Inherited from​

CompositeLayerProps.fetch

getPolygonOffset?​

optional getPolygonOffset: (params) => [number, number] | null

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

Callback to calculate the polygonOffset WebGL parameter.

Inherited from​

CompositeLayerProps.getPolygonOffset

height​

height: number

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

Height of the input raster image in pixels

highlightColor?​

optional highlightColor: number[] | (pickingInfo) => number[]

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:183

The color of the highlight.

Inherited from​

CompositeLayerProps.highlightColor

highlightedObjectIndex?​

optional highlightedObjectIndex: number | null

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

The index of the data object to highlight. If unspecified, the currently hoverred object is highlighted.

Inherited from​

CompositeLayerProps.highlightedObjectIndex

id​

id: string

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:71

Unique identifier of the layer.

Inherited from​

CompositeLayerProps.id

loaders?​

optional loaders: Loader[]

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:161

Add support for additional data formats.

Inherited from​

CompositeLayerProps.loaders

loadOptions?​

optional loadOptions: any

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:165

Options to customize the behavior of loaders

Inherited from​

CompositeLayerProps.loadOptions

maxError?​

optional maxError: number

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

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

Default​

0.125

modelMatrix?​

optional modelMatrix: Matrix4Like | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:133

A 4x4 matrix to transform local coordianates to the world space.

Inherited from​

CompositeLayerProps.modelMatrix

numInstances?​

optional numInstances: number | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:216

(Advanced) supply attribute size externally

Inherited from​

CompositeLayerProps.numInstances

onClick?​

optional onClick: (pickingInfo, event) => boolean | void | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:202

Called when the mouse clicks over an object of this layer.

Inherited from​

CompositeLayerProps.onClick

onDataLoad?​

optional onDataLoad: <LayerDataT>(data, context) => void | null

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

Called when remote data is fetched and parsed.

Inherited from​

CompositeLayerProps.onDataLoad

onDrag?​

optional onDrag: (pickingInfo, event) => boolean | void | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:210

Called when the mouse drags an object of this layer.

Inherited from​

CompositeLayerProps.onDrag

onDragEnd?​

optional onDragEnd: (pickingInfo, event) => boolean | void | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:214

Called when the mouse releases an object of this layer.

Inherited from​

CompositeLayerProps.onDragEnd

onDragStart?​

optional onDragStart: (pickingInfo, event) => boolean | void | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:206

Called when the mouse starts dragging an object of this layer.

Inherited from​

CompositeLayerProps.onDragStart

onError?​

optional onError: (error) => boolean | void | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:194

Called when the layer encounters an error.

Inherited from​

CompositeLayerProps.onError

onHover?​

optional onHover: (pickingInfo, event) => boolean | void | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:198

Called when the mouse enters/leaves an object of this layer.

Inherited from​

CompositeLayerProps.onHover

opacity?​

optional opacity: number

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:121

Opacity of the layer, between 0 and 1. Default 1.

Inherited from​

CompositeLayerProps.opacity

operation?​

optional operation: Operation | "draw+draw" | "draw+mask" | "draw+terrain" | "mask+draw" | "mask+mask" | "mask+terrain" | "terrain+draw" | "terrain+mask" | "terrain+terrain"

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:108

Rendering operation of the layer. + separated list of names.

Inherited from​

CompositeLayerProps.operation

parameters?​

optional parameters: Parameters

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

Override the WebGL parameters used to draw this layer. See https://luma.gl/modules/gltools/docs/api-reference/parameter-setting#parameters

Inherited from​

CompositeLayerProps.parameters

pickable?​

optional pickable: boolean | "3d"

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

If the layer can be picked on pointer events. Default false. Set to '3d' to enable depth picking for 3D coordinates.

Inherited from​

CompositeLayerProps.pickable

positionFormat?​

optional positionFormat: "XYZ" | "XY"

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

The format of positions, default 'XYZ'.

Inherited from​

CompositeLayerProps.positionFormat

renderPipeline​

renderPipeline: RasterModule[] | ImageData

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

Render pipeline for visualizing textures.

Can be:

  • ImageData representing RGBA pixel data
  • Sequence of shader modules to be composed into a shader program

reprojectionFns​

reprojectionFns: ReprojectionFns

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

Reprojection functions for converting between pixel, input CRS, and output CRS coordinates

startIndices?​

optional startIndices: NumericArray | null

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:218

(Advanced) supply variable-width attribute size externally

Inherited from​

CompositeLayerProps.startIndices

transitions?​

optional transitions: Record<string, any> | null

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

Create smooth transitions when prop values update.

Inherited from​

CompositeLayerProps.transitions

updateTriggers?​

optional updateTriggers: Record<string, any>

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:104

The dependencies used to trigger re-evaluation of functional accessors (get*).

Inherited from​

CompositeLayerProps.updateTriggers

visible?​

optional visible: boolean

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

If the layer should be rendered. Default true.

Inherited from​

CompositeLayerProps.visible

width​

width: number

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

Width of the input raster image in pixels

wrapLongitude?​

optional wrapLongitude: boolean

Defined in: node_modules/.pnpm/@deck.gl+core@9.2.10/node_modules/@deck.gl/core/dist/types/layer-props.d.ts:137

(Geospatial only) normalize geometries that cross the 180th meridian. Default false.

Inherited from​

CompositeLayerProps.wrapLongitude