Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[chore] Update the Screenshot Image in Readme (#3171)
Indranil Halder0850ef2eb018
diff --git a/README.md b/README.mdindex 665086c18..6d383d7f5 100644--- a/README.md+++ b/README.md@@ -29,7 +29,7 @@[<img width="120" alt="Kepler.gl" src="https://d1a3f4spazzrp4.cloudfront.net/kepler.gl/website/icons/kepler.gl-logo.png">](http://kepler.gl)-[<img width="600" alt="Kepler.gl Demo" src="https://eng.uber.com/wp-content/uploads/2018/05/image4-3-768x493.png">](http://kepler.gl/#/demo)+[<img width="600" alt="Kepler.gl Demo" src="./screenshots/screenshot.png">](https://kepler.gl/demo)[Kepler.gl][web] is a data-agnostic, high-performance web-based application for visual exploration of large-scale geolocation data sets. Built on top of [MapLibre GL](https://maplibre.org/) and [deck.gl](https://deck.gl/), kepler.gl can render millions of points representing thousands of trips and perform spatial aggregations on the fly.@@ -151,26 +151,26 @@ const Map = props => (### Props-| Prop Name | Type | Default Value | Description |-|-------------------------------|-------------|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-| `id` | String | `map` | The unique identifier for the KeplerGl instance. Required when multiple KeplerGl instances exist. It maps to the state in the reducer (e.g. component with id `foo` can be found in`state.keplerGl.foo`). |-| `mapboxApiAccessToken` | String | `undefined` | API token for Mapbox, used for rendering base maps. Create a free token at [Mapbox](https://www.mapbox.com). |-| `getState` | Function | `state => state.keplerGl` | Function that specifies the path to the root KeplerGl state in the reducer. |-| `width` | Number | `800` | The width of the KeplerGl UI in pixels. |-| `height` | Number | `800` | The height of the KeplerGl UI in pixels. |-| `appName` | String | `Kepler.Gl` | The app name displayed in the side panel header. |-| `version` | String | `v1.0` | The version displayed in the side panel header. |-| `onSaveMap` | Function | `undefined` | A function called when the "Save Map URL" in side panel header is clicked. |-| `onViewStateChange` | Function | `undefined` | Triggered when the map viewport is updated. Receives `viewState` parameter with updated values like longitude, latitude, zoom, etc. |-| `getMapboxRef(mapbox, index)` | Function | `undefined` | Called when `KeplerGl` adds or removes a MapContainer with an inner Mapbox map. `mapbox` is a `MapRef` when added, or `null` when removed. `index` is `0` for the first map and `1` for the second map in a split view. |-| `actions` | Object | `{}` | Custom action creators to override the default KeplerGl action creators. Only use custom action when you want to modify action payload. |-| `mint` | Boolean | `true` | Determines whether to load a fresh empty state when mounted. When `false`, the state persists across remounts. Useful for modal use cases. |-| `theme` | Object/String| `null` | Set to `"dark"`, `"light"`, or `"base"`, or pass a theme object to customize KeplerGl’s style. |-| `mapboxApiUrl` | String | `https://api.mapbox.com` | The Mapbox API URL if you are using a custom Mapbox tile server. |-| `mapStylesReplaceDefault` | Boolean | `false` | Set to `true` to replace default map styles with custom ones. (see ```mapStyles``` prop) |-| `mapStyles` | Array | `[]` | An array of [custom map styles](#example-custom-map-style) for the map style selection panel. Styles replace the default ones if `mapStylesReplaceDefault` is `true`. |-| `initialUiState` | Object | `undefined` | The initial UI state applied to the `uiState` reducer. |-| `localeMessages` | Object | `undefined` | Used to modify or add new translations. Read more about [Localization][localization]. |+| Prop Name | Type | Default Value | Description |+| ----------------------------- | ------------- | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |+| `id` | String | `map` | The unique identifier for the KeplerGl instance. Required when multiple KeplerGl instances exist. It maps to the state in the reducer (e.g. component with id `foo` can be found in`state.keplerGl.foo`). |+| `mapboxApiAccessToken` | String | `undefined` | API token for Mapbox, used for rendering base maps. Create a free token at [Mapbox](https://www.mapbox.com). |+| `getState` | Function | `state => state.keplerGl` | Function that specifies the path to the root KeplerGl state in the reducer. |+| `width` | Number | `800` | The width of the KeplerGl UI in pixels. |+| `height` | Number | `800` | The height of the KeplerGl UI in pixels. |+| `appName` | String | `Kepler.Gl` | The app name displayed in the side panel header. |+| `version` | String | `v1.0` | The version displayed in the side panel header. |+| `onSaveMap` | Function | `undefined` | A function called when the "Save Map URL" in side panel header is clicked. |+| `onViewStateChange` | Function | `undefined` | Triggered when the map viewport is updated. Receives `viewState` parameter with updated values like longitude, latitude, zoom, etc. |+| `getMapboxRef(mapbox, index)` | Function | `undefined` | Called when `KeplerGl` adds or removes a MapContainer with an inner Mapbox map. `mapbox` is a `MapRef` when added, or `null` when removed. `index` is `0` for the first map and `1` for the second map in a split view. |+| `actions` | Object | `{}` | Custom action creators to override the default KeplerGl action creators. Only use custom action when you want to modify action payload. |+| `mint` | Boolean | `true` | Determines whether to load a fresh empty state when mounted. When `false`, the state persists across remounts. Useful for modal use cases. |+| `theme` | Object/String | `null` | Set to `"dark"`, `"light"`, or `"base"`, or pass a theme object to customize KeplerGl’s style. |+| `mapboxApiUrl` | String | `https://api.mapbox.com` | The Mapbox API URL if you are using a custom Mapbox tile server. |+| `mapStylesReplaceDefault` | Boolean | `false` | Set to `true` to replace default map styles with custom ones. (see `mapStyles` prop) |+| `mapStyles` | Array | `[]` | An array of [custom map styles](#example-custom-map-style) for the map style selection panel. Styles replace the default ones if `mapStylesReplaceDefault` is `true`. |+| `initialUiState` | Object | `undefined` | The initial UI state applied to the `uiState` reducer. |+| `localeMessages` | Object | `undefined` | Used to modify or add new translations. Read more about [Localization][localization]. |#### Example Custom Map Stylediff --git a/screenshots/screenshot.png b/screenshots/screenshot.pngnew file mode 100644index 000000000..e6af06f74Binary files /dev/null and b/screenshots/screenshot.png differ