Back to Deck Gl

RasterTileLayer

docs/api-reference/carto/raster-tile-layer.md

9.3.21.9 KB
Original Source

RasterTileLayer

RasterTileLayer is a layer for visualizing tiled raster data.

Usage

tsx
import {DeckGL} from '@deck.gl/react';
import {RasterTileLayer} from '@deck.gl/carto';
import {rasterSource} from '@carto/api-client';

function App({viewState}) {
  const data = rasterSource({
    accessToken: 'XXX',
    connectionName: 'carto_dw',
    tableName: 'cartobq.public_account.temperature_raster'
  });

  const layer = new RasterTileLayer({
    data,
    getFillColor: d => {
      const {band_1} = d.properties;
      return [10 * (band_1 - 20), 0, 300 - 5 * band_1];
    }
  })

  return <DeckGL viewState={viewState} layers={[layer]} />;
}

Installation

To install the dependencies from NPM:

bash
npm install deck.gl
# or
npm install @deck.gl/core @deck.gl/layers @deck.gl/carto
js
import {RasterTileLayer} from '@deck.gl/carto';
new RasterTileLayer({});

To use pre-bundled scripts:

html
<script src="https://unpkg.com/deck.gl@^9.0.0/dist.min.js"></script>
<script src="https://unpkg.com/@deck.gl/carto@^9.0.0/dist.min.js"></script>

<!-- or -->
<script src="https://unpkg.com/@deck.gl/core@^9.0.0/dist.min.js"></script>
<script src="https://unpkg.com/@deck.gl/layers@^9.0.0/dist.min.js"></script>
<script src="https://unpkg.com/@deck.gl/geo-layers@^9.0.0/dist.min.js"></script>
<script src="https://unpkg.com/@deck.gl/carto@^9.0.0/dist.min.js"></script>
js
new deck.carto.RasterTileLayer({});

Properties

Inherits all properties from ColumnLayer and TileLayer, with exceptions indicated below.

data (TilejsonResult) {#data}

Required. A valid TilejsonResult object.

Use the rasterSource to fetch this from the CARTO API.

Source

modules/carto/src/layers/raster-tile-layer.ts