# vandal

> A small wrapper built around canvas api

Latest version **0.1.0** (published 2014-09-26) · 0 weekly downloads

## Install

```sh
npm install vandal
pnpm add vandal
yarn add vandal
bun add vandal
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2014-09-26 |
| First published | 2014-09-18 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Otter the Cat |
| Maintainers | otterthecat |
| Keywords | canvas, client, browserify-compatible, otc |

## Links

- npm: https://www.npmjs.com/package/vandal
- Repository: git@github.com:otterthecat/vandal
- Homepage: https://github.com/otterthecat/vandal
- Issues: https://github.com/otterthecat/vandal/issues
- npm.io page: https://npm.io/package/vandal

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2014-09-26
- 0.0.1 — 2014-09-18

## README

# Vandal
A wrapper to draw primitive shapes with canvas

## API
Vandal's API allows the user to chain multiple calls -typically off the `.draw()` function - to create the desired behavior.
For instance you can make repeated calls from `.draw()` with each passing an argument stating what to do or which options to take:

```javascript
var vandal = new Vandal();
var canvas = document.querySelector('canvas');

vandal.use(canvas).draw('pallete')({fillStyle : '#ff0033'})('shape')('rectangle')(10, 10, 100, 200);
```

### #use(canvasObj)
`canvasObj` being a canvas element.
This will be used throughout the use of the vandal instance.

### #draw(string/obj)
The first call of this function should tell the vandal instance which object you want to start using,
`pallete` or `shape'.

 * *pallete*

	Calling `.draw()` with this argment will return a function to set canvas style properties.
	Simply pass an object with the name/values of the properties you wish to use.

	Passing a style object will return `.draw()` again, to either set/reset new styles or create a shape.

 * *shape*

	Calling `.draw()` with the "shape" argument will return a function that allows the user to choose a shape
	to render on the canvas. Current options are "rectangle", "circle", "triangle", "line", and "text".

	After passing a shape, a new function is returned that, depending on shape chosen, will require arguments
	for positioning and dimensions in order to finally draw upon the canvas.

	* rectangle(Xpos, Ypos, Width, Height)

	* circle(Xpos, Ypos, Radius)

	* triangle(Obj{x,y}, Obj{x,y}, Obj{x,y})

	* line(Obj{x,y} Obj{x,y})

		minimum 2 Objects with x & y properties, no hard maximum.

	* text(String, Xpos, Ypos)

After passing the plot argument(s), the vandal instance is returned, and the cycle can continue.
The examples folder shows each shape being created.

### #clear()
Clears the canvas, typically to prepare for redraw.

### #animate(callback)
Repeats callback function using `requestAnimationKeyframe()`.
This function will take care of clearing the canvas and repeated calls of `requestAnimationFrame`.
The callback function is passed three arguments:

 * *scope* -  this would be the vandal instance that made the call.
 * *increment* - an integer, starting with `1` that is a reference the number of times an animation frame is called
 * *timestamp* - the timestamp passed from `requestAnimationKeyframe()`

The animation will repeat until/unless the callback returns a boolean value of `false`.
For instance, if you wanted to end the animation after a line is 100 pixels long, you would return `true`
until the line is the desired length, which would then have your callback function return `false`, thus
stoping your animation sequence.

```javascript
var vandal = new Vandal();
vandal.use(canvas).animate(function(scope, increment, timestamp){
	scope.draw('shape')('line')({x: 0, y: 150}, {x: inc, y: 150});
	return inc < 100 ? true : false;
});
```

---
_Source: https://npm.io/package/vandal · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._