Git Product home page Git Product logo

cytoscape.js-matter's Introduction

cytoscape-matterjs

Description

Dependencies

  • Cytoscape.js 2.7.15
  • MatterJS 0.12.0

Usage instructions

Download the library:

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

require() the library as appropriate for your project:

CommonJS:

var cytoscape = require('cytoscape');
var matterjs = require('cytoscape-matterjs');

matterjs( cytoscape ); // register extension

AMD:

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

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

API

Please briefly describe your API here:

cy.matterjs({
  refreshInterval: 16, // in ms
  refreshIterations: 10, // iterations until thread sends an update
  fit: true,
  gravity: -10, // the force each node applies to others
  globalAirFriction: 0.25, // set the air friction for the simulation
  clusters: [], // specifies groups of nodes that will be attracted to an average point between them
  mass: [], // maps a node id to a mass value for use in the simulation with a {id: 'IDENTIFICATION', mass: 15}. If a mass is not specified for a particular node the layout assigns it a mass of 10
  tickTimeout: 2000, // the number of ticks before the simulation times out
  updateOn: 1, // the number of ticks that pass before a graphical update. The default is 1, and so the graphics update every tick
  depthRestrict: true,
});

Or maybe if you have a collection extension:

cy.elements().test({
  foo: 'bar', // some option that does this
  baz: 'bat' // some options that does that
  // ... and so on
});

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
  2. Publish: gulp publish
  3. If publishing to bower for the first time, you'll need to run bower register cytoscape-matterjs https://github.com/cytoscape-MatterJS.git

cytoscape.js-matter's People

Contributors

alexcli avatar maxkfranz avatar petertsmith avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.