# gl-select-box

> Draws a user selection over the screen

Latest version **1.0.4** (published 2020-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install gl-select-box
pnpm add gl-select-box
yarn add gl-select-box
bun add gl-select-box
```

## 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.4 |
| Published | 2020-04-05 |
| First published | 2015-08-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Mikola Lysenko |
| Maintainers | alexcjohnson, antrg, archmoj, bpostlethwaite, chriddyp, dfcreative, dmt0, emmanuelle, etpinard, jmmease, jody_plotly, mikolalysenko, monfera, nicolaskruchten, rreusser, verazabeida, xhlu |
| Keywords | selection, gl-vis, internal, module |

## Links

- npm: https://www.npmjs.com/package/gl-select-box
- Repository: https://github.com/gl-vis/gl-select-box
- Homepage: https://github.com/gl-vis/gl-select-box#readme
- Issues: https://github.com/gl-vis/gl-select-box/issues
- npm.io page: https://npm.io/package/gl-select-box

## Dependencies (3)

- [glslify](https://npm.io/package/glslify.md) ^7.0.0
- [gl-buffer](https://npm.io/package/gl-buffer.md) ^2.1.2
- [gl-shader](https://npm.io/package/gl-shader.md) ^4.2.1

## Recent versions

- 1.0.4 (latest) — 2020-04-05
- 1.0.3 — 2019-01-09
- 1.0.2 — 2018-02-02
- 1.0.1 — 2015-10-05
- 1.0.0 — 2015-08-22

## README

# gl-select-box
An overlay which draws select boxes for 2d webgl plots

## Example

Check back later

## Install

```
npm i gl-select-box
```

## API

### Constructor

#### `var selectBox = require('gl-select-box')(plot, options)`
Creates a select box primitive

* `plot` is a `gl-plot2d` instance
* `options` is a set of configuration parameters for the select box

The parameters for `options` are as follows:

* `selectBox` The bounding box for the selection region
* `innerFill` If set, fill in the inner box
* `innerColor` Color of the inner box
* `outerFill` If set, fill region outside box
* `outerColor` Color of outer fill
* `borderWidth` Border of box in pixels
* `borderColor` Border color

### Methods

#### `selectBox.update(options)`
Updates select box in place

#### `selectBox.dispose()`
Destroys the select box

## License
(c) 2015 Mikola Lysenko. MIT License

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