S2Layer

Edit on Codepen

The S2Layer renders filled and/or stroked polygons based on the S2 geospatial indexing system.

S2Layer is a CompositeLayer.

JavaScript
TypeScript
React

import {Deck} from '@deck.gl/core';
import {S2Layer} from '@deck.gl/geo-layers';

const layer = new S2Layer({
  id: 'S2Layer',
  data: 'https://raw.githubusercontent.com/visgl/deck.gl-data/master/website/sf.s2cells.json',
  
  extruded: true,
  getS2Token: d => d.token,
  getFillColor: d => [d.value * 255, (1 - d.value) * 255, (1 - d.value) * 128],
  getElevation: d => d.value,
  elevationScale: 1000,
  pickable: true
});

new Deck({
  initialViewState: {
    longitude: -122.4,
    latitude: 37.74,
    zoom: 11
  },
  controller: true,
  getTooltip: ({object}) => object && `${object.token} value: ${object.value}`,
  layers: [layer]
});

import {Deck, PickingInfo} from '@deck.gl/core';
import {S2Layer} from '@deck.gl/geo-layers';

type DataType = {
  token: string;
  value: number;
};

const layer = new S2Layer<DataType>({
  id: 'S2Layer',
  data: 'https://raw.githubusercontent.com/visgl/deck.gl-data/master/website/sf.s2cells.json',
  
  extruded: true,
  getS2Token: (d: DataType) => d.token,
  getFillColor: (d: DataType) => [d.value * 255, (1 - d.value) * 255, (1 - d.value) * 128],
  getElevation: (d: DataType) => d.value,
  elevationScale: 1000,
  pickable: true
});

new Deck({
  initialViewState: {
    longitude: -122.4,
    latitude: 37.74,
    zoom: 11
  },
  controller: true,
  getTooltip: ({object}: PickingInfo<DataType>) => object && `${object.token} value: ${object.value}`,
  layers: [layer]
});

import React from 'react';
import {DeckGL} from '@deck.gl/react';
import {S2Layer} from '@deck.gl/geo-layers';
import type {PickingInfo} from '@deck.gl/core';

type DataType = {
  token: string;
  value: number;
};

function App() {
  const layer = new S2Layer<DataType>({
    id: 'S2Layer',
    data: 'https://raw.githubusercontent.com/visgl/deck.gl-data/master/website/sf.s2cells.json',
    
    extruded: true,
    getS2Token: (d: DataType) => d.token,
    getFillColor: (d: DataType) => [d.value * 255, (1 - d.value) * 255, (1 - d.value) * 128],
    getElevation: (d: DataType) => d.value,
    elevationScale: 1000,
    pickable: true
  });

  return <DeckGL
    initialViewState={{
      longitude: -122.4,
      latitude: 37.74,
      zoom: 11
    }}
    controller
    getTooltip={({object}: PickingInfo<DataType>) => object && `${object.token} value: ${object.value}`}
    layers={[layer]}
  />;
}

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 {S2Layer} from '@deck.gl/geo-layers';
import type {S2LayerProps} from '@deck.gl/geo-layers';

new S2Layer<DataT>(...props: S2LayerProps<DataT>[]);

To use pre-bundled scripts:

<script src="https://unpkg.com/deck.gl@^9.0.0/dist.min.js"></script>
<!-- or -->
<script src="https://unpkg.com/@deck.gl/core@^9.0.0/dist.min.js"></script>
<script src="https://unpkg.com/@deck.gl/layers@^9.0.0/dist.min.js"></script>
<script src="https://unpkg.com/@deck.gl/geo-layers@^9.0.0/dist.min.js"></script>

new deck.S2Layer({});

Properties

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

Data Accessors

`getS2Token` (Accessor<string>, optional)

Called for each data object to retrieve the identifier of the S2 cell. May return one of the following:

A string that is the cell's hex token
A string that is the Hilbert quad key (containing /)
A Long object that is the cell's id

Check S2 Cell for more details.

default: object => object.token

Sub Layers

The S2Layer renders the following sublayers:

cell - a PolygonLayer rendering all S2 cells.

Source

modules/geo-layers/src/s2-layer

Installation​

Properties​

Data Accessors​

getS2Token (Accessor<string>, optional) ​

Sub Layers​

Source​