Skip to content

Commit

Permalink
docs: update overview.md (#9330)
Browse files Browse the repository at this point in the history
  • Loading branch information
eltociear authored and felixpalmer committed Jan 15, 2025
1 parent e2b4f06 commit f7006c3
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/api-reference/mapbox/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ npm install @deck.gl/mapbox
import {MapboxOverlay} from '@deck.gl/mapbox';
```

### Camera Syncronization between deck.gl and Mapbox
### Camera Synchronization between deck.gl and Mapbox

This module keeps a deck.gl `MapView` in sync with the mapbox-gl camera so that the base map and deck layers are always geospactially aligned. Some `Deck` props, such as `viewState`, are ignored or have different behavior. See `MapboxOverlay` constructor notes. Also, some camera features are unable to be fully synchronized due to mapbox-gl API limitations, see [limitations](#limitations).

Expand Down Expand Up @@ -83,4 +83,4 @@ If you're using deck.gl in a React or Scripting environment, you just want the b
* When using deck.gl as Mapbox layers or controls, `Deck` only receives a subset of user inputs delegated by `Map`. Therefore, certain interactive callbacks like `onDrag`, `onInteractionStateChange` are not available.
* Mapbox/MapLibre's terrain features are partially supported. When a terrain is used, the camera of deck.gl and the base map should synchronize, however the deck.gl data with z=0 are rendered at the sea level and not aligned with the terrain surface.
* Only Mercator projection is supported. Mapbox adaptive projection is not supported as their API doesn't expose the projection used.
* The `position` property in `viewState` has no equivalent in mapbox-gl.
* The `position` property in `viewState` has no equivalent in mapbox-gl.

0 comments on commit f7006c3

Please sign in to comment.