---
description: "GridCellLayer renders extruded square grid cells at given coordinates."
---
# GridCellLayer

import {GridCellLayerDemo} from '@site/src/doc-demos/layers';
The `GridCellLayer` can render a grid-based heatmap.
It is a variation of the [ColumnLayer](./column-layer.md).
It takes the constant width / height of all cells and bottom-left coordinate of each cell.
This is the primitive layer rendered by [GridLayer](../aggregation-layers/grid-layer.md) after aggregation. Unlike the GridLayer, it renders one column for each data object.
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
```js
import {Deck} from '@deck.gl/core';
import {GridCellLayer} from '@deck.gl/layers';
const layer = new GridCellLayer({
id: 'GridCellLayer',
data: 'https://raw.githubusercontent.com/visgl/deck.gl-data/master/website/hexagons.json',
cellSize: 200,
extruded: true,
elevationScale: 5000,
getElevation: d => d.value,
getFillColor: d => [48, 128, d.value * 255, 255],
getPosition: d => d.centroid,
pickable: true
});
new Deck({
initialViewState: {
longitude: -122.4,
latitude: 37.74,
zoom: 11
},
controller: true,
getTooltip: ({object}) => object && `height: ${object.value * 5000}m`,
layers: [layer]
});
```
```ts
import {Deck, PickingInfo} from '@deck.gl/core';
import {GridCellLayer} from '@deck.gl/layers';
import type {PickingInfo} from '@deck.gl/core';
type DataType = {
value: number;
centroid: [longitude: number, latitude: number];
};
const layer = new GridCellLayer({
id: 'GridCellLayer',
data: 'https://raw.githubusercontent.com/visgl/deck.gl-data/master/website/hexagons.json',
cellSize: 200,
extruded: true,
elevationScale: 5000,
getElevation: (d: DataType) => d.value,
getFillColor: (d: DataType) => [48, 128, d.value * 255, 255],
getPosition: (d: DataType) => d.centroid,
pickable: true
});
new Deck({
initialViewState: {
longitude: -122.4,
latitude: 37.74,
zoom: 11
},
controller: true,
getTooltip: ({object}: PickingInfo) => object && `height: ${object.value * 5000}m`,
layers: [layer]
});
```
```tsx
import React from 'react';
import {DeckGL} from '@deck.gl/react';
import {GridCellLayer} from '@deck.gl/layers';
import type {PickingInfo} from '@deck.gl/core';
type DataType = {
value: number;
centroid: [longitude: number, latitude: number];
};
function App() {
const layer = new GridCellLayer({
id: 'GridCellLayer',
data: 'https://raw.githubusercontent.com/visgl/deck.gl-data/master/website/hexagons.json',
cellSize: 200,
extruded: true,
elevationScale: 5000,
getElevation: (d: DataType) => d.value,
getFillColor: (d: DataType) => [48, 128, d.value * 255, 255],
getPosition: (d: DataType) => d.centroid,
pickable: true
});
return ) => object && `height: ${object.value * 5000}m`}
layers={[layer]}
/>;
}
```
```js
import {Field, FixedSizeList, Float32, vectorFromArray} from 'apache-arrow';
import {GridCellLayer} from '@deck.gl/layers';
const positionType = new FixedSizeList(2, new Field('value', new Float32()));
const positions = vectorFromArray([[-122.4, 37.74]], positionType);
const layer = new GridCellLayer({
getPosition: positions,
getElevation: vectorFromArray([100], new Float32())
});
```
See [Using with Arrow](../../developer-guide/using-with-arrow.md) for column layouts and mixed inputs.
## Installation
To install the dependencies from NPM:
```bash
npm install deck.gl
# or
npm install @deck.gl/core @deck.gl/layers
```
```ts
import {GridCellLayer} from '@deck.gl/layers';
import type {GridCellLayerProps} from '@deck.gl/layers';
new GridCellLayer(...props: GridCellLayerProps[]);
```
To use pre-bundled scripts:
```html
```
```js
new deck.GridCellLayer({});
```
## Properties
Inherits from all [Base Layer](../core/layer.md) properties.
### Render Options
#### `cellSize` (number, optional)  {#cellsize}
* Default: `1000`
Size of each grid cell in meters
#### `coverage` (number, optional)  {#coverage}
* Default: `1`
Cell size scale factor. The size of cell is calculated by
`cellSize * coverage`.
#### `elevationScale` (number, optional)  {#elevationscale}
* Default: `1`
Elevation multiplier. The elevation of cell is calculated by
`elevationScale * getElevation(d)`. `elevationScale` is a handy property
to scale all cell elevations without updating the data.
#### `extruded` (boolean, optional) {#extruded}
* Default: `true`
Whether to enable grid elevation. If set to false, all grid will be flat.
#### `material` (Material, optional) {#material}
* Default: `true`
This is an object that contains material props for [lighting effect](../core/lighting-effect.md) applied on extruded polygons.
Check [the lighting guide](../../developer-guide/using-effects.md#material-settings) for configurable settings.
### Data Accessors
#### `getPosition` (constant | Accessor | arrow.Vector, optional)  {#getposition}
* Default: `x => x.position`
Method called to retrieve the bottom-left corner (`[minX, minY]`) of each cell.
An Arrow vector supplies one value per object. See [position columns](../../developer-guide/using-with-arrow.md#positions-and-other-vectors) for requirements.
#### `getColor` ([Accessor<Color>](../../developer-guide/using-layers.md#accessors), optional)  {#getcolor}
* Default: `[255, 0, 255, 255]`
The rgba color of each object, in `r, g, b, [a]`. Each component is in the 0-255 range.
* If an array is provided, it is used as the color for all objects.
* If a function is provided, it is called on each object to retrieve its color.
#### `getElevation` (constant | Accessor | arrow.Vector, optional)  {#getelevation}
* Default: `1000`
The elevation of each cell in meters.
* If a number is provided, it is used as the elevation for all objects.
* If a function is provided, it is called on each object to retrieve its elevation.
An Arrow vector supplies one value per object. See [scalar columns](../../developer-guide/using-with-arrow.md#scalars) for requirements.
## GPUVector inputs 🧪 {#gpuvector-inputs-unstable}
> GPU buffer layouts are internal to layer implementations and can change in future releases.
GPUVector props let applications supply caller-owned GPU buffers to the rendering path. This is particularly useful when applications compute rendering attributes on the GPU.
GridCellLayer accepts the [ColumnLayer GPUVector props](./column-layer.md#gpuvector-inputs-unstable).
## Source
[modules/layers/src/column-layer/grid-cell-layer.ts](https://github.com/visgl/deck.gl/tree/master/modules/layers/src/column-layer/grid-cell-layer.ts)