mirror of
https://github.com/visgl/react-map-gl.git
synced 2026-01-18 15:54:22 +00:00
55 lines
1.9 KiB
Markdown
55 lines
1.9 KiB
Markdown
# Overlays
|
|
|
|
react-map-gl provides a basic overlay API that enables applications to overlay data on top of maps.
|
|
|
|
Note that the built-in overlays are intended to provide basic functionality only. For more feature rich and performant data visualization overlay use cases, consider using [deck.gl](deck.gl) and/or mapbox styles.
|
|
|
|
|
|
## Example
|
|
|
|
```js
|
|
import {SVGOverlay} from 'react-map-gl';
|
|
|
|
function redraw({project}) {
|
|
const [cx, cy] = project([-122, 37]);
|
|
return <circle cx={cx} cy={cy} r={4} fill="blue" />;
|
|
}
|
|
|
|
<MapGL {...viewport}>
|
|
<SVGOverlay redraw={redraw} />
|
|
</MapGL>
|
|
```
|
|
|
|
|
|
## Built-in Overlays
|
|
|
|
Built-in overlays are: `SVGOverlay`, `HTMLOverlay`, and `CanvasOverlay`. They are imported using
|
|
```
|
|
import {SVGOverlay, HTMLOverlay, CanvasOverlay} from 'react-map-gl';
|
|
```
|
|
|
|
## Example Overlays
|
|
|
|
There are a couple of [additional overlays](https://github.com/uber/react-map-gl/tree/master/examples/additional-overlays) in the examples folder that can be copied into applications `ScatterplotOverlay`, `DraggablePointsOverlay`, `ChoroplethOverlay`.
|
|
|
|
|
|
### Third-party Overlays
|
|
|
|
Third party overlays can also be created. For example, the [heatmap-overlay](https://github.com/vicapow/react-map-gl-heatmap-overlay) uses [webgl-heatmap](https://github.com/vicapow/webgl-heatmap) to create geographic heatmaps.
|
|
|
|
<img width=200 src="https://cloud.githubusercontent.com/assets/499192/11028150/33f34640-86bc-11e5-9678-3fa1798394d5.gif" />
|
|
|
|
```js
|
|
import HeatmapOverlay from 'react-map-gl-heatmap-overlay';
|
|
import cities from 'example-cities';
|
|
|
|
<MapGL {...viewport}>
|
|
<HeatmapOverlay locations={cities} {...viewport} />
|
|
</MapGL>
|
|
```
|
|
|
|
Want to create and share your own overlay? Check the [examples/additional-overlays](https://github.com/uber/react-map-gl/tree/master/examples/additional-overlays) folder for examples.
|
|
|
|
## Remarks
|
|
* In `react-map-gl` v1, overlays were exported directly from 'react-map-gl'.
|