Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

phylocanvas-plugin-history

phylocanvas16LGPL-3.02.1.1

Visual history for Phylocanvas

phylocanvas, history, biojs

readme

Phylocanvas History Plugin

Visual History for Phylocanvas.

Usage

npm install phylocanvas phylocanvas-plugin-history
import Phylocanvas from 'phylocanvas';
import historyPlugin from 'phylocanvas-plugin-history';

Phylocanvas.plugin(historyPlugin);

Phylocanvas.createTree('id', {
  // config defaults
  history: {
    parent: tree.containerElement,
    zIndex: 1,
  }
})

N.B. It is the responsibility of the developer to ensure that the overflow of the parent element is hidden.

Style

An unstyled bundle is also available:

import historyPlugin from 'phylocanvas-plugin-history/unstyled';

Events

A historytoggle event is fired when the history is opened or closed, with an isOpen flag in the event data.