Skip to content

Commit 3b0be2d

Browse files
authored
[chore] docs updates (#3192)
* [chore] docs updates Signed-off-by: Ihor Dykhta <dikhta.igor@gmail.com> * disable prettier Signed-off-by: Ihor Dykhta <dikhta.igor@gmail.com> --------- Signed-off-by: Ihor Dykhta <dikhta.igor@gmail.com>
1 parent 9c132de commit 3b0be2d

2 files changed

Lines changed: 11 additions & 4 deletions

File tree

docs/user-guides/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ This guide will teach you how to perform data analysis in Kepler.gl by adding da
3737
* [H3](./c-types-of-layers/j-h3.md)
3838
* [Trip](./c-types-of-layers/k-trip.md)
3939
* [S2](./c-types-of-layers/l-s2.md)
40-
* [Vector](./c-types-of-layers/vector.md)
40+
* [Vector Tile Layer](./c-types-of-layers/m-vector-tile-layer.md)
41+
* [Raster Tile Layer](./c-types-of-layers/n-raster-tile-layer.md)
42+
* [WMS Layer](./c-types-of-layers/o-wms-layer.md)
4143

4244
#### [Layer attributes](./d-layer-attributes.md)
4345

docs/user-guides/c-types-of-layers/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,15 @@ Layer Attributes: Color, Radius, Height, High Precision Rendering
8080

8181
GeoJSON layers can display either paths, polygons or points. 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.
8282

83-
# H3
83+
## H3
8484

8585
![H3 layer - contour](https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/documentation/c-h3-layer.png 'H3 layer')
8686

8787
H3 layers visualize spatial data using [H3 Hexagonal Hierarchical Spatial Index](https://eng.uber.com/h3/).
8888

8989
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) from latitude, longitude and resolution.
9090

91-
# S2 Layer
91+
## S2 Layer
9292

9393
![S2 Layer](https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/documentation/l-s2.png 'S2 layer')
9494

@@ -124,6 +124,11 @@ Supported URL templates:
124124
- STAC item and collections _must have Electro-Optical and Raster extensions_, and at least one asset must have both eo:bands and raster:bands information. common_name must be provided in eo:bands and data_type must be provided in raster:bands.
125125
- To use COGs with STAC metadata, you must run your own raster tile server (e.g., TiTiler). Example implementation: [kepler-raster-server](https://github.com/igorDykhta/kepler-raster-server).
126126

127+
Examples of raster .pmtiles:
128+
129+
- Mount Whitney - https://pmtiles.io/usgs-mt-whitney-8-15-webp-512.pmtiles
130+
- Swiss historical - https://public-bucket-for-tests.s3.us-east-1.amazonaws.com/historic-swis-18xx.pmtiles
131+
127132
Examples of supported STAC Items:
128133

129134
- Bangladesh rivers — https://4sq-studio-public.s3.us-west-2.amazonaws.com/sdk/examples/sample-data/raster/planet-skysat-opendata.json
@@ -138,7 +143,7 @@ Supported URL templates:
138143

139144
For step-by-step instructions, see [Raster Tile Layer — How to add](./n-raster-tile-layer.md).
140145

141-
### WMS Layer (experimental)
146+
## WMS Layer (experimental)
142147

143148
![WMS layer](https://4sq-studio-public.s3.us-west-2.amazonaws.com/statics/keplergl/documentation/layer-types/wms.png 'WMS Layer')
144149

0 commit comments

Comments
 (0)