@swim/mapping

@swim/mapping implements functional maps, interpolators, and scales. @swim/mapping is part of the @swim/core framework.

Installation

npm

For an npm-managed project, npm install @swim/mapping to make it a dependency. TypeScript sources will be installed into node_modules/@swim/mapping/main. Transpiled JavaScript and TypeScript definition files install into node_modules/@swim/mapping/lib/main. And a pre-built UMD script can be found in node_modules/@swim/mapping/dist/main/swim-mapping.js.

Browser

Browser applications can load swim-core.js, which comes bundled with the @swim/mapping 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/mapping 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/mapping can be imported as an ES6 module from TypeScript and other ES6-compatible environments.

import * as mapping from "@swim/mapping";

CommonJS/Node.js

@swim/mapping can also be used as a CommonJS module in Node.js applications.

var mapping = require("@swim/mapping");

Browser

When loaded by a web browser, the swim-core.js script adds all @swim/mapping library exports to the global swim namespace.

The swim-system.js script also adds all @swim/mapping library exports to the global swim namespace, making it a drop-in replacement for swim-core.js when additional @swim/system libraries are needed.