@swim/geo
@swim/geo implements geospatial coordinate, projection, and geometry types. @swim/geo is part of the @swim/core framework.
Installation
npm
For an npm-managed project, npm install @swim/geo
to make it a dependency.
TypeScript sources will be installed into node_modules/@swim/geo/main
.
Transpiled JavaScript and TypeScript definition files install into
node_modules/@swim/geo/lib/main
. And a pre-built UMD script can
be found in node_modules/@swim/geo/dist/main/swim-geo.js
.
Browser
Browser applications can load swim-core.js
, which comes bundled with the
@swim/geo library, directly from the SwimOS CDN.
<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-core.js"></script>
<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-core.min.js"></script>
Alternatively, the standalone swim-system.js
script may be loaded
from the SwimOS CDN, which bundles @swim/geo together with all other
@swim/system
libraries.
<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-system.js"></script>
<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-system.min.js"></script>
Usage
ES6/TypeScript
@swim/geo can be imported as an ES6 module from TypeScript and other ES6-compatible environments.
import * as geo from "@swim/geo";
CommonJS/Node.js
@swim/geo can also be used as a CommonJS module in Node.js applications.
var geo = require("@swim/geo");
Browser
When loaded by a web browser, the swim-core.js
script adds all
@swim/geo library exports to the global swim
namespace.
The swim-system.js
script also adds all @swim/geo library exports
to the global swim
namespace, making it a drop-in replacement for
swim-core.js
when additional @swim/system libraries are needed.