# openseadragon-pixijs-overlay

> An OpenSeadragon plugin that adds PixiJS overlay capability.

Latest version **0.0.2** (published 2022-08-09) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install openseadragon-pixijs-overlay
pnpm add openseadragon-pixijs-overlay
yarn add openseadragon-pixijs-overlay
bun add openseadragon-pixijs-overlay
```

## 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.0.2 |
| Published | 2022-08-09 |
| First published | 2022-08-03 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | ynitto |
| Maintainers | ynitto |
| Keywords | openseadragon, plugin, pixijs, overlay |

## Links

- npm: https://www.npmjs.com/package/openseadragon-pixijs-overlay
- Repository: https://github.com/ynitto/openseadragon-pixijs-overlay
- Homepage: https://github.com/ynitto/openseadragon-pixijs-overlay#readme
- Issues: https://github.com/ynitto/openseadragon-pixijs-overlay/issues
- npm.io page: https://npm.io/package/openseadragon-pixijs-overlay

## Dependencies (2)

- [openseadragon](https://npm.io/package/openseadragon.md) ^3.1.0
- [pixi-viewport](https://npm.io/package/pixi-viewport.md) ^4.34.4

## Alternatives

- [react-native-root-siblings](https://npm.io/package/react-native-root-siblings.md) — 102.9K weekly downloads
- [@praxisui/dialog](https://npm.io/package/@praxisui/dialog.md) — 2.0K weekly downloads
- [easy-toggle-state](https://npm.io/package/easy-toggle-state.md) — 350 weekly downloads
- [ngx-lightbox-evp](https://npm.io/package/ngx-lightbox-evp.md) — 19 weekly downloads
- [react-native-modal-translucent-axton](https://npm.io/package/react-native-modal-translucent-axton.md) — 4 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2022-08-09
- 0.0.1 — 2022-08-03

## README

# OpenSeadragonPixiJSOverlay

An [OpenSeadragon](http://openseadragon.github.io) plugin that adds PixiJS overlay capability.

Compatible with OpenSeadragon 3.1.0 or greater.

## Documentation

To use, include the `openseadragon-pixijs-overlay.js` file after `openseadragon.js` on your web page.

To add PixiJS overlay capability to your OpenSeadragon Viewer, call `pixiOverlay(options)` on it. The argument `options` is a same type of [PIXI.Appication constructor options](https://pixijs.download/release/docs/PIXI.Application.html#constructor). Also, you can set world-coordinate size as `worldWidth` and `worldHeight` properties. If not set, it automatically decide the same size of displaying the first image.

For example:

```javascript
var overlay = this.viewer.pixiOverlay({
    backgroundAlpha: 0
});
 ```

 This will return a new object with the following methods:

* `viewport()`: Gives access to [PIXI.viewport](https://github.com/davidfig/pixi-viewport), to add graphics.
* `resize()`: If your viewer changes size, you'll need to resize the overlay by calling this method.
* `render()`: If you force to render, you'll call this method.


See [online demo](https://ynitto.github.io/openseadragon-pixijs-overlay/demo.html) or demo.html for an example of it in use.

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