Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[Docs] Updating Layer User Guides (#373)
Brian Tsang70a0e6822489
diff --git a/docs/user-guides/b-kepler-gl-workflow/a-add-data-to-the-map.md b/docs/user-guides/b-kepler-gl-workflow/a-add-data-to-the-map.mdindex c6f81c90e..7a981bfbc 100644--- a/docs/user-guides/b-kepler-gl-workflow/a-add-data-to-the-map.md+++ b/docs/user-guides/b-kepler-gl-workflow/a-add-data-to-the-map.md@@ -7,7 +7,7 @@2. Choose one of two ways to add data to your map: upload a CSV/GeoJSON file or use one of Kepler.gl’s sample datasets. The sample datasets include California earthquakes, New York City taxi rides, and San Francisco elevation contour lines.-3. Kepler.gl is a pure client side app. Data lives only on your machine/browser. No information or maps is sent back up to our server.+3. Kepler.gl is a pure client side app. Data lives only on your machine/browser. No information or maps is sent back up to our server.## Upload CSV or GEOJSON Files@@ -52,10 +52,17 @@ Check out some [sample datasets](https://github.com/uber-web/kepler.gl-data) for}]}```+### Load Map Using URL++Based on the feedback that we have received, we make importing data easier by allowing users to load your map through custom URL. It currently supports URLs with file extension of `csv`, `json` and `kepler.gl.json`++In addition, this also by-passes 250mb file upload size limit which allows you to upload larger file to Kepler.++### Use Kepler.gl’s Sample Maps-The sample maps are a great option for new users to explore Kepler.gl and get a feel for how it works.+The sample maps are a great option for new users to explore Kepler.gl and get a feel for how it works.1. At the initial load prompt select “Try sample data” in the top right corner.diff --git a/docs/user-guides/b-kepler-gl-workflow/b-add-data-layers/a-adding-data-layers.md b/docs/user-guides/b-kepler-gl-workflow/b-add-data-layers/a-adding-data-layers.mdindex 05928e152..66aff3011 100644--- a/docs/user-guides/b-kepler-gl-workflow/b-add-data-layers/a-adding-data-layers.md+++ b/docs/user-guides/b-kepler-gl-workflow/b-add-data-layers/a-adding-data-layers.md@@ -8,6 +8,6 @@ Each blue dot represents the point (latitude and longitude). Layers work like pa-Learn more about the [types of layers] available in Kepler.gl.+Learn more about the [types of layers](../../c-types-of-layers.md) available in Kepler.gl.[Back to table of contents](../../a-introduction.md)diff --git a/docs/user-guides/c-types-of-layers.md b/docs/user-guides/c-types-of-layers.mdnew file mode 100644index 000000000..c9eae32d1--- /dev/null+++ b/docs/user-guides/c-types-of-layers.md@@ -0,0 +1,87 @@+# Types of Layers++## Single Feature Layers+Single feature layers renders 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.++To draw arcs, your dataset must contain the latitude and longitude of two different points for each arc.++Layer Attributes: Color/ Color Based On, Opacity, Stroke Width/ Stroke Based On, High Precision Rendering++## 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.++Layer Attributes: Color, Stroke, High Precision Rendering++## Hexbin++++Hexbin aggregates points into hexagons. The counts can be represented through color and/or height.++Layer Attributes: Color/ Color Based On, Filter by Count Percentile, Opacity, Hexagon Radius (km), Coverage (Radius), Enable Height, Elevation Scale/ Height Based On, High Precision Rendering++## Heatmap++++Heatmap is a graphical representation of data in which data values are represented as colors.++Layer Attributes: Color, Opacity, Radius, Weight++## Cluster++++Cluster layers visualize aggregated data based on a geospatial radius.++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.++Layer Attributes: Color, Radius, Label, High Precision Rendering++To 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.++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/).++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.diff --git a/docs/user-guides/c-types-of-layers/a-point.md b/docs/user-guides/c-types-of-layers/a-point.mdindex 4181ee195..d726db6da 100644--- a/docs/user-guides/c-types-of-layers/a-point.md+++ b/docs/user-guides/c-types-of-layers/a-point.md@@ -4,4 +4,28 @@Point layers draw points for a given event or object.+__Layer Attributes__+- Basic+ - Columns:+ - Latitude+ - Longitude+ - Altitude (optional)+- Fill+ - Enable fill - enabled by default+ - Single color / color based on+ - Color scale+ - Opacity+- Outline+ - Enable outline+ - Single color / color based on+ - Color scale+ - Stroke width+- Radius+ - Single radius / radius based on+ - Fixed radius to meter+- Text,+ - Font Size+ - Font Color+ - Text Anchor+[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.mdindex 64b02a23c..3679cb199 100644--- a/docs/user-guides/c-types-of-layers/j-h3.md+++ b/docs/user-guides/c-types-of-layers/j-h3.md@@ -2,8 +2,21 @@-H3 layers visualize spatial data using [Uber’s Hexagonal Hierarchical Spatial Index](https://eng.uber.com/h3/).+H3 layers visualize spatial data using [H3 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.+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.++### Naming Convention+kepler.gl __auto generates__ H3 layer from column: `hex_id`, `hexagon_id`++### Sample dataset:+hex_id | value |+|----------|:------:|+89283082c2fffff | 64 |+8928308288fffff | 73 |+89283082c07ffff | 65 |+89283082817ffff | 74 |+89283082c3bffff | 66 |+89283082883ffff | 76 |[Back to table of contents](../a-introduction.md)diff --git a/docs/user-guides/f-map-styles/1-base-map-styles.md b/docs/user-guides/f-map-styles/1-base-map-styles.mdindex 581c28091..26c80117a 100644--- a/docs/user-guides/f-map-styles/1-base-map-styles.md+++ b/docs/user-guides/f-map-styles/1-base-map-styles.md@@ -1,10 +1,20 @@# Base Map StylesOpen the __Base Map panel__ to modify the base map color scheme, imagery, and labeling.-++Open the __base map style__ drop down menu to change map color scheme and imagery. Options include:- __Dark__: dark base map with light-colored text.- __Light__: light base map with dark-colored text.+## 3D Map layer++We have integrated Mapbox 3D Building data into Kepler to enable users for 3D analysis and better visualizations. In order to enable this 3D building data layer, simply navigate to the ‘Base Map’ which is the 4th icon located under the Kepler.gl logo. Then, you are all set after clicking on to the ‘show’ button (which is an eye icon next to the 3D building layer).++Note: The Building data only displays when the map zooms into street-level. If the building data doesn’t show up, please try further zoom into the map.++++[Back to table of contents](../a-introduction.md)diff --git a/docs/user-guides/j-get-started.md b/docs/user-guides/j-get-started.mdindex c06fadac8..33a18dffc 100644--- a/docs/user-guides/j-get-started.md+++ b/docs/user-guides/j-get-started.md@@ -45,3 +45,5 @@ Read about [base map styles](./f-map-styles/1-base-map-styles.md) and [map settiSave your map as an image, export current map data, export current map as a json file to be load back into kepler.gl.Read about [Save and export](./k-save-and-export.md).++[Back to table of contents](./a-introduction.md)diff --git a/docs/user-guides/k-save-and-export.md b/docs/user-guides/k-save-and-export.mdindex c86742175..c3de881f0 100644--- a/docs/user-guides/k-save-and-export.md+++ b/docs/user-guides/k-save-and-export.md@@ -32,7 +32,7 @@ You can export the current map using two different formats. The __Export Map__ w-To save and export your current map as HTML file, click on __Export Map__ and subsequently on __Export__.+To save and export your current map as HTML file, click on __Export Map__ and subsequently on __Export__.When prompted provide your own mapbox token to be used in the newly generated file. If you don't provide a Mapbox Token,Kepler.gl will use a default one which can expire at anytime without any communication and therefore break your your existing map.@@ -50,7 +50,7 @@ In order to edit the mapbox token in your html file you simply need to perform t4. Replace the current value a new valid token. The code should now look like the following:```javascript/**- * Provide your MapBox Token+ * Provide your MapBox Token**/const MAPBOX_TOKEN = 'pk.eyJ1IjoidWJlcmRh...';```@@ -70,8 +70,10 @@ The map config includes the current layer, filter, map style and interaction set## <a href="#export-dropbox">Share Public URL (Dropbox) </a>-To export the current map into your Dropbox account, click on __Share Public Url__ and select Dropbox as your cloud storage.-Perform the authentication against Dropbox using your credentials. Once the authentication process is completed,+To export the current map into your Dropbox account, click on __Share Public Url__ and select Dropbox as your cloud storage.+Perform the authentication against Dropbox using your credentials. Once the authentication process is completed,click on __Upload__ and Kepler.gl will push your current map onto your account.At the end of the process Kepler.gl will automatically generate a permalink for your work you can share with other users.++[Back to table of contents](./a-introduction.md)