cytoscape-stickynote
Description
This extension allows for the creation of cytoscape graph annotations. This includes stickynotes and notes on individual graph nodes. Text in stickynotes implements Editor.js, a a block style editor. Annotations persist through cytoscape json import/export.
Dependencies
- @editorjs/editorjs: ^2.19.0
- @editorjs/header: ^2.6.0
- @editorjs/list: ^1.6.1
- cytoscape: ^3.16.3
- cytoscape-cxtmenu: ^3.2.0
- cytoscape-popper: ^1.0.7
Usage instructions
Download the library:
- via npm:
npm install cytoscape-stickynote
- via direct download in the repository
Import the library as appropriate for your project:
ES import:
;; cytoscape;
CommonJS require:
let cytoscape = ;let stickynote = ; cytoscape;
AMD:
;
API
Example:
;;;;;;; // register extensionscytoscape;cytoscape;cytoscape; let cy = ; // must pass editor object as a parameter// other options are not neededconst stickynotes = cy; // ctxmenu extension implemented to make stickynote function callscy; cy;
Default options:
let defaults = stickyNoteWidth: 220 // width of stickynote stickyNoteHeight: 120 // height of stickunote startingLineOffset: 20 // vertical offset value for the first line of sortnotes newLineOffset: 100 // vertical offset value for each line after the starting line of sortnotes nodeOffset: 225 // horizontal offset between each node leftBuffer: 130 // minimum horizontal value rightBuffer: 30 // maximum horizontal value seperationNoteToNode: 20 // vertical distance from node to note editor: undefined // if editor is undefined, error. See above for example use;