@swim/graphics implements canvas graphics views, with procedurally animated
shapes, and procedurally styled typesetters. @swim/graphics is part of the
@swim/ui framework.
For an npm-managed project, npm install @swim/graphics to make it a dependency.
TypeScript sources will be installed into node_modules/@swim/graphics/main.
Transpiled JavaScript and TypeScript definition files install into
node_modules/@swim/graphics/lib/main. And a pre-built UMD script can
be found in node_modules/@swim/graphics/dist/main/swim-graphics.js.
Browser applications can load swim-ui.js—which bundles the @swim/graphics
library—along with its swim-core.js dependency, directly from the SwimOS CDN.
<!-- Development --><scriptsrc="https://cdn.swimos.org/js/latest/swim-core.js"></script><scriptsrc="https://cdn.swimos.org/js/latest/swim-ui.js"></script><!-- Production --><scriptsrc="https://cdn.swimos.org/js/latest/swim-core.min.js"></script><scriptsrc="https://cdn.swimos.org/js/latest/swim-ui.min.js"></script>
Alternatively, the swim-toolkit.js script may be loaded, along with its
swim-system.js dependency, from the SwimOS CDN. The swim-toolkit.js
script bundles @swim/graphics together with all other
@swim/toolkit
frameworks.
<!-- Development --><scriptsrc="https://cdn.swimos.org/js/latest/swim-system.js"></script><scriptsrc="https://cdn.swimos.org/js/latest/swim-toolkit.js"></script><!-- Production --><scriptsrc="https://cdn.swimos.org/js/latest/swim-system.min.js"></script><scriptsrc="https://cdn.swimos.org/js/latest/swim-toolkit.min.js"></script>
When loaded by a web browser, the swim-ui.js script adds all
@swim/graphics library exports to the global swim namespace. The
swim-ui.js script requires that swim-core.js has already been loaded.
The swim-toolkit.js script also adds all @swim/graphics library
exports to the global swim namespace, making it a drop-in replacement for
swim-ui.js and swim-graphics.js when additional @swim/toolkit frameworks
are needed.
@swim/graphics
@swim/graphics implements canvas graphics views, with procedurally animated shapes, and procedurally styled typesetters. @swim/graphics is part of the @swim/ui framework.
Installation
npm
For an npm-managed project,
npm install @swim/graphicsto make it a dependency. TypeScript sources will be installed intonode_modules/@swim/graphics/main. Transpiled JavaScript and TypeScript definition files install intonode_modules/@swim/graphics/lib/main. And a pre-built UMD script can be found innode_modules/@swim/graphics/dist/main/swim-graphics.js.Browser
Browser applications can load
swim-ui.js—which bundles the @swim/graphics library—along with itsswim-core.jsdependency, directly from the SwimOS CDN.Alternatively, the
swim-toolkit.jsscript may be loaded, along with itsswim-system.jsdependency, from the SwimOS CDN. Theswim-toolkit.jsscript bundles @swim/graphics together with all other @swim/toolkit frameworks.Usage
ES6/TypeScript
@swim/graphics can be imported as an ES6 module from TypeScript and other ES6-compatible environments.
CommonJS/Node.js
@swim/graphics can also be used as a CommonJS module in Node.js applications.
Browser
When loaded by a web browser, the
swim-ui.jsscript adds all @swim/graphics library exports to the globalswimnamespace. Theswim-ui.jsscript requires thatswim-core.jshas already been loaded.The
swim-toolkit.jsscript also adds all @swim/graphics library exports to the globalswimnamespace, making it a drop-in replacement forswim-ui.jsandswim-graphics.jswhen additional @swim/toolkit frameworks are needed.