[Bug] `Layer.getBounds()` type is not compatible with `WebMercatorViewport.fitBounds()`
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 14.6k
- Forks
- 2.3k
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 42
Description
Description
If one looks at the the fitBounds docs, the example usage is the following:
const [initialViewState, setInitialViewState] = useState<MapViewState>({
longitude: -100,
latitude: 40,
zoom: 4
});
const [hasLoaded, setHasLoaded] = useState<boolean>(false);
const layer = new ScatterplotLayer({...});
const onAfterRender = () => {
if (!hasLoaded && layer.isLoaded) {
setHasLoaded(true);
const viewport = layer.context.viewport as WebMercatorViewport;
const {longitude, latitude, zoom} = viewport.fitBounds(layer.getBounds());
setInitialViewState({longitude, latitude, zoom});
}
};
However, the return type of ScatterPlotLayer.getBounds() will be [number[], number[]] | null, while WebMercatorViewport.fitBounds takes in a [[number, number], [number, number]]. The example code fails to type check as a result of this issue both because layer.getBounds() could return null and because number[] cannot be coerced to [number, number]. The first issue is easy to fix with a null check, but the second requires either an as cast or some more arduous checks.
Flavors
- Script tag
- React
- Python/Jupyter notebook
- MapboxOverlay
- GoogleMapsOverlay
- CartoLayer
- ArcGIS
Expected Behavior
If the output of Layer.getBounds() is truthy, its type should be accepted in WebMercatorView.fitBounds().
Steps to Reproduce
Follow the instructions on the fitBounds() docs to set up a Deck.GL scene.
Environment
- Framework version: 8.9.6
- Browser: Chrome
- OS: MacOs
Logs
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the TypeScript declarations for Layer.getBounds() and WebMercatorViewport.fitBounds(), using the fitBounds documentation example as the reproduction. Check the non-null getBounds() result and verify that its tuple type is accepted by fitBounds without casts or element-by-element checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100