Chevron DownAPI Reference
GridLayer
i

Explore GridLayer's API
Sample data


autoHighlight: false
cellSize: 200
coverage: 1
elevationLowerPercentile: 0
elevationScale: 4
elevationUpperPercentile: 100
extruded: true
gpuAggregation: false
highlightColor: #000080
lowerPercentile: 0
material: true
opacity: 1
pickable: true
upperPercentile: 100
visible: true
wrapLongitude: false
View Code ↗

lighting

GridLayer

The GridLayer renders a grid heatmap based on an array of points. It takes the constant cell size, aggregates input points into cells. The color and height of the cell is scaled by number of points it contains.

This layer renders either a GPUGridLayer or a CPUGridLayer, depending on its props and whether GPU aggregation is supported. For more details check the GPU Aggregation section below.

GridLayer is a CompositeLayer.

import DeckGL from '@deck.gl/react';
import {GridLayer} from '@deck.gl/aggregation-layers';

function App({data, viewState}) {
  /**
   * Data format:
   * [
   *   {COORDINATES: [-122.42177834, 37.78346622]},
   *   ...
   * ]
   */
  const layer = new GridLayer({
    id: 'new-grid-layer',
    data,
    pickable: true,
    extruded: true,
    cellSize: 200,
    elevationScale: 4,
    getPosition: d => d.COORDINATES
  });

  return <DeckGL viewState={viewState}
    layers={[layer]}
    getTooltip={({object}) => object && `${object.position.join(', ')}\nCount: ${object.count}`} />;
}

Note: The GridLayer at the moment only works with COORDINATE_SYSTEM.LNGLAT.

Installation

To install the dependencies from NPM:

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

To use pre-bundled scripts:

<script src="https://unpkg.com/deck.gl@^8.0.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.0.0/dist.min.js"></script>
<script src="https://unpkg.com/@deck.gl/aggregation-layers@^8.0.0/dist.min.js"></script>
new deck.GridLayer({});

Properties

Inherits from all Base Layer and CompositeLayer properties.

Render Options

cellSize (Number, optional)
  • Default: 1000

Size of each cell in meters

colorDomain (Array, optional)
  • Default: [min(count), max(count)]

Color scale domain, default is set to the range of point counts in each cell.

colorRange (Array, optional)
  • Default:

Specified as an array of 6 colors [color1, color2, ... color6]. Each color is an array of 3 or 4 values [R, G, B] or [R, G, B, A], representing intensities of Red, Green, Blue and Alpha channels. Each intensity is a value between 0 and 255. When Alpha not provided a value of 255 is used. By default colorRange is set to colorbrewer 6-class YlOrRd.

coverage (Number, optional) transition-enabled
  • Default: 1

Cell size multiplier, clamped between 0 - 1. The final size of cell is calculated by coverage * cellSize. Note: coverage does not affect how points are binned. Coverage are linear based.

elevationDomain (Array, optional)
  • Default: [0, max(count)]

Elevation scale input domain, default is set to the extent of point counts in each cell.

elevationRange (Array, optional)
  • Default: [0, 1000]

Elevation scale output range

elevationScale (Number, optional) transition-enabled
  • Default: 1

Cell elevation multiplier. The elevation of cell is calculated by elevationScale * getElevation(d). elevationScale is a handy property to scale all cells without updating the data.

extruded (Boolean, optional)
  • Default: true

Whether to enable cell elevation. Cell elevation scale by count of points in each cell. If set to false, all cell will be flat.

upperPercentile (Number, optional) transition-enabled
  • Default: 100

Filter cells and re-calculate color by upperPercentile. Cells with value larger than the upperPercentile will be hidden.

lowerPercentile (Number, optional) transition-enabled
  • Default: 0

Filter cells and re-calculate color by lowerPercentile. Cells with value smaller than the lowerPercentile will be hidden.

elevationUpperPercentile (Number, optional) transition-enabled
  • Default: 100

Filter cells and re-calculate elevation by elevationUpperPercentile. Cells with elevation value larger than the elevationUpperPercentile will be hidden.

elevationLowerPercentile (Number, optional) transition-enabled
  • Default: 100

Filter cells and re-calculate elevation by elevationLowerPercentile. Cells with elevation value smaller than the elevationLowerPercentile will be hidden.

colorScaleType (String, optional)
  • Default: 'quantize'

