ngageoint / simple-features-wkb-js

Simple Features WKB Javascript

Simple Features WKB Javascript

Simple Features Well Known Binary Lib

The Simple Features Libraries were developed at the National Geospatial-Intelligence Agency (NGA) in collaboration with BIT Systems. The government has "unlimited rights" and is releasing this software to increase the impact of government investments by providing developers with the opportunity to take things in new directions. The software use, modification, and distribution rights are stipulated within the MIT license.

Pull Requests

If you'd like to contribute to this project, please make a pull request. We'll review the pull request and discuss the changes. All pull request contributions to this project will be released under the MIT license.

Software source code previously released under an open source license and then modified by NGA staff is considered a "joint work" (see 17 USC § 101); it is partially copyrighted, partially public domain, and as a whole is protected by the copyrights of the non-government authors and must be released according to the terms of the original open source license.

About

Simple Features WKB is a Javascript library for reading and writing Simple Feature Geometries to and from Well-Known Binary.

Usage

View the latest JS Docs

Browser Usage

<script src="/path/to/simple-features-wkb-js/dist/sf-wkb.min.js"></script>

- Read

const { GeometryReader } = window.SimpleFeaturesWKB;

//const buffer = ...
const geometry = GeometryReader.readGeometry(bytes);
const geometryType = geometry.getGeometryType();

- Write

const { GeometryWriter } = window.SimpleFeaturesWKB;
// const geometry = ...

const buffer = GeometryWriter.writeGeometry(geometry);

Node Usage

Pull from NPM

npm install --save simple-features-wkb-js

- Read

const { GeometryReader } = require("@ngageoint/simple-features-wkb-js");

//const buffer = ...
const geometry = GeometryReader.readGeometry(bytes);
const geometryType = geometry.getGeometryType();

- Write

const { GeometryWriter } = require("@ngageoint/simple-features-wkb-js");

// const geometry = ...
const buffer = GeometryWriter.writeGeometry(geometry);

Build

Build this repository using Node.js:

npm install
npm run build

simple-features-wkb-js's Issues

Readme installation script package name

Hi, thanks for the library.

It seems the installation script should have "@ngageoint/simple-features-wkb-js instead of just simple-features-wkb-js

simple-features-wkb-js/README.md

Line 48 in b2f908f

npm install --save simple-features-wkb-js