Chevron DownAPI Reference


CartoBQTilerLayer is a layer to visualize large datasets (millions or billions of rows) directly from Google BigQuery without having to move data outside of BigQuery.

First you need first to generate a tileset of your dataset in your BigQuery account using CARTO BigQuery Tiler. For more info click here.

import DeckGL from '';
import {CartoBQTilerLayer} from '';

function App({viewState}) {
  const layer = new CartoBQTilerLayer({
    data: 'cartobq.maps.nyc_taxi_points_demo_id',
    getLineColor: [255, 255, 255],
    getFillColor: [238, 77, 90],
    pointRadiusMinPixels: 2,
    lineWidthMinPixels: 1

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


To install the dependencies from NPM:

npm install
# or
npm install
import {CartoBQTilerLayer} from '';
new CartoBQTilerLayer({});

To use pre-bundled scripts:

<script src="^8.2.0/dist.min.js"></script>
<script src="^8.2.0/dist.min.js"></script>

<!-- or -->
<script src="^8.0.0/dist.min.js"></script>
<script src="^8.2.0/dist.min.js"></script>
<script src="^8.2.0/dist.min.js"></script>
<script src="^8.2.0/dist.min.js"></script>
new deck.carto.CartoBQTilerLayer({});


Inherits all properties from MVTLayer.

data (String)

Required. Tileset id

uniqueIdProperty (String)
  • Default: id

Optional. Needed for highlighting a feature split across two or more tiles if no feature id is provided.

A string pointing to a tile attribute containing a unique identifier for features across tiles.


onDataLoad (Function, optional)

onDataLoad is called when the request to the CARTO tiler was completed successfully.

  • Default: tilejson => {}

Receives arguments:

  • tilejson (Object) - the response from the tiler service
onDataError (Function, optional)

onDataError is called when the request to the CARTO tiler failed. By default the Error is thrown.

  • Default: null

Receives arguments:

  • error (Error)