-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
3 changed files
with
32 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Changelog | ||
|
||
## [0.1.0] - 2023-11-22 | ||
|
||
- Initial release. | ||
- Support for: | ||
- Polygon area and signed area | ||
- Polygon winding order | ||
- Polygon triangulation | ||
- Coordinate reprojection | ||
- Total bounds |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,21 @@ | ||
# `@geoarrow/geoarrow-js` | ||
# `geoarrow-js` | ||
|
||
TypeScript implementation of GeoArrow. | ||
A minimal TypeScript implementation of [GeoArrow](https://geoarrow.org/). | ||
|
||
This builds on top of [Arrow JS](https://arrow.apache.org/docs/js/index.html) to provide type definitions for geoarrow `Data` and `Vector` objects, as well as selected geometry operations. | ||
|
||
It also complements the work-in-progress `geoarrow-wasm`, which will provide Rust-based operations on GeoArrow memory. | ||
|
||
## Spatial operations | ||
|
||
Only spatial operations that are implemented on binary representations of geometry will be added to this repo. | ||
|
||
This means that `geoarrow-js` will not, say, use algorithms from [Turf](https://turfjs.org/), because that would require conversions to and from GeoJSON for the operation. | ||
|
||
### Implemented algorithms: | ||
|
||
- Polygon area and signed area (via [`@math.gl/polygon`](https://github.com/visgl/math.gl)) | ||
- Polygon winding order (via [`@math.gl/polygon`](https://github.com/visgl/math.gl)) | ||
- Polygon triangulation (via [`@math.gl/polygon`](https://github.com/visgl/math.gl), a fork of [`earcut`](https://github.com/mapbox/earcut).) | ||
- Coordinate reprojection (via [`proj4`](https://github.com/proj4js/proj4js)) | ||
- Total bounds (the bounding box of an array of geometries). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters