0.5.0 • Published 6 years ago

wkx v0.5.0

Weekly downloads
911,518
License
MIT
Repository
github
Last release
6 years ago

wkx Build Status Coverage Status

A WKT/WKB/EWKT/EWKB/TWKB/GeoJSON parser and serializer with support for

  • Point
  • LineString
  • Polygon
  • MultiPoint
  • MultiLineString
  • MultiPolygon
  • GeometryCollection

Examples

The following examples show you how to work with wkx.

var wkx = require('wkx');

//Parsing a WKT string
var geometry = wkx.Geometry.parse('POINT(1 2)');

//Parsing an EWKT string
var geometry = wkx.Geometry.parse('SRID=4326;POINT(1 2)');

//Parsing a node Buffer containing a WKB object
var geometry = wkx.Geometry.parse(wkbBuffer);

//Parsing a node Buffer containing an EWKB object
var geometry = wkx.Geometry.parse(ewkbBuffer);

//Parsing a node Buffer containing a TWKB object
var geometry = wkx.Geometry.parseTwkb(twkbBuffer);

//Parsing a GeoJSON object
var geometry = wkx.Geometry.parseGeoJSON({ type: 'Point', coordinates: [1, 2] });

//Serializing a Point geometry to WKT
var wktString = new wkx.Point(1, 2).toWkt();

//Serializing a Point geometry to WKB
var wkbBuffer = new wkx.Point(1, 2).toWkb();

//Serializing a Point geometry to EWKT
var ewktString = new wkx.Point(1, 2, undefined, undefined, 4326).toEwkt();

//Serializing a Point geometry to EWKB
var ewkbBuffer = new wkx.Point(1, 2, undefined, undefined, 4326).toEwkb();

//Serializing a Point geometry to TWKB
var twkbBuffer = new wkx.Point(1, 2).toTwkb();

//Serializing a Point geometry to GeoJSON
var geoJSONObject = new wkx.Point(1, 2).toGeoJSON();

Browser

To use wkx in a webpage, simply copy a built browser version from dist/ into your project, and use a script tag to include it:

<script src="wkx.js"></script>

If you use browserify for your project, you can simply npm install wkx --save, and just require wkx as usual in your code.


Regardless of which of the preceeding options you choose, using wkx in the browser will look the same:

var wkx = require('wkx');

var geometry = wkx.Geometry.parse('POINT(1 2)');

console.log(geometry.toGeoJSON());

In addition to the wkx module, the browser versions also export buffer, which is useful for parsing WKB:

var Buffer = require('buffer').Buffer;
var wkx = require('wkx');

var wkbBuffer = new Buffer('0101000000000000000000f03f0000000000000040', 'hex');
var geometry = wkx.Geometry.parse(wkbBuffer);

console.log(geometry.toGeoJSON());
common-ui-controlscustom-data-layermdt-libaccredokonekto-gisepcs-empty-templateweatherlo@infinitebrahmanuniverse/nolb-wk@everything-registry/sub-chunk-3155@zcut/sequelizeexpandify-domaintamidi-sequelize-corewhitehatjr-sequelizewhitehatjr-sequelize-ormwkt-io-tsw3c-dcatwi-sequelizeteapackage-tatespoorman297test_tabelvra-ui-componentsveirryau-sequelizevandelayvandelay-util@cond/sequelize@cannypack/sequelizejonmagic-sequelizekidal-sequelizehw9leon-sequelizemake-geo-jsonmapstreamerkysely-postgismatterapp-sequelize@weamd/sequelize@vaibhav.singhal/sequelize@ttungbmt/geo@undp-data/geohub-cli@typed-query-builder/pgsql@tonysusi/vapid@up24/sequelize@vlci/cdmalcaldia@vlci/cdmalcaldia_mobilitat@vlci/cdmciutat@vlci/cdmportada@vlci/vlcishared@yaga/etl@yunser/sequelizeadvanced-sequelizeashish-sequelizeapi-sitna@abeai/sequelize-native-promises@acrossthecloud/dbgeo@abradley2/sequelize@afetcan/api@afetcan/server@creditiq/sequelize@_henriquewilson/expandify-domainmyob-exo-apisequelize-working-poolstrength-uisse-ui-controlssse-axios-interceptorsolr-query-makertransform-to-geojsonto-geojson-stream@blackamda/sequelize@blocksx/bulk@bluaxolotl/sequelize@ace5040/demoxysequelizeway-nodewebdwg-libraryts-sequelize@kwanhs/sequelize-fork@lambda-platform/lambda-builder@lambda-platform/lambda-vue@lambda-platform/public-vue-builder@mphelps/sequelize@mphelps/sequelize-fork@ngageoint/geopackage@ngageoint/geopackage-csv-js@ngageoint/mage.service@prosperitybot/database@sandbags-protocol/sequelize@sap/hrtt-core-vscode@pathcheck/data-layer@parmais/sequelize@rematter/sequelize@rickbergfalk/sequelizemingo-exponex-sequelizesequelize-websqlsequelize-with-clickhousesequelize-with-spatialitesequelize-wasmsequelize-webpacksequelize_mbasequelize_sunsoftsequelize_zzbsequelize-clickhouse-client
0.5.0

6 years ago

0.4.8

6 years ago

0.4.7

6 years ago

0.4.6

7 years ago

0.4.5

7 years ago

0.4.4

8 years ago

0.4.3

8 years ago

0.4.2

8 years ago

0.4.1

9 years ago

0.4.0

9 years ago

0.3.0

9 years ago

0.2.0

10 years ago

0.1.0

10 years ago

0.0.7

10 years ago

0.0.6

10 years ago

0.0.5

11 years ago

0.0.3

11 years ago

0.0.2

11 years ago