@swim/mapbox
@swim/mapbox provides @swim/map overlays for Mapbox maps. Check out the traffic map and transit map demos to see massively real-time maps in action. @swim/mapbox is part of the @swim/maps framework.
Installation
npm
For an npm-managed project, npm install @swim/mapbox
to make it a dependency.
TypeScript sources will be installed into node_modules/@swim/mapbox/main
.
Transpiled JavaScript and TypeScript definition files install into
node_modules/@swim/mapbox/lib/main
. And a pre-built UMD script can
be found in node_modules/@swim/mapbox/dist/main/swim-mapbox.js
.
Browser
Browser applications can load swim-maps.js
—which bundles the @swim/mapbox
library—along with its swim-core.js
and swim-ui.js
dependencies, directly
from the SwimOS CDN.
<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-core.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ui.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-maps.js"></script>
<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-core.min.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ui.min.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-maps.min.js"></script>
Alternatively, the standalone swim-system.js
script may be loaded
from the SwimOS CDN, which bundles @swim/mapbox 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/mapbox can be imported as an ES6 module from TypeScript and other ES6-compatible environments.
import * as mapbox from "@swim/mapbox";
CommonJS/Node.js
@swim/mapbox can also be used as a CommonJS module in Node.js applications.
var mapbox = require("@swim/mapbox");
Browser
When loaded by a web browser, the swim-mapbox.js
script adds all
@swim/mapbox library exports to the global swim
namespace.
The swim-mapbox.js
script requires that swim-core.js
and swim-ui.js
have already been loaded.
The swim-toolkit.js
script also adds all @swim/mapbox library
exports to the global swim
namespace, making it a drop-in replacement for
swim-ui.js
and swim-mapbox.js
when additional @swim/toolkit frameworks
are needed.