Scaling function used to determine the color of the grid cell, default value is 'quantize'. Supported Values are 'quantize', 'linear', 'quantile' and 'ordinal'.

fp64 (Boolean, optional)
  • Default: false

Whether the aggregation should be performed in high-precision 64-bit mode. Note that since deck.gl v6.1, the default 32-bit projection uses a hybrid mode that matches 64-bit precision with significantly better performance.

gpuAggregation (bool, optional)
  • Default: false

When set to true, aggregation is performed on GPU, provided other conditions are met, for more details check the GPU Aggregation section below. GPU aggregation can be a lot faster than CPU depending upon the number of points and number of cells.

Note: GPU Aggregation is faster only when using large data sets. For smaller data sets GPU Aggregation could be potentially slower than CPU Aggregation.

material (Object, optional)
  • Default: true

This is an object that contains material props for lighting effect applied on extruded polygons. Check the lighting guide for configurable settings.

Data Accessors

getPosition (Function, optional)
  • Default: object => object.position

Method called to retrieve the position of each point.

getColorValue (Function, optional) transition-enabled
  • Default: points => points.length

getColorValue is the accessor function to get the value that cell color is based on. It takes an array of points inside each cell as arguments, returns a number. For example, You can pass in getColorValue to color the cells by avg/mean/max of a specific attributes of each point. By default getColorValue returns the length of the points array.

Note: grid layer compares whether getColorValue has changed to recalculate the value for each bin that its color based on. You should pass in the function defined outside the render function so it doesn't create a new function on every rendering pass.

 class MyGridLayer {
    getColorValue (points) {
        return points.length;
    }

    renderLayers() {
      return new GridLayer({
        id: 'grid-layer',
        getColorValue: this.getColorValue // instead of getColorValue: (points) => { return points.length; }
        data,
        cellSize: 500
      });
    }
 }
getColorWeight (Function, optional) transition-enabled
  • Default: point => 1

getColorWeight is the accessor function to get the weight of a point used to calcuate the color value for a cell. It takes the data prop array element and returns the weight, for example, to use SPACE field, getColorWeight should be set to point => point.SPACES. By default getColorWeight returns 1.

Note: similar to getColorValue, grid layer compares whether getColorWeight has changed to recalculate the value for each bin that its color based on.

colorAggregation (String, optional)
  • Default: 'SUM'

colorAggregation defines, operation used to aggregate all data point weights to calculate a cell's color value. Valid values are 'SUM', 'MEAN', 'MIN' and 'MAX'. 'SUM' is used when an invalid value is provided.

Note: getColorWeight and colorAggregation together define how color value of cell is determined, same can be done by setting getColorValue prop. But to enable gpu aggregation, former props must be provided instead of later.

Example1 : Using count of data elements that fall into a cell to encode the its color
  • Using getColorValue
function getCount(points) {
  return points.length;
}
...
const layer = new GridLayer({
  id: 'my-grid-layer',
  ...
  getColorValue: getCount,
  ...
});
  • Using getColorWeight and colorAggregation
function getWeight(point) {
  return 1;
}
...
const layer = new GridLayer({
  id: 'my-grid-layer',
  ...
  getColorWeight: getWeight,
  colorAggregation: 'SUM'
  ...
});
Example2 : Using mean value of 'SPACES' field of data elements to encode the color of the cell
  • Using getColorValue
function getMean(points) {
  return points.reduce((sum, p) => sum += p.SPACES, 0) / points.length;
}
...
const layer = new GridLayer({
  id: 'my-grid-layer',
  ...
  getColorValue: getMean,
  ...
});
  • Using getColorWeight and colorAggregation
function getWeight(point) {
  return point.SPACES;
}
...
const layer = new GridLayer({
  id: 'my-grid-layer',
  ...
  getColorWeight: getWeight,
  colorAggregation: 'SUM'
  ...
});

If your use case requires aggregating using an operation that is not one of 'SUM', 'MEAN', 'MAX' and 'MIN', getColorValue should be used to define such custom aggregation function. In those cases GPU aggregation is not supported.

getElevationValue (Function, optional) transition-enabled
  • Default: points => points.length

Similar to getColorValue, getElevationValue is the accessor function to get the value that cell elevation is based on. It takes an array of points inside each cell as arguments, returns a number. By default getElevationValue returns the length of the points array.

