SysPlot

A library that systematically generates a plane for plotting shapes, with a variety of algorithms to choose from.

Install

$ yarn add sysplot

Usage

SysPlot is used for generating XY coordinates for placing shapes. It is agnostic about the approach used for the visualisation, be it HTML, SVG, Canvas, WebGL.. etc.

Positions will be given starting from the center and will attempt to fill as much space as possible.

import SysPlot, { VogelSpiral /* any provided algorithm */ } from 'sysplot';

const sysPlot = new SysPlot();

sysPlot.setConfig({
  algorithm: VogelSpiral,
  cover: true,
  padding: 10,
  proportional: true,
  spread: 0.25,
});

sysPlot.setBounds(1000, 500);

const shapes = [{
  radius: 20,
}, {
  width: 30,
  height: 50,
}]

/** Give it the shapes to calculate the position for. */
sysPlot.setShape(shapes);

/** Get the positions for those shapes */
const positions = sysPlot.getPositions();

/** Shapes that were unable to be placed will have no position */
const shapesWithValidPositions = zip(positions, shapes).filter(([, p]) => p);

Algorithms

`ArchimedesSpiral`

The Archimedean spiral (also known as the arithmetic spiral) is a spiral named after the 3rd century BC Greek mathematician Archimedes. It is the locus of points corresponding to the locations over time of a point moving away from a fixed point with a constant speed along a line which rotates with constant angular velocity.

Wikipedia - Archimedes Spiral

`ConcentricCircles`

In geometry, two or more objects are said to be concentric, coaxal, or coaxial when they share the same center or axis.

Wikipedia - Concentric Circles

`FermatSpiral`

Fermat's spiral (also known as a parabolic spiral) was first discovered by Pierre de Fermat. It is a type of Archimedean spiral

Wikipedia - Fermat Spiral

`UlamSpiral`

The Ulam spiral or prime spiral (in other languages also called the Ulam cloth) is a graphical depiction of the set of prime numbers... It is constructed by writing the positive integers in a square spiral and specially marking the prime numbers.

Wikipedia - Ulam Spiral

`VogelSpiral`

In disc phyllotaxis, as in the sunflower and daisy, the mesh of spirals occurs in Fibonacci numbers because divergence (angle of succession in a single spiral arrangement) approaches the golden ratio.

Wikipedia - Vogel Spiral

API

Config Object

const config = {
  /**
   * One of the exported algorithm functions mentioned above.
   *
   * Defaults: ArchimedesSpiral
   */
  algorithm: Function,

  /**
   * An explicit aspect ratio, irrespective of the given bounds, for
   * plotting the vectors.
   *
   * Defaults: 1
   */
  aspectRatio: Number,

  /**
   * Specifies to generate as many vector points needed to cover the entire
   * area give.
   *
   * Defaults: true
   */
  cover: Boolean

  /**
   * The amount of padding to be used around the shapes when
   * positioning.
   *
   * Defaults: 10
   */
  padding: Number,

  /**
   * Retains the aspect ratio (taking from the bounds) for plotting the vector points.
   *
   * Defaults: false
   */
  proportional: Boolean,

  /**
   * A number between 0.1 and 1 that affects the density of the
   * vector points. 0.1 being very dense and 1 being very spread
   * apart.
   *
   * Defaults: 0.25
   */
  spread: Number,
}

SysPlot()

The main class for storing the environment and generating vectors and positions.

new SysPlot();

Sysplot.setConfig(configObject)

Updates the config and sets a flag to regenerate the plotting vectors and/or the positions on next getPositions() call.

sysPlot.setConfig(configObject);

SysPlot.setBounds(width, height)

Sets the bounds to generate the plotting vectors for.

const width = 1000;
const height = 500;

sysPlot.setBounds(width, height);

SysPlot.setShapes(shapes)

Sets the shapes and sets a flag to regenerate positions on next getPositions() call.

const shapes = [{
  radius: 20,
}, {
  width: 30,
  height: 50,
}]

sysPlot.setShapes(shapes);

SysPlot.getPositions()

Gets the positions for the set shapes. Returns XY coordinates in order of the shapes that were set. Any shapes they were unable to be positioned will be null.

const shapes = [...];
const positions = sysPlot.getPositions();

const shapesWithValidPositions = zip(positions, shapes).filter(([, p]) => p);

SysPlot.getVectors()

Gets the vector points used for positioning (as XY coordinates) that the algorithm generated, radiating out from the center.

sysPlot.getVectors(); // [[x, y], [x, y] ...etc]

Performance

Generating the vector points and positioning the shapes can be intensive depending on the algorithm used, the number of shapes and the spread option. SysPlot will only generate new vectors and positions if it needs to, which is determined when certain parts of the config, bounds or shapes change.

Use the setBounds, setConfig and setShapes methods when the environment changes.

HHogg/sysplot