Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

[Docs] update user documentation with newer layers and features (#552)

hannah yan han885ec3ded1ae
diff --git a/docs/user-guides/a-introduction.md b/docs/user-guides/a-introduction.md
index b93af71a4..b6561cc93 100644
--- a/docs/user-guides/a-introduction.md
+++ b/docs/user-guides/a-introduction.md
@@ -29,9 +29,12 @@ This guide will teach you how to perform data analysis in Kepler.gl by adding da
* [Arc](./c-types-of-layers/b-arc.md)
* [Line](./c-types-of-layers/c-line.md)
* [Grid](./c-types-of-layers/d-grid.md)
-* [GeoJSON](./c-types-of-layers/e-geojson.md)
+* [Polygon](./c-types-of-layers/e-polygon.md)
* [Cluster](./c-types-of-layers/f-cluster.md)
* [Icon](./c-types-of-layers/g-icon.md)
+* [Hexbin](./c-types-of-layers/h-hexbin.md)
+* [Heatmap](./c-types-of-layers/i-heatmap.md)
+* [H3](./c-types-of-layers/j-h3.md)
#### [Layer attributes](./d-layer-attributes.md)
diff --git a/docs/user-guides/c-types-of-layers/e-geojson.md b/docs/user-guides/c-types-of-layers/e-geojson.md
deleted file mode 100644
index eaac79b15..000000000
--- a/docs/user-guides/c-types-of-layers/e-geojson.md
+++ /dev/null
@@ -1,8 +0,0 @@
-# GeoJSON
-
-![GeoJSON layer](https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/documentation/image20.png "GeoJSON layer")
-![Polygon geoJSON layer](https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/documentation/image7.png "Polygon geoJSON layer")
-
-GeoJSON layers can display either paths or polygons.. For example, a path GeoJSON layer can display data like trip routes. A polygon GeoJSON layer is essentially a [choropleth](https://en.wikipedia.org/wiki/Choropleth_map) layer and works best for rendering geofences. To add a GeoJSON layer, your dataset must contain geometry data.
-
-[Back to table of contents](../a-introduction.md)
diff --git a/docs/user-guides/c-types-of-layers/e-polygon.md b/docs/user-guides/c-types-of-layers/e-polygon.md
new file mode 100644
index 000000000..b562a86bd
--- /dev/null
+++ b/docs/user-guides/c-types-of-layers/e-polygon.md
@@ -0,0 +1,26 @@
+# Polygon
+
+Polygon layer can display [GeoJSON](https://tools.ietf.org/html/rfc7946) features. GeoJSON supports the following geometry types: `Point`, `LineString`, `Polygon`, `MultiPoint`, `MultiLineString`, `MultiPolygon`.
+
+kepler.gl supports all the GeoJSON types above. You can pass in either a single [`Feature`][features] or a [`FeatureCollection`][feature_collection]
+
+[feature_collection]: https://tools.ietf.org/html/rfc7946#section-3.3
+[features]: https://tools.ietf.org/html/rfc7946#section-3.2
+
+
+![GeoJSON layer](https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/documentation/image20.png "GeoJSON layer")
+
+![Polygon layer - contour](https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/documentation/layers-polygon-contour.png "Polygon layer")
+
+![Polygon geoJSON layer](https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/documentation/image7.png "Polygon geoJSON layer")
+
+![Polygon layer - buildings](https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/documentation/layers-polygon-buildings.png "Grid layer")
+
+A path GeoJSON layer can display data like trip routes or contours. Stroke color can be set with a numerical field.
+
+A polygon GeoJSON layer is essentially a [choropleth](https://en.wikipedia.org/wiki/Choropleth_map) layer and works best for rendering geofences. Fill color or height can be set with a numerical field. For example, it can display population by census tracts.
+
+To add a polygon layer, your dataset must contain geometry data.
+
+
+[Back to table of contents](../a-introduction.md)
diff --git a/docs/user-guides/c-types-of-layers/h-hexbin.md b/docs/user-guides/c-types-of-layers/h-hexbin.md
new file mode 100644
index 000000000..1b5f40fac
--- /dev/null
+++ b/docs/user-guides/c-types-of-layers/h-hexbin.md
@@ -0,0 +1,8 @@
+# Hexbin
+
+![Hexbin layer](https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/documentation/layers-hexbin.png "Hexbin layer")
+
+Hexbin layers are similar to grid layers. They display distributions of aggregate metrics such as point count within each hexbin, average/max/min/median/sum of a numerical field, or mode/unique count of a string field. Both the color and height dimensions can encode data. Users can adjust the hexagon radius and the space between hexbins.
+
+
+[Back to table of contents](../a-introduction.md)
diff --git a/docs/user-guides/c-types-of-layers/i-heatmap.md b/docs/user-guides/c-types-of-layers/i-heatmap.md
new file mode 100644
index 000000000..d81155976
--- /dev/null
+++ b/docs/user-guides/c-types-of-layers/i-heatmap.md
@@ -0,0 +1,7 @@
+# Heatmap
+
+![Heatmap layer](https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/documentation/layers-heat-map.png "Heatmap layer")
+
+Heatmap layers describe the intensity of data at geographical points through a colored overlap. The intensity can be weighted by a numerical field.
+
+[Back to table of contents](../a-introduction.md)
diff --git a/docs/user-guides/c-types-of-layers/j-h3.md b/docs/user-guides/c-types-of-layers/j-h3.md
new file mode 100644
index 000000000..64b02a23c
--- /dev/null
+++ b/docs/user-guides/c-types-of-layers/j-h3.md
@@ -0,0 +1,9 @@
+# H3
+
+![H3 layer - contour](https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/documentation/layers-h3.png "H3 layer")
+
+H3 layers visualize spatial data using [Uber’s Hexagonal Hierarchical Spatial Index](https://eng.uber.com/h3/).
+
+To use H3 layer, you need a Hex_id in your dataset, which can be generated using [h3-js](https://github.com/uber/h3-js) with latitude, longitude and resolution.
+
+[Back to table of contents](../a-introduction.md)