@swim/leaflet provides @swim/map overlays for Leaflet maps. Check out the traffic map and transit map demos to see massively real-time maps in action. @swim/leaflet is part of the @swim/maps framework.
For an npm-managed project,
npm install @swim/leaflet to make it a dependency.
TypeScript sources will be installed into
node_modules/@swim/leaflet/lib/main. And a pre-built UMD script can
be found in
Browser applications can load
swim-maps.js—which bundles the @swim/leaflet
library—along with its
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/leaflet together with all other
<!-- 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>
@swim/leaflet can be imported as an ES6 module from TypeScript and other ES6-compatible environments.
import * as leaflet from "@swim/leaflet";
@swim/leaflet can also be used as a CommonJS module in Node.js applications.
var leaflet = require("@swim/leaflet");
When loaded by a web browser, the
swim-leaflet.js script adds all
@swim/leaflet library exports to the global
swim-leaflet.js script requires that
have already been loaded.
swim-toolkit.js script also adds all @swim/leaflet library
exports to the global
swim namespace, making it a drop-in replacement for
swim-leaflet.js when additional @swim/toolkit frameworks
Generated using TypeDoc