@developmentseed/deck.gl-raster 0.1.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Development Seed
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,80 @@
1
+ # @developmentseed/deck.gl-raster
2
+
3
+ GPU-accelerated COG and Zarr visualization in deck.gl
4
+
5
+ ## Features
6
+
7
+ - πŸš€ High-performance raster visualization using WebGL
8
+ - πŸ—ΊοΈ Support for Cloud Optimized GeoTIFF (COG)
9
+ - πŸ“Š Support for Zarr format
10
+ - 🎨 Customizable rendering and color mapping
11
+ - πŸ“¦ Modern ESM package for JavaScript and TypeScript
12
+
13
+ ## Installation
14
+
15
+ ```bash
16
+ npm install @developmentseed/deck.gl-raster
17
+ ```
18
+
19
+ ## Usage
20
+
21
+ ```typescript
22
+ import { RasterLayer } from '@developmentseed/deck.gl-raster';
23
+ import { Deck } from '@deck.gl/core';
24
+
25
+ const layer = new RasterLayer({
26
+ id: 'raster-layer',
27
+ data: 'https://example.com/data.tif',
28
+ bounds: [-122.5, 37.7, -122.3, 37.9],
29
+ });
30
+
31
+ new Deck({
32
+ initialViewState: {
33
+ longitude: -122.4,
34
+ latitude: 37.8,
35
+ zoom: 11,
36
+ },
37
+ controller: true,
38
+ layers: [layer],
39
+ });
40
+ ```
41
+
42
+ ## Development
43
+
44
+ ```bash
45
+ # Install dependencies
46
+ npm install
47
+
48
+ # Build the library
49
+ npm run build
50
+
51
+ # Run tests
52
+ npm test
53
+
54
+ # Run tests in watch mode
55
+ npm run test:watch
56
+
57
+ # Lint code
58
+ npm run lint
59
+
60
+ # Format code
61
+ npm run format
62
+
63
+ # Type check
64
+ npm run typecheck
65
+ ```
66
+
67
+ ## API Reference
68
+
69
+ ### RasterLayer
70
+
71
+ A deck.gl layer for rendering raster data from GeoTIFF and Zarr sources.
72
+
73
+ #### Props
74
+
75
+ - `data` (string | URL): URL to the raster data source
76
+ - `bounds` ([number, number, number, number]): Bounding box as [minLon, minLat, maxLon, maxLat]
77
+
78
+ ## License
79
+
80
+ MIT Β© Development Seed