Skip to content

docs(h3-hexagon-layer): add GeoJSON FeatureCollection example #10317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SMC17 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(h3-hexagon-layer): add GeoJSON FeatureCollection example #10317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/api-reference/geo-layers/h3-hexagon-layer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,38 @@ function App() {
</Tabs>


### Consuming H3 cells from a GeoJSON FeatureCollection

A common export pattern is GeoJSON where each feature's `properties`
carries the H3 cell ID as a string (produced by `geopandas`, QGIS,
`h3-py`, or a custom spatial-index pipeline). The default
`getHexagon: object => object.hexagon` accessor returns `undefined`
for these features because GeoJSON parsers surface them as
`{type, geometry, properties}` objects.

Override `getHexagon` to pull the cell ID out of `properties`:

```js
import {H3HexagonLayer} from '@deck.gl/geo-layers';

new H3HexagonLayer({
id: 'h3-cells-from-geojson',
data: 'cells.geojson', // FeatureCollection; each feature.properties carries h3_id
pickable: true,
filled: true,
extruded: true,
getHexagon: d => d.properties.h3_id,
getFillColor: d => [255, (1 - d.properties.value) * 255, 0],
getElevation: d => d.properties.value * 1000
});
```

Any per-feature value to be styled or extruded by lives under
`d.properties.*` in this shape. The geometry on each feature is
ignored — `H3HexagonLayer` reconstructs the hexagon from the cell
ID via `cellToBoundary`.


## Installation

To install the dependencies from NPM:
Expand Down