rasterSource

You can use rasterSource to build layers and widgets using tables stored in your data warehouse that contain:

• CARTO Raster data: continuous data across a surface represented by pixels (eg: temperature, land use, etc...) following the RaQuet specification by CARTO. Learn more about using rasters in CARTO.

Usage

import {rasterSource} from '@carto/api-client';

const data = rasterSource({
  tableName: 'carto-demo-data.demo_rasters.raster_table'
});

Options

type RasterSourceOptions = {
  tableName: string;
  widgetWorker?: boolean;
};

• tableName: The fully qualified name (FQN) of the pre-generated raster table you want to retrieve from your data warehouse. For example, for a BigQuery connection, carto-demo-data.demo_rasters.raster_table would be a valid table name.

• widgetWorker (optional): A boolean that enables or disables the use of Web Workers to perform clent-side calculations for widgets.

Response

The response of rasterSource is a promise that can be resolved and used in layers and widgets.

Connection compatibility

Connection Data Warehouse	Compatible
BigQuery	✅
Snowflake	✅
Redshift	❌
Databricks	✅
Oracle	✅
PostgreSQL	❌
CARTO Data Warehouse	✅

Layer compatibility

rasterSource is compatible with the following layers from the @deck.gl/carto module:

• RasterTileLayer

Widget model compatibility

rasterSource is compatible with the following widget models:

• getFormula

• getCategories

• getHistogram

• getRange

• getScatter

• getTimeSeries

• getTable

Widget models for rasters are calculated client side. Precision might be lower, especially at low zoom levels (ie: when covering a large surface of the earth). Learn more about client-side widget calculations.