Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danmarshall/deckgl-typings
TypeScript declaration files for deck.gl
https://github.com/danmarshall/deckgl-typings
Last synced: about 5 hours ago
JSON representation
TypeScript declaration files for deck.gl
- Host: GitHub
- URL: https://github.com/danmarshall/deckgl-typings
- Owner: danmarshall
- License: mit
- Created: 2018-06-21T01:58:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-25T02:32:07.000Z (over 1 year ago)
- Last Synced: 2024-10-29T20:55:53.629Z (8 days ago)
- Language: JavaScript
- Size: 883 KB
- Stars: 107
- Watchers: 4
- Forks: 69
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# deckgl-typings
TypeScript declaration files for [deck.gl](https://deck.gl/#/documentation/)
This is a work in progress - see the [issues list](https://github.com/danmarshall/deckgl-typings/issues)
```
npm install @danmarshall/deckgl-typings
```
These will automatically appear in your projects `node_modules/@types` folder, thanks to [indefinitely-typed](https://github.com/danmarshall/indefinitely-typed#readme).
Then it is possible to link the mappings in your project so typescript can find them (since the project is not in @types yet).
Create a new file like `deckgl.d.ts` (although it could be named anything ending in `.d.ts`) in your `src/` directory with the following code:
```
import * as DeckTypings from "@danmarshall/deckgl-typings"
declare module "deck.gl" {
export namespace DeckTypings {}
}
```
## Version mapping
| deck.gl version | deckgl-typings version |
| --------------- | ---------------------- |
| 5.x.x | 1.x.x |
| 6.x.x | 2.x.x |
| 7.x.x | 3.x.x |
| 8.x.x | 4.x.x |
## Known issues
These typings are now v4 which targets deck.gl v8. The following issues are changes to v8 from deck.gl v7 which have not been added to these typings:
- [ ] [It is now possible to replace a layer's accessors with binary data attributes.](https://github.com/uber/deck.gl/blob/master/docs/whats-new.md#better-binary-data-support)
- [ ] [GPU filtering for layers](https://github.com/uber/deck.gl/blob/master/docs/whats-new.md#gpu-data-filter-in-aggregation-layers) - Adds a [getFilterValue](https://github.com/uber/deck.gl/blob/master/docs/api-reference/extensions/data-filter-extension.md#getfiltervalue-function) to some layers.
- [ ] [Optional specifying the \_framebuffer prop of Deck.](https://github.com/uber/deck.gl/blob/master/docs/whats-new.md#other-new-features-and-improvements)
- [ ] [Pick a 3d surface point in the scene](https://github.com/uber/deck.gl/blob/master/docs/whats-new.md#other-new-features-and-improvements) by passing unproject3D: true to deck.pickObject or deck.pickMultipleObjects.
- [ ] ArcLayer supports drawing arcs between two 3D positions
- [ ] 64-bit positions are now 3D instead of 2D
- [ ] FirstPersonView now supports pitch
- [ ] FlyToInterpolator now supports duration: 'auto'.
## 🙏
Thanks to the community of contributors for adding many typings over the last few months. Please feel free to continue fixes for the above or any other issues. 🥂