Skip to content
CollMapCollMapDocs
EN

Raster Layers

Read and change a raster (TIFF) layer’s display settings over HTTP.

List / get raster layers

Section titled “List / get raster layers”
GET /api/rooms/:roomId/raster-layers            (token permission: read)
GET /api/rooms/:roomId/raster-layers/:layerId   (token permission: read)

Each layer includes bandCount, bandNames, statistics, pyramidStatus, and a display object. Internal S3 keys are never exposed.

Change the display

Section titled “Change the display”
PATCH /api/rooms/:roomId/raster-layers/:layerId/display     (token permission: write)
Content-Type: application/json
{ "colormap": "viridis", "band": 1, "vmin": 0, "vmax": 3000 }

Accepts any of: colormap, band, vmin, vmax, rgbBands, renderMode, opacity, transparentZero, visible (validated → 400 invalid_display with a details list).

  • band is 0..bandCount — 0 = natural color / all bands.
  • vmin/vmax/rgbBands accept null to clear.
  • rgbBands needs exactly three 1-based indices on a raster with ≥3 bands.
  • renderMode: tiles (default), image_overlay (single overview PNG for small/low-res TIFFs), or rgb (multi-band false-color composite).

Colormaps (23): none, viridis, plasma, inferno, magma, cividis, Blues, Greens, Greys, Oranges, Purples, Reds, YlOrBr, YlOrRd, coolwarm, RdYlBu, RdYlGn, Spectral, terrain, ocean, gist_earth, rainbow, jet.