Needless Patchouli Manufacture
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

elkjs

0.4.1 • Public • Published

elkjs

The Eclipse Layout Kernel (ELK) implements an infrastructure to connect diagram editors or viewers to automatic layout algorithms. This library takes the layout-relevant part of ELK and makes it available to the JavaScript world. ELK's flagship is a layer-based layout algorithm that is particularly suited for node-link diagrams with an inherent direction and ports (explicit attachment points on a node's border). It is based on the ideas originally introduced by Sugiyama et al. An example can be seen in the screenshot below.

Note that elkjs is not a diagramming framework itself - it computes positions for the elements of a diagram. You can see it live in action in conjunction with TypeFox's sprotty diagramming framework.

elkjs is the successor of klayjs.

Installation

npm install elkjs

Releases and Versioning

Releases are partly synchronized with ELK's versions: the minor version number is always the same but the revision number may diverge. For instance, elkjs 0.3.0 equals the functionality of ELK 0.3.0 but elkjs 0.3.2 may be different from ELK 0.3.2. This is necessary as there may be fixes that solely concern elkjs and should be released independently of ELK.

Files

The library consists of two main files:

  • elk-api.js: Provides the API and only the API.
  • elk-worker.js: Provides the code that actually knows how to lay out a graph. This is the file that is generated from ELK's Java code base using GWT.

Two further files are provided:

  • elk.bundled.js: A bundled version of the two previous files, ready to be dropped into a browser's <script> tag. The file is processed by browserify and the ELK is exposed as a global variable (if run in a browser).
  • main.js: Main file of the node.js module. Allows to conveniently write require('elkjs') instead of composing the files from above.

Example

A small example using node.js, for further use cases see the next section.

const ELK = require('elkjs')
const elk = new ELK()
 
const graph = {
  id: "root",
  layoutOptions: { 'elk.algorithm': 'layered' },
  children: [
    { id: "n1", width: 30, height: 30 },
    { id: "n2", width: 30, height: 30 },
    { id: "n3", width: 30, height: 30 }
  ],
  edges: [
    { id: "e1", sources: [ "n1" ], targets: [ "n2" ] },
    { id: "e2", sources: [ "n1" ], targets: [ "n3" ] } 
  ]
}
 
elk.layout(graph)
   .then(console.log)
   .catch(console.error)

Layout Options

You can use layout options to configure the layout algorithm. For that you attach a layoutOptions object to the graph element that holds key/value pairs representing the desired layout options. See, for instance, root in the example above. It is possible to only use the suffix of a layout option: algorithm instead of org.eclipse.elk.layered. However, if the suffix is not unique the layout option may be ignored. To be save, you should always start the layout options with the elk. part.
A list of all options and further details of their exact effects is available in ELK's documentation.

It is possible to pass global layout options as part of the layout method's second argument. The options are then applied to every graph element unless the element specifies the option itself:

elk.layout(graph, {
  layoutOptions: { ... }
})

Additionally, ELK's constructor accepts an object with layout options that is used with every layout call that does not specify layout options:

const elk = new ELK({
  defaultLayoutOptions: { ... }
})

Usage

Since laying out diagrams can be a time-consuming job (even for the computer), and since we don't want to freeze your UI, Web Workers are supported out of the box. The following examples illustrate how the library can be used either with and without a Web Worker.

node.js

const ELK = require('elkjs')
// without web worker
const elk = new ELK()
 
elk.layout(graph)
   .then(console.log)
const ELK = require('elkjs')
// with web worker
const elk = new ELK({
  workerUrl = './node_modules/elkjs/lib/elk-worker.min.js'
})
 
elk.layout(graph)
   .then(console.log)

Note that node.js doesn't come with a web worker out of the box. Thus, we have to use a library for it and selected webworker-threads as default. Any other library that provides the standard Web Worker methods should be fine though. The package is not installed automatically to avoid the unnecessary dependency for everyone who is not interested in using a web worker. A warning is raised if one requests a web worker without having installed the package. elkjs falls back to the non-Web Worker version in that case.

Browser

<html>
  <script src="./elk.bundled.js"></script> 
  <script type="text/javascript">
    const elk = new ELK()
 
    elk.layout(graph)
       .then(function(g) {
         document.body.innerHTML = "<pre>" + JSON.stringify(g, null, " ") + "</pre>"
       })
  </script> 
</html>
<html>
  <script src="./elk-api.js"></script> <!-- use elk-api.js here! -->
  <script type="text/javascript">
    const elk = new ELK({
      workerUrl: './elk-worker.js'
    })
 
    elk.layout(graph)
       .then(function(g) {
         document.body.innerHTML = "<pre>" + JSON.stringify(g, null, " ") + "</pre>"
       })
  </script> 
</html>

Typescript

import ELK from 'elkjs/lib/elk.bundled.js'
const elk = new ELK()
 
 
import ELK from 'elkjs/lib/elk-api'
const elk = new ELK({
  workerUrl: './elk-worker.min.js'
})

API

The elkjs library provides a single object: the ELK. The ELK has a constructor that can be used to construct it:

  • new ELK(options) - the ELK can be fed with options, all of which are optional:
    • defaultLayoutOptions - an object with default layout options specified as key/value pairs that are used if no further layout options are passed to the layout(graph, options) method (see below). Default: {}.
    • algorithms - an array of algorithm ids (only the suffix). Default: [ 'layered', 'stress', 'mrtree', 'radial', 'force', 'disco' ]. Note that the box, fixed, and random layouters are always included.
    • workerUrl - a path to the elk-worker.js script. As a consequence the ELK will use a Web Worker to execute the layout. Default: undefined.

Apart from that the ELK offers the following methods:

  • layout(graph, options)
    • graph - the graph to be laid out in ELK JSON. Mandatory!
    • options - a configuration object. Currently its sole purpose is to pass global layout options. That is, layout options that are applied to every graph element unless the element specifies the option itself. Optional.
    • returns a Promise, which passes either the laid out graph on success or a (hopefully helpful) error on failure.
  • knownLayoutOptions()
    • returns an array of of known layout options. For each options additional information such as its id and group is given.
  • knownLayoutAlgorithms()
    • returns an array of registered layout algorithms (see above) alongside further information about each algorithm.
  • knownLayoutCategories()
    • returns an array of registered layout categories.
  • terminateWorker() - in case a Web Worker is used, the worker's terminate() method is called.

The three methods starting with known basically return information that, in the Java world, would be retrieved from the LayoutMetaDataService.

Building

For building, a checkout of the ELK repository is required and should be located in the same directory as the checkout of this repository.

npm install
npm run build

Afterwards you can find the created files in the lib folder.

Thanks

install

npm i elkjs

Downloadsweekly downloads

1,151

version

0.4.1

license

EPL-1.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability