# the-canvas-access

> Access for html canvas

Latest version **2.0.7** (published 2018-11-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install the-canvas-access
pnpm add the-canvas-access
yarn add the-canvas-access
bun add the-canvas-access
```

## 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 | 2.0.7 |
| Published | 2018-11-15 |
| First published | 2018-11-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 3 |
| Unpacked size | 113.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | okunishinishi |
| Maintainers | okunishinishi |
| Keywords | the |

## Links

- npm: https://www.npmjs.com/package/the-canvas-access
- Repository: https://github.com/the-labo/the-canvas-access
- Homepage: https://github.com/the-labo/the-canvas-access#readme
- Issues: https://github.com/the-labo/the-canvas-access/issues
- npm.io page: https://npm.io/package/the-canvas-access

## Dependencies (3)

- [mathjs](https://npm.io/package/mathjs.md) ^5.2.3
- [the-2d](https://npm.io/package/the-2d.md) ^1.0.9
- [the-window](https://npm.io/package/the-window.md) ^7.0.1

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 2.0.7 (latest) — 2018-11-15
- 2.0.6 — 2018-11-15
- 2.0.5 — 2018-11-15
- 2.0.4 — 2018-11-14
- 2.0.2 — 2018-11-14
- 2.0.1 — 2018-11-14
- 2.0.0 — 2018-11-14
- 1.0.2 — 2018-11-13
- 1.0.1 — 2018-11-13
- 1.0.0 — 2018-11-13

## README

the-canvas-access
==========

<!---
This file is generated by the-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/the-labo/the-canvas-access
[bd_travis_url]: http://travis-ci.org/the-labo/the-canvas-access
[bd_travis_shield_url]: http://img.shields.io/travis/the-labo/the-canvas-access.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/the-labo/the-canvas-access
[bd_travis_com_shield_url]: https://api.travis-ci.com/the-labo/the-canvas-access.svg?token=
[bd_license_url]: https://github.com/the-labo/the-canvas-access/blob/master/LICENSE
[bd_npm_url]: http://www.npmjs.org/package/the-canvas-access
[bd_npm_shield_url]: http://img.shields.io/npm/v/the-canvas-access.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Access for html canvas

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install the-canvas-access --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const { TheCanvasAccess } = require('the-canvas-access')

async function tryExample () {

  const canvas = document.getElementById('my-canvas-01')
  const canvasAccess = new TheCanvasAccess(canvas)

  console.log(
    canvasAccess.getMeanColorFor(0, 0, 128, 128)
  ) // -> get mean color for rect

}

tryExample().catch((err) => console.error(err))

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/10.API Guide.md.hbs" Start -->

<a name="section-doc-guides-10-a-p-i-guide-md"></a>

API Guide
-----

+ [the-canvas-access@2.0.7](./doc/api/api.md)
  + [create(args)](./doc/api/api.md#the-canvas-access-function-create)
  + [TheCanvasAccess](./doc/api/api.md#the-canvas-access-class)


<!-- Section from "doc/guides/10.API Guide.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/the-labo/the-canvas-access/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [THE Labo][t_h_e_labo_url]

[t_h_e_labo_url]: https://github.com/the-labo

<!-- Links End -->

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