# led-matrix

> Utility for storing graphical data in a matrix

Latest version **1.0.1** (published 2019-07-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install led-matrix
pnpm add led-matrix
yarn add led-matrix
bun add led-matrix
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-07-05 |
| First published | 2016-12-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Sallar Kaboli |
| Maintainers | sallar |
| Keywords | matrix, led, rgb, html5, canvas, graphics, bitmap |

## Links

- npm: https://www.npmjs.com/package/led-matrix
- Repository: https://github.com/sallar/led-matrix
- Homepage: https://github.com/sallar/led-matrix#readme
- Issues: https://github.com/sallar/led-matrix/issues
- npm.io page: https://npm.io/package/led-matrix

## Dependencies (1)

- [matrix-display-store](https://npm.io/package/matrix-display-store.md) ^1.0.0

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2019-07-05
- 1.0.0 — 2018-05-04
- 0.3.0 — 2017-08-04
- 0.2.1 — 2017-07-30
- 0.2.0 — 2017-07-23
- 0.1.4 — 2017-07-23
- 0.1.3 — 2017-07-23
- 0.1.2 — 2016-12-25
- 0.1.0 — 2016-12-25
- 0.0.4 — 2016-12-24
- 0.0.3 — 2016-12-24
- 0.0.2 — 2016-12-24
- 0.0.1 — 2016-12-24

## README

# HTML5 LED Matrix 

[![Build Status](https://travis-ci.org/sallar/led-matrix.svg?branch=master)](https://travis-ci.org/sallar/led-matrix)

An HTML5 Matrix display simulator that accepts a matrix of pixel data and renders them using HTML5 Canvas.

## Install

```shell
$ npm install led-matrix --save-dev
# or
$ yarn add led-matrix
```

## Usage

```js
import { LedMatrix } from 'led-matrix';
import { createStore } from 'matrix-display-store';

const store = createStore(32, 16);
const matrix = new LedMatrix(canvasElement, {
  x: 32,
  y: 16,
  // other options...
});
matrix.setData(store.matrix);
matrix.render();
```

## Options

``` typescript
{
  x: number;
  y: number;
  pixelWidth: number;
  pixelHeight: number;
  margin: number;
  glow: boolean;
  animated: boolean;
}
```

## Related

+ [matrix-display-store](https://github.com/sallar/matrix-display-store)
+ [rpi-matrix](https://github.com/sallar/rpi-matrix)
+ [led-matrix-simulator](https://github.com/sallar/led-matrix-simulator)

## License

Licensed under the [MIT License](LICENSE)

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