# cytoscape-navigator

> Bird's eye view pan and zoom control for Cytoscape.js

Latest version **2.0.2** (published 2022-06-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install cytoscape-navigator
pnpm add cytoscape-navigator
yarn add cytoscape-navigator
bun add cytoscape-navigator
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2022-06-20 |
| First published | 2016-06-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/cytoscape-navigator) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 39.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 70 |
| Maintainers | chrtannus, mikekucera, cytoscapenpm, maxkfranz, dylanfong |
| Keywords | cytoscape, cyext |

## Links

- npm: https://www.npmjs.com/package/cytoscape-navigator
- Repository: https://github.com/cytoscape/cytoscape.js-navigator
- Issues: https://github.com/cytoscape/cytoscape.js-navigator/issues
- npm.io page: https://npm.io/package/cytoscape-navigator

## Recent versions

- 2.0.2 (latest) — 2022-06-20
- 2.0.1 — 2020-02-25
- 2.0.0 — 2020-01-24
- 1.3.3 — 2018-07-10
- 1.3.2 — 2018-01-18
- 1.3.1 — 2017-07-19
- 1.3.0 — 2017-04-04
- 1.2.0 — 2017-02-23
- 1.1.4 — 2017-02-22
- 1.1.3 — 2016-07-07
- 1.1.2 — 2016-06-27
- 1.1.1 — 2016-06-27
- 1.1.0 — 2016-06-27

## README

cytoscape-navigator
================================================================================
[![DOI](https://zenodo.org/badge/16081125.svg)](https://zenodo.org/badge/latestdoi/16081125)

## Description

Bird's eye view pan and zoom control for Cytoscape.js


## Dependencies

 * Cytoscape.js ^2.6.0 || ^3.0.0


## Usage instructions

Download the library:
 * via npm: `npm install cytoscape-navigator`,
 * via bower: `bower install cytoscape-navigator`, or
 * via direct download in the repository (probably from a tag).

`require()` the library as appropriate for your project:

CommonJS:
```js
var cytoscape = require('cytoscape');
var navigator = require('cytoscape-navigator');

navigator( cytoscape ); // register extension
```

AMD:
```js
require(['cytoscape', 'cytoscape-navigator'], function( cytoscape, navigator ){
  navigator( cytoscape ); // register extension
});
```

Plain HTML/JS has the extension registered for you automatically, because no `require()` is needed.


## API

```js
var cy = cytoscape({ /* ... */ });

var defaults = {
    container: false // string | false | undefined. Supported strings: an element id selector (like "#someId"), or a className selector (like ".someClassName"). Otherwise an element will be created by the library.
  , viewLiveFramerate: 0 // set false to update graph pan only on drag end; set 0 to do it instantly; set a number (frames per second) to update not more than N times per second
  , thumbnailEventFramerate: 30 // max thumbnail's updates per second triggered by graph updates
  , thumbnailLiveFramerate: false // max thumbnail's updates per second. Set false to disable
  , dblClickDelay: 200 // milliseconds
  , removeCustomContainer: true // destroy the container specified by user on plugin destroy
  , rerenderDelay: 100 // ms to throttle rerender updates to the panzoom for performance
};

var nav = cy.navigator( defaults ); // get navigator instance, nav
```

You may call `nav.destroy()` to remove the navigator widget and associated cleanup.


## Publishing instructions

This project is set up to automatically be published to npm and bower.  To publish:

1. Set the version number environment variable: `export VERSION=1.2.3`
1. Publish: `gulp publish`
1. If publishing to bower for the first time, you'll need to run `bower register cytoscape-navigator https://github.com/cytoscape/cytoscape.js-navigator.git`
1. Make a release on GitHub to automatically register a new Zenodo DOI

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