# cytoscape-all-paths

> Get all possible paths

Latest version **0.1.0** (published 2019-05-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install cytoscape-all-paths
pnpm add cytoscape-all-paths
yarn add cytoscape-all-paths
bun add cytoscape-all-paths
```

## 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.1.0 |
| Published | 2019-05-29 |
| First published | 2018-10-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 17.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | daniel.xiao |
| Maintainers | daniel-dx |
| Keywords | cytoscape, cytoscape-extension, all paths |

## Links

- npm: https://www.npmjs.com/package/cytoscape-all-paths
- Repository: https://github.com/daniel-dx/cytoscape-all-paths
- Issues: https://github.com/daniel-dx/cytoscape-all-paths/issues
- npm.io page: https://npm.io/package/cytoscape-all-paths

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 0.1.0 (latest) — 2019-05-29
- 0.0.8 — 2019-05-24
- 0.0.7 — 2019-05-07
- 0.0.6 — 2018-10-23
- 0.0.5 — 2018-10-23
- 0.0.4 — 2018-10-22
- 0.0.3 — 2018-10-22
- 0.0.2 — 2018-10-22
- 0.0.1 — 2018-10-22

## README

cytoscape-all-paths
================================================================================


## Description

This is an api extension for collection, you can use it to get all possible paths pointed by the arrows ([demo](https://daniel-dx.github.io/cytoscape-all-paths/demo.html))

## Dependencies

 * Cytoscape.js ^3.2.0


## Usage instructions

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

Import the library as appropriate for your project:

ES import:

```js
import cytoscape from 'cytoscape';
import cytoscapeAllPaths from 'cytoscape-all-paths';

cytoscape.use( cytoscapeAllPaths );
```

CommonJS require:

```js
let cytoscape = require('cytoscape');
let cytoscapeAllPaths = require('cytoscape-all-paths');

cytoscape.use( cytoscapeAllPaths ); // register extension
```

AMD:

```js
require(['cytoscape', 'cytoscape-all-paths'], function( cytoscape, cytoscapeAllPaths ){
  cytoscapeAllPaths( cytoscape ); // register extension
});
```

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


## API

`cy.elements().cytoscapeAllPaths(options)`

Return all paths, data format is: [ [ node, edge, node, edge, ... ], ... ]

> options
>  - maxPaths: limit the maximum number of paths. default is -1, means unlimited
>  - rootIds: Manually specify the root(s). if it is empty, will automatically calculate


## Build targets

* `npm run test` : Run Mocha tests in `./test`
* `npm run build` : Build `./src/**` into `cytoscape-all-paths.js`
* `npm run watch` : Automatically build on changes with live reloading (N.b. you must already have an HTTP server running)
* `npm run dev` : Automatically build on changes with live reloading with webpack dev server
* `npm run lint` : Run eslint on the source

N.b. all builds use babel, so modern ES features can be used in the `src`.


## Publishing instructions

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

1. Build the extension : `npm run build:release`
1. Commit the build : `git commit -am "Build for release"`
1. Bump the version number and tag: `npm version major|minor|patch`
1. Push to origin: `git push && git push --tags`
1. Publish to npm: `npm publish .`
1. [Make a new release](https://github.com//cytoscape-all-paths/releases/new) for Zenodo.

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