Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace @swim/shape

@swim/shape

package documentation chat

@swim/shape implements canvas shape views, with animated geometry and style properties. @swim/shape is part of the @swim/ui framework.

Installation

npm

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

Browser

Browser applications can load swim-ui.js—which bundles the @swim/shape library—along with its swim-core.js dependency, 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>

<!-- 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>

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/shape together with all other @swim/toolkit frameworks.

<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-system.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-toolkit.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-system.min.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-toolkit.min.js"></script>

Usage

ES6/TypeScript

@swim/shape can be imported as an ES6 module from TypeScript and other ES6-compatible environments.

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

CommonJS/Node.js

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

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

Browser

When loaded by a web browser, the swim-ui.js script adds all @swim/shape 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/shape library exports to the global swim namespace, making it a drop-in replacement for swim-ui.js and swim-shape.js when additional @swim/toolkit frameworks are needed.

Index

Type aliases

AnyArc

AnyArc: Arc | ArcInit

AnyArcView

AnyArcView: ArcView | Arc | ArcViewInit

AnyRect

AnyRect: Rect | RectInit

AnyRectView

AnyRectView: RectView | Rect | RectViewInit