Skip to main content

Type Alias: MultiCOGLayerProps

MultiCOGLayerProps = CompositeLayerProps & Pick<TileLayerProps, "debounceTime" | "maxCacheSize" | "maxCacheByteSize" | "maxRequests" | "refinementStrategy"> & object

Defined in: packages/deck.gl-geotiff/src/multi-cog-layer.ts:158

Props accepted by MultiCOGLayer.

Extends CompositeLayerProps with multi-source COG configuration and optional tile-layer tuning knobs forwarded to the underlying TileLayerProps | TileLayer.

Type Declaration​

composite?​

optional composite?: object

Map source bands to RGB(A) output channels.

See​

buildCompositeBandsProps

composite.a?​

optional a?: string

composite.b?​

optional b?: string

composite.g?​

optional g?: string

composite.r​

r: string

concurrencyLimiter?​

optional concurrencyLimiter?: ConcurrencyLimiter | null

Caps concurrent HTTP requests for this layer's source fetches.

Defaults to a maximum of 6 concurrent requests per origin, which aligns with browser limits of 6 HTTP/1.1 requests per origin. If your sources support HTTP/2 or HTTP/3, you may want to increase this limit or disable it entirely by passing null.

debug?​

optional debug?: boolean

Enable debug overlay showing tile boundaries and metadata labels for all tilesets.

Default​

false

debugLevel?​

optional debugLevel?: 1 | 2 | 3

Controls how much detail is shown in debug text labels.

  • 1: tile index and resolution only
  • 2: adds UV transform and tile count
  • 3: adds stitched dimensions and meters/pixel

Default​

1

debugOpacity?​

optional debugOpacity?: number

Opacity of the reprojection mesh debug overlay. Only used when debug is true. Forwarded to the underlying RasterLayer.

Default​

0.5

epsgResolver?​

optional epsgResolver?: EpsgResolver

EPSG code resolver used to look up projection definitions for numeric CRS codes found in GeoTIFF metadata.

Default​

defaultEpsgResolver

See​

EpsgResolver

maxError?​

optional maxError?: number

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

Default​

0.125

onGeoTIFFLoad?​

optional onGeoTIFFLoad?: (sources, options) => void

Called once all configured sources have been opened and the MultiRasterTilesetDescriptor has been built.

geographicBounds is computed from the primary (finest-resolution) source and reprojected to WGS84; it matches the shape returned by COGLayerProps.onGeoTIFFLoad and is suitable for passing to MapLibre's fitBounds.

Parameters​

sources​

Map<string, GeoTIFF>

options​
geographicBounds​

{ east: number; north: number; south: number; west: number; }

geographicBounds.east​

number

geographicBounds.north​

number

geographicBounds.south​

number

geographicBounds.west​

number

primaryKey​

string

Returns​

void

pool?​

optional pool?: DecoderPool

Decoder pool for parallel image chunk decompression.

See​

DecoderPool

renderPipeline?​

optional renderPipeline?: RasterModule[]

Post-processing render pipeline modules applied after compositing.

See​

RasterModule

signal?​

optional signal?: AbortSignal

AbortSignal to cancel loading of all sources.

sources​

sources: Record<string, MultiCOGSourceConfig>

Named sources -- each key becomes a band name used when compositing.

See​

MultiCOGSourceConfig

See​