README
Graphology Layout
Collection of basic layout algorithms to be used with graphology
.
Installation
npm install graphology-layout
Usage
Basic
Advanced
Utilities
#.circular
Arranges the node in a circle (or an sphere/hypersphere in higher dimensions).
Example
import {circular} from 'graphology-layout';
// Alternatively, to load only the relevant code:
import circular from 'graphology-layout/circular';
const positions = circular(graph);
// With options:
const positions = circular(graph, {scale: 100});
// To directly assign the positions to the nodes:
circular.assign(graph);
// To pass custom dimensions
const positions = random(graph, {dimensions: ['x1', 'x2']});
Arguments
- graph Graph: target graph.
- options ?object: options:
- dimensions ?array [
['x', 'y']
]: dimensions of the layout. Cannot work with dimensions != 2. - center ?number [
0.5
]: center of the layout. - scale ?number [
1
]: scale of the layout.
- dimensions ?array [
#.random
Random layout positioning every node by choosing each coordinates uniformly at random on the interval [0, 1)
.
Example
import {random} from 'graphology-layout';
// Alternatively, to load only the relevant code:
import random from 'graphology-layout/random';
const positions = random(graph);
// With options:
const positions = random(graph, {rng: customRngFunction});
// To directly assign the positions to the nodes:
random.assign(graph);
// To pass custom dimensions
const positions = random(graph, {dimensions: ['x', 'y', 'z']});
Arguments
- graph Graph: target graph.
- options ?object: options:
- dimensions ?array [
['x', 'y']
]: dimensions of the layout. - center ?number [
0.5
]: center of the layout. - rng ?function [
Math.random
]: custom RNG function to use. - scale ?number [
1
]: scale of the layout.
- dimensions ?array [
#.circlePack
Arranges the nodes as a bubble chart, according to specified attributes.
Example
import {circlepack} from 'graphology-layout';
// Alternatively, to load only the relevant code:
import circlepack from 'graphology-layout/circlepack';
const positions = circlepack(graph);
// With options
const positions = circlepack(graph, {
hierarchyAttributes: ['degree', 'community'],
rng: customRngFunction
});
// To directly assign the positions to the nodes:
circlepack.assign(graph);
Arguments
- graph Graph: target graph.
- options ?object: options:
- attributes ?object: attributes to map:
- x ?string [
x
]: name of the x position. - y ?string [
y
]: name of the y position.
- x ?string [
- center ?number [
0
]: center of the layout. - hierarchyAttributes ?list [
[]
]: attributes used to group nodes. - rng ?function [
Math.random
]: custom RNG function to use. - scale ?number [
1
]: scale of the layout.
- attributes ?object: attributes to map:
#.rotation
Rotates the node coordinates of the given graph by the given angle in radians (or in degrees using an option).
Note that this function rotates your graph based on its center. If you want to use zero as the center for your rotation, use the centeredOnZero
option. This option can also be used as an optimization strategy if you know your graph is already centered on zero to avoid needing to compute the graph's extent.
Example
import {rotation} from 'graphology-layout';
// Alternatively, to load only the relevant code:
import rotation from 'graphology-layout/rotation';
const positions = rotation(graph, Math.PI / 2);
// With options:
const positions = rotation(graph, Math.PI / 2, {centeredOnZero: true});
// To directly assign the positions to the nodes:
rotation.assign(graph, Math.PI / 2);
Arguments
- graph Graph: target graph.
- angle number: rotation angle in radians (or degrees using an option below).
- options ?object: options:
- dimensions ?array [
['x', 'y']
]: dimensions to use for the rotation. Cannot work with dimensions != 2. - degrees ?boolean [
false
]: whether the given angle is in degrees. - centeredOnZero ?boolean [
false
]: whether to rotate the graph around0
, rather than the graph's center.
- dimensions ?array [