Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[chore] docs update (#3180)
Igor Dykhta9c132de28f08
diff --git a/docs/user-guides/c-types-of-layers/README.md b/docs/user-guides/c-types-of-layers/README.mdindex 410ac1754..57202015d 100644--- a/docs/user-guides/c-types-of-layers/README.md+++ b/docs/user-guides/c-types-of-layers/README.md@@ -1,16 +1,18 @@# Types of Layers## Single Feature Layers-Single feature layers renders 1 feature++Single feature layers render 1 feature+## Point-+Point layers draw points for a given event or object based on its location - latitude and longitude.## Arc-+Arc layers draw an arc between two points. They’re useful for visualizing the distance between two points as well as comparing distances in 3D. Note that arc layers don’t show routes between points, but simply the distance between the two points. The tallest arc represents the greatest distance.@@ -20,7 +22,7 @@ Layer Attributes: Color/ Color Based On, Opacity, Stroke Width/ Stroke Based On,## Line-+Line layers are the 2D version of arc layers. Both draw a line between two points to represent distance, but in a line layer, the drawing lies flat on the map.@@ -28,7 +30,7 @@ Layer Attributes: Color, Stroke, High Precision Rendering## Hexbin-+Hexbin aggregates points into hexagons. The counts can be represented through color and/or height.@@ -36,7 +38,7 @@ Layer Attributes: Color/ Color Based On, Filter by Count Percentile, Opacity, He## Heatmap-+Heatmap is a graphical representation of data in which data values are represented as colors.@@ -44,7 +46,7 @@ Layer Attributes: Color, Opacity, Radius, Weight## Cluster-+Cluster layers visualize aggregated data based on a geospatial radius.@@ -52,7 +54,7 @@ Layer Attributes: Color, Cluster Size## Icon-+Icon layers are a type of point layer. They allow you to differentiate between points by assigning icons to points based on a field. For example, you might use icons to differentiate between types of venues and points of interest.@@ -60,12 +62,12 @@ Layer Attributes: Color, Radius, Label, High Precision RenderingTo see the icon menu, create a new icon layer and click how to draw an icon layer:-+## Grid--++Grids layers are similar to heatmaps. They show the density of points. They provide visual discrepancy in a map where multiple heatmap-style layers are present.@@ -73,14 +75,14 @@ Layer Attributes: Color, Radius, Height, High Precision Rendering## GeoJSON--++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.# H3-+H3 layers visualize spatial data using [H3 Hexagonal Hierarchical Spatial Index](https://eng.uber.com/h3/).@@ -88,12 +90,14 @@ To use H3 layer, you need a `hex_id` in your dataset, which can be generated usi# S2 Layer-+To use S2 layer, you need to assign a column containing S2 tokens.## Vector Tile Layer++Vector Tile Layer makes it possible to visualize very large datasets through MVTs (Mapbox Vector Tiles). To optimize performance, the layer only loads and renders tiles containing features that are visible within the current viewport.Supported URL templates:@@ -101,9 +105,11 @@ Supported URL templates:- MVT (https://api.mapbox.com/v4/mapbox.mapbox-streets-v8/{z}/{x}/{y}.mvt?access_token=your-mapbox-acceess-token)- pmtiles (https://your-cdn/filename.pmtiles)-[Back to table of contents](../README.md)+For step-by-step instructions, see [Vector Tile Layer — How to add](./m-vector-tile-layer.md).++## Raster Tile Layer (experimental)-## Raster Tile Layer+Raster layers are used to show satellite and aerial imagery. They allow you to work interactively directly with massive, image collections stored in .pmtiles (in raster format) or Cloud Optimized GeoTIFF format.@@ -112,7 +118,41 @@ Supported URL templates:- Users can reference remote **.pmtiles files in raster format** for raster layers by supplying a direct link to the file.- **Cloud-Optimized GeoTIFFs (COG)** can also be used in raster layers by providing standardized Spatio-Temporal Asset Catalog (STAC) metadata.- - The metadata file must be a valid *STAC Item* or *STAC Collection*, version 1.0.0 or higher.- - Raster data referenced in STAC assets should be Cloud-Optimized GeoTIFFs and need to be publicly accessible via HTTPS.- - 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.- - Users must use their own instances of raster tile servers, such as Titiler. [TODO: add instructions]++ - The metadata file must be a valid _STAC Item_ or _STAC Collection_, version 1.0.0 or higher.+ - Raster data referenced in STAC assets should be Cloud-Optimized GeoTIFFs and need to be publicly accessible via HTTPS.+ - 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.+ - 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).++ Examples of supported STAC Items:++ - Bangladesh rivers — https://4sq-studio-public.s3.us-west-2.amazonaws.com/sdk/examples/sample-data/raster/planet-skysat-opendata.json+ - Antarctica ice — https://4sq-studio-public.s3.us-west-2.amazonaws.com/sdk/examples/sample-data/raster/sentinel-2-l2a.json+ - Kiribati island — https://4sq-studio-public.s3.us-west-2.amazonaws.com/sdk/examples/sample-data/raster/stac-example.json++ Examples of supported STAC Collections:++ - sentinel-2-l1c — https://earth-search.aws.element84.com/v1/collections/sentinel-2-l1c+ - modis-09A1-061 — https://planetarycomputer.microsoft.com/api/stac/v1/collections/modis-09A1-061+ - landsat-c2-l1 — https://planetarycomputer.microsoft.com/api/stac/v1/collections/landsat-c2-l1++For step-by-step instructions, see [Raster Tile Layer — How to add](./n-raster-tile-layer.md).++### WMS Layer (experimental)++++- Web Map Service (WMS) layers render raster tiles from OGC WMS servers.+- This feature is experimental and disabled by default. To try it, enable `enableWMSLayer: true` in the application configuration.+- When enabled, add a WMS service via the Tilesets modal by providing the service URL and selecting a named layer. Feature info on click is supported for queryable layers.++Examples of supported WMS Tiles:++- https://ows.terrestris.de/osm/service+- https://opengeo.ncep.noaa.gov/geoserver/conus/conus_cref_qcd/ows+- https://gibs.earthdata.nasa.gov/wms/epsg4326/best/wms.cgi+- https://geo.stadt-muenster.de/mapserv/starkregen_serv++For step-by-step instructions, see [WMS Layer — How to add](./o-wms-layer.md).++[Back to table of contents](../README.md)diff --git a/docs/user-guides/c-types-of-layers/k-trip.md b/docs/user-guides/c-types-of-layers/k-trip.mdindex 49dad0c69..ebfdf7942 100644--- a/docs/user-guides/c-types-of-layers/k-trip.md+++ b/docs/user-guides/c-types-of-layers/k-trip.md@@ -2,14 +2,14 @@Trip layer can display animated path.-+### How to use trip layer to animate path**Data format**Currently trip layer support a special `geoJSON` format where the coordinate `linestring` has a 4th element denoting timestamp.-In order to animate the path, the `geoJSON` data needs to contain `LineString` in its features' geometry, and the coordinates in the `LineString` need to have 4 elements in the format of `[longitude, latitude, altitude, timestamp]`, with the last element being a timestamp. Valid timestamp formats include unix in seconds such as `1564184363` or in milliseconds such as `1564184363000`.+In order to animate the path, the `geoJSON` data needs to contain `LineString` in its features' geometry, and the coordinates in the `LineString` need to have 4 elements in the format of `[longitude, latitude, altitude, timestamp]`, with the last element being a timestamp. Valid timestamp formats include unix in seconds such as `1564184363` or in milliseconds such as `1564184363000`.**Sample data**diff --git a/docs/user-guides/c-types-of-layers/l-s2.md b/docs/user-guides/c-types-of-layers/l-s2.mdindex 41a0554e2..7bc3738aa 100644--- a/docs/user-guides/c-types-of-layers/l-s2.md+++ b/docs/user-guides/c-types-of-layers/l-s2.md@@ -1,25 +1,26 @@# S2 Layer-+To use S2 layer, you need to assign a column containing S2 tokens.### Naming Convention-Kepler.gl __auto generates__ S2 layer from column named `s2` or `s2_token`+Kepler.gl **auto generates** S2 layer from column named `s2` or `s2_token`### Simple Dataset-token | value |-|----------|:------:|-80858004 | 0.5979242952642347 |-8085800c | 0.5446256069712141 |-80858014 | 0.1187171597109975 |-8085801c | 0.2859146314037557 |-80858024 | 0.19549012367504126 |-80858034 | 0.3373452974230604 |-8085803c | 0.9218176408795662 |-80858044 | 0.23470692356446143 |-8085804c | 0.1580509670379684 |-80858054 | 0.15992745628743954 |++| token | value |+| -------- | :-----------------: |+| 80858004 | 0.5979242952642347 |+| 8085800c | 0.5446256069712141 |+| 80858014 | 0.1187171597109975 |+| 8085801c | 0.2859146314037557 |+| 80858024 | 0.19549012367504126 |+| 80858034 | 0.3373452974230604 |+| 8085803c | 0.9218176408795662 |+| 80858044 | 0.23470692356446143 |+| 8085804c | 0.1580509670379684 |+| 80858054 | 0.15992745628743954 |[Back to table of contents](../README.md)diff --git a/docs/user-guides/c-types-of-layers/m-vector-tile-layer.md b/docs/user-guides/c-types-of-layers/m-vector-tile-layer.mdnew file mode 100644index 000000000..a5259c42c--- /dev/null+++ b/docs/user-guides/c-types-of-layers/m-vector-tile-layer.md@@ -0,0 +1,25 @@+# Vector Tile Layer — How to add++Follow these steps to add a Vector Tile layer (MVT or pmtiles):++1. Open Add Data → Tilesets.+2. Select Vector Tile tileset type.+3. Enter a tileset URL:+ - Mapbox Vector Tiles (MVT) template, e.g.+ `https://api.mapbox.com/v4/mapbox.mapbox-streets-v8/{z}/{x}/{y}.mvt?access_token=YOUR_TOKEN`+ - pmtiles URL, e.g. `https://your-cdn/filename.pmtiles`+4. Click Add. A new Vector Tile layer will appear in the Layers panel.+5. Style the layer (color, stroke, height, dynamic color) in the Layers panel.++Notes:++- Use Vector Tile layer for vector data in MVT/pmtiles formats. For raster pmtiles or COG/STAC imagery, use Raster Tile layer.++Example Vector Tile sources:++- US population — https://4sq-studio-public.s3.us-west-2.amazonaws.com/vector-tile/cb_v2/{z}/{x}/{y}.pbf+- New Zealand buildings — https://r2-public.protomaps.com/protomaps-sample-datasets/nz-buildings-v3.pmtiles+- US Zip Codes - https://r2-public.protomaps.com/protomaps-sample-datasets/cb_2018_us_zcta510_500k.pmtiles+- Railways — https://4sq-studio-public.s3.us-west-2.amazonaws.com/pmtiles-test/161727fe-7952-4e57-aa05-850b3086b0b2.pmtiles++[Back to layer overview](./README.md)diff --git a/docs/user-guides/c-types-of-layers/n-raster-tile-layer.md b/docs/user-guides/c-types-of-layers/n-raster-tile-layer.mdnew file mode 100644index 000000000..4a39514e6--- /dev/null+++ b/docs/user-guides/c-types-of-layers/n-raster-tile-layer.md@@ -0,0 +1,44 @@+# Raster Tile Layer — How to add (experimental)++Use Raster Tile layer to visualize satellite/aerial imagery from raster pmtiles or COGs via STAC metadata.++1. Open Add Data → Tilesets.+2. Select Raster Tile tileset type.+3. Paste URL to the tileset:+ - pmtiles (raster format): provide a direct HTTPS URL to a .pmtiles file containing raster imagery. Raster pmtiles don't require dedicated raster tile servers, unless you want to use elevation meshes.+ - STAC Item/Collection (COGs): provide a HTTPS URL to a STAC Item or Collection (v1.0.0+ with EO + Raster extensions). For this option you need to provide a [compatible raster tile server](https://github.com/igorDykhta/kepler-raster-server).+4. Click Add.+5. Style band selection and opacity as needed in Layers panel.++Important notes for COGs via STAC:++- The STAC Item/Collection must include EO and Raster extensions with `eo:bands` and `raster:bands` .+- COG assets must be publicly accessible over HTTPS.+- You must run your own raster tile server (e.g., TiTiler). Example implementation that supports collections and elevations: [kepler-raster-server](https://github.com/igorDykhta/kepler-raster-server).++# Elevation++To enable elevation rendering, you must provide one or more compatible raster tile servers when adding the tileset. Enter them in the "Raster tile servers" field of the Add Tileset form.++- For STAC Items/Collections: compatible raster tile servers are required.+- For raster .pmtiles: raster tile servers are optional for imagery, but required if you plan to use elevation.+- The server must expose COGs as XYZ tiles and support elevation/DEM tiles. Example implementation: [kepler-raster-server](https://github.com/igorDykhta/kepler-raster-server) (TiTiler-based).++Example Raster .pmtiles:++- Mount Whitney - https://pmtiles.io/usgs-mt-whitney-8-15-webp-512.pmtiles+- Swiss historical - https://public-bucket-for-tests.s3.us-east-1.amazonaws.com/historic-swis-18xx.pmtiles++Example STAC Items:++- Bangladesh rivers — https://4sq-studio-public.s3.us-west-2.amazonaws.com/sdk/examples/sample-data/raster/planet-skysat-opendata.json+- Antarctica ice — https://4sq-studio-public.s3.us-west-2.amazonaws.com/sdk/examples/sample-data/raster/sentinel-2-l2a.json+- Kiribati island — https://4sq-studio-public.s3.us-west-2.amazonaws.com/sdk/examples/sample-data/raster/stac-example.json++Example STAC Collections:++- sentinel-2-l1c — https://earth-search.aws.element84.com/v1/collections/sentinel-2-l1c+- modis-09A1-061 — https://planetarycomputer.microsoft.com/api/stac/v1/collections/modis-09A1-061+- landsat-c2-l1 — https://planetarycomputer.microsoft.com/api/stac/v1/collections/landsat-c2-l1++[Back to layer overview](./README.md)diff --git a/docs/user-guides/c-types-of-layers/o-wms-layer.md b/docs/user-guides/c-types-of-layers/o-wms-layer.mdnew file mode 100644index 000000000..037a4923f--- /dev/null+++ b/docs/user-guides/c-types-of-layers/o-wms-layer.md@@ -0,0 +1,22 @@+# WMS Layer — How to add (experimental)++Use WMS Layer to render imagery from OGC Web Map Service (WMS) endpoints.++1. Open Add Data → Tilesets.+2. Select WMS tileset type.+3. Enter the WMS service URL (GetCapabilities endpoint or base service URL).+4. Click Add. A new WMS layer will appear in the Layers panel.+5. In the Layers panel you can select a named layer from the service.++Notes:++- Feature info on click is supported for queryable layers (`queryable=true`).++Example WMS services:++- https://ows.terrestris.de/osm/service+- https://opengeo.ncep.noaa.gov/geoserver/conus/conus_cref_qcd/ows+- https://gibs.earthdata.nasa.gov/wms/epsg4326/best/wms.cgi+- https://geo.stadt-muenster.de/mapserv/starkregen_serv++[Back to layer overview](./README.md)