npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cytoscape-edgehandles

v4.0.1

Published

Edge creation UI extension for Cytoscape

Downloads

39,360

Readme

cytoscape-edgehandles

DOI

Preview

Description

This extension creates handles on nodes that can be dragged to create edges between nodes (demo, demo (snapping disabled), compound demo, compound demo (snapping disabled))

Dependencies

  • Cytoscape.js ^3.2.0

Usage instructions

Download the library:

  • via npm: npm install cytoscape-edgehandles,
  • via bower: bower install cytoscape-edgehandles, or
  • via direct download in the repository (probably from a tag).

Import the library as appropriate for your project:

ES import:

import cytoscape from 'cytoscape';
import edgehandles from 'cytoscape-edgehandles';

cytoscape.use( edgehandles );

CommonJS require:

let cytoscape = require('cytoscape');
let edgehandles = require('cytoscape-edgehandles');

cytoscape.use( edgehandles ); // register extension

AMD:

require(['cytoscape', 'cytoscape-edgehandles'], function( cytoscape, edgehandles ){
  edgehandles( cytoscape ); // register extension
});

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

Initialisation

You initialise the extension on the Cytoscape instance:


let cy = cytoscape({
  container: document.getElementById('#cy'),
	/* ... */
});

// the default values of each option are outlined below:
let defaults = {
  canConnect: function( sourceNode, targetNode ){
    // whether an edge can be created between source and target
    return !sourceNode.same(targetNode); // e.g. disallow loops
  },
  edgeParams: function( sourceNode, targetNode ){
    // for edges between the specified source and target
    // return element object to be passed to cy.add() for edge
    return {};
  },
  hoverDelay: 150, // time spent hovering over a target node before it is considered selected
  snap: true, // when enabled, the edge can be drawn by just moving close to a target node (can be confusing on compound graphs)
  snapThreshold: 50, // the target node must be less than or equal to this many pixels away from the cursor/finger
  snapFrequency: 15, // the number of times per second (Hz) that snap checks done (lower is less expensive)
  noEdgeEventsInDraw: true, // set events:no to edges during draws, prevents mouseouts on compounds
  disableBrowserGestures: true // during an edge drawing gesture, disable browser gestures such as two-finger trackpad swipe and pinch-to-zoom
};

let eh = cy.edgehandles( defaults );

API

The object returned by cy.edgehandles() has several functions available on it:

  • start( sourceNode ) : manually start the gesture (as if the handle were already held)
  • stop() : manually completes or cancels the gesture
  • disable() : disables edgehandles behaviour
  • enable() : enables edgehandles behaviour
  • enableDrawMode() : turn on draw mode (the entire node body acts like the handle)
  • disableDrawMode() : turn off draw mode
  • destroy() : remove edgehandles behaviour

Classes

These classes can be used for styling the graph as it interacts with the extension:

  • eh-source : The source node
  • eh-target : A target node
  • eh-preview : Preview edges (i.e. shown before releasing the mouse button and the edge creation is confirmed)
  • eh-hover : Added to nodes as they are hovered over as targets
  • eh-ghost-node : The ghost node (target), used when the cursor isn't pointed at a target node yet (i.e. in place of a target node)
  • eh-ghost-edge : The ghost handle line edge, used when the cursor isn't pointed at a target node yet (i.e. the edge is pointing to empty space)
  • eh-ghost : A ghost element
  • eh-presumptive-target : A node that, during an edge drag, may become a target when released
  • eh-preview-active : Applied to the source, target, and ghost edge when the preview is active

Events

During the course of a user's interaction with the extension, several events are generated and triggered on the core. Each event callback has a number of extra parameters, and certain events have associated positions.

  • ehstart : when the edge creation gesture starts
    • (event, sourceNode)
    • event.position : handle position
  • ehcomplete : when the edge is created
    • (event, sourceNode, targetNode, addedEdge)
    • event.position : cursor/finger position
  • ehstop : when the edge creation gesture is stopped (either successfully completed or cancelled)
    • (event, sourceNode)
    • event.position : cursor/finger position
  • ehcancel : when the edge creation gesture is cancelled
    • (event, sourceNode, cancelledTargets)
    • event.position : cursor/finger position
  • ehhoverover : when hovering over a target
    • (event, sourceNode, targetNode)
    • event.position : cursor/finger position
  • ehhoverout : when leaving a target node
    • (event, sourceNode, targetNode)
    • event.position : cursor/finger position
  • ehpreviewon : when a preview is shown
    • (event, sourceNode, targetNode, previewEdge)
    • event.position : cursor/finger position
  • ehpreviewoff : when the preview is removed
    • (event, sourceNode, targetNode, previewEdge)
    • event.position : cursor/finger position
  • ehdrawon : when draw mode is enabled
    • (event)
  • ehdrawoff : when draw mode is disabled
    • (event)

Example binding:

cy.on('ehcomplete', (event, sourceNode, targetNode, addedEdge) => {
	let { position } = event;

  // ...
});

Build targets

  • npm run test : Run Mocha tests in ./test
  • npm run build : Build ./src/** into cytoscape-edgehandles.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
  2. Commit the build : git commit -am "Build for release"
  3. Bump the version number and tag: npm version major|minor|patch
  4. Push to origin: git push && git push --tags
  5. Publish to npm: npm publish .
  6. If publishing to bower for the first time, you'll need to run bower register cytoscape-edgehandles https://github.com/cytoscape/edgehandles.gita
  7. Make a new release for Zenodo.