Note: grid layer compares whether getElevationValue has changed to recalculate the value for each cell for its elevation. You should pass in the function defined outside the render function so it doesn't create a new function on every rendering pass.

getElevationWeight (Function, optional) transition-enabled
  • Default: point => 1

getElevationWeight is the accessor function to get the weight of a point used to calculate the elevation value for a cell. It takes the data prop array element and returns the weight, for example, to use SPACE field, getElevationWeight should be set to point => point.SPACES. By default getElevationWeight returns 1.

Note: similar to getElevationValue, grid layer compares whether getElevationWeight has changed to recalculate the value for each bin that its color based on.

elevationAggregation (String, optional)
  • Default: 'SUM'

elevationAggregation defines, operation used to aggregate all data point weights to calculate a cell's elevation value. Valid values are 'SUM', 'MEAN', 'MIN' and 'MAX'. 'SUM' is used when an invalid value is provided.

Note: getElevationWeight and elevationAggregation together define how elevation value of cell is determined, same can be done by setting getColorValue prop. But to enable gpu aggregation, former props must be provided instead of later.

Example1 : Using count of data elements that fall into a cell to encode its elevation
  • Using getElevationValue
function getCount(points) {
  return points.length;
}
...
const layer = new GridLayer({
  id: 'my-grid-layer',
  ...
  getElevationValue: getCount,
  ...
});
  • Using getElevationWeight and elevationAggregation
function getWeight(point) {
  return 1;
}
...
const layer = new GridLayer({
  id: 'my-grid-layer',
  ...
  getElevationWeight: getWeight,
  elevationAggregation: 'SUM'
  ...
});
Example2 : Using maximum value of 'SPACES' field of data elements to encode the elevation of the cell
  • Using getElevationValue
function getMax(points) {
  return points.reduce((max, p) => p.SPACES > max ? p.SPACES : max, -Infinity);
}
...
const layer = new GridLayer({
  id: 'my-grid-layer',
  ...
  getElevationValue: getMax,
  ...
});
  • Using getElevationWeight and elevationAggregation
function getWeight(point) {
  return point.SPACES;
}
...
const layer = new GridLayer({
  id: 'my-grid-layer',
  ...
  getElevationWeight: getWeight,
  elevationAggregation: 'MAX'
  ...
});

If your use case requires aggregating using an operation that is not one of 'SUM', 'MEAN', 'MAX' and 'MIN', getElevationValue should be used to define such custom aggregation function. In those cases GPU aggregation is not supported.

onSetColorDomain (Function, optional)
  • Default: () => {}

This callback will be called when bin color domain has been calculated. Note that this is only fired when using CPU Aggregation (gpuAggregation: false).

onSetElevationDomain (Function, optional)
  • Default: () => {}

This callback will be called when bin elevation domain has been calculated. Note that this is only fired when using CPU Aggregation (gpuAggregation: false).

GPU Aggregation

Performance Metrics

The following table compares the performance between CPU and GPU aggregations using random data points:

#pointsCPU #iterations/secGPU #iterations/secNotes
25K535359GPU is 33% slower
100K119437GPU is 267% faster
1M12.7158GPU is 1144% faster

Numbers are collected on a 2016 15-inch Macbook Pro (CPU: 2.8 GHz Intel Core i7 and GPU: AMD Radeon R9 M370X 2 GB)

Fallback Cases

This layer performs aggregation on GPU when the browser is using WebGL2 and the gpuAggregation prop is set to true, but will fallback to CPU in the following cases:

Percentile Props

When following percentile props are set, it requires sorting of aggregated values, which cannot be supported when aggregating on GPU.

  • lowerPercentile, upperPercentile, elevationLowerPercentile and elevationUpperPercentile.

Color and Elevation Props

When colorScaleType props is set to a 'quantile' or 'ordinal', aggregation will fallback to CPU. For GPU Aggregation, use 'quantize', 'linear'.

Color Scale Type Props

When following percentile props are set, it requires sorting of aggregated values, which cannot be supported when aggregating on GPU.

  • lowerPercentile, upperPercentile, elevationLowerPercentile and elevationUpperPercentile.

Domain setting callbacks

When using GPU Aggregation, onSetColorDomain and onSetElevationDomain are not fired.

Sub Layers

The GridLayer renders the following sublayers:

Source

modules/aggregation-layers/src/grid-layer