Chevron DownAPI Reference

CartoBQTilerLayer

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 '@deck.gl/react';
import {CartoBQTilerLayer} from '@deck.gl/carto';


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]} />;
}

Installation

To install the dependencies from NPM:

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

To use pre-bundled scripts:

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

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

Properties

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.

Source

modules/carto/src/layers/carto-bqtiler-layer.js