README.md

Trellis

A highly performant network visualization library with a simple, declarative API, plugable renderers, and bindings for different frameworks and use cases

Installation

if using npm

npm install @sayari/trellis

or alternatively import via HTML

<script src="https://unpkg.com/@sayari/trellis@{VERSION}/index.umd.js"></script>

Examples

• Static Graph
• Viewport Interactions
• Node Interactions
• Hierarchy Layout
• React Bindings
• React Selection Multiselect Tool

Modules

• renderers
  • WebGL
  • png/jpg
• layout
  • force
  • hierarchy
  • cluster
  • subgraphs
• bindings
  • react
  • native

Philosophy

Trellis decouples graph rendering from graph layout computations, and decouples both from framework-specific bindings. Additionally, the Trellis renderer is mostly stateless, leaving questions of state management to the application and allowing for simple customization of library behavior. This means integrating any of Trellis modules with an existing application should be relatively straightforward. Similar to rendering libraries like React, Trellis focuses on performant rendering and graph-based computations, while remaining agnostic about where and how state is managed. Moreover, by splitting responsibilities into separate modules, if existing modules don't fit your needs, you can always roll your own, while still benefiting from the remaining modules that are helpful.

See Also

• Sigma js

Development

npm run dev

Deployment

All deployments must be run from the master branch with a clean working directory.

./deploy.sh [prerelease|patch|minor|major]