Skip to main content

QuadkeyLayer

The QuadkeyLayer renders filled and/or stroked polygons based on the Quadkey geospatial indexing system.

QuadkeyLayer is a CompositeLayer.

import DeckGL from '@deck.gl/react';
import {QuadkeyLayer} from '@deck.gl/geo-layers';

function App({data, viewState}) {
/**
* Data format:
* [
* {
* // Quadkey in SF Bay Area
* quadkey: "023012010333",
* value: 0.5979242952642347
* },
* {
* quadkey: "023012010332",
* value: 0.5446256069712141
* },
* ...
* ]
*/
const layer = new QuadkeyLayer({
id: 'quadkey-layer',
data,
pickable: true,
wireframe: false,
filled: true,
extruded: true,
elevationScale: 1000,
getQuadkey: d => d.quadkey,
getFillColor: d => [d.value * 255, (1 - d.value) * 255, (1 - d.value) * 128],
getElevation: d => d.value
});

return <DeckGL viewState={viewState}
layers={[layer]}
getTooltip={({object}) => object && `${object.quadkey} value: ${object.value}`} />;
}

Installation

To install the dependencies from NPM:

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

To use pre-bundled scripts:

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

Properties

Inherits from all Base Layer, CompositeLayer, and PolygonLayer properties, plus the following:

Data Accessors

getQuadkey (Function, optional)

Called for each data object to retrieve the quadkey string identifier.

  • default: object => object.quadkey

Sub Layers

The QuadkeyLayer renders the following sublayers:

Source

modules/geo-layers/src/quadkey-layer