https://github.com/axelpale/affineplane-circlepack

Fast order-preserving circle packing algorithm for data visualization
https://github.com/axelpale/affineplane-circlepack

Last synced: 3 months ago
JSON representation

Fast order-preserving circle packing algorithm for data visualization

• Host: GitHub
• URL: https://github.com/axelpale/affineplane-circlepack
• Owner: axelpale
• License: mit
• Created: 2024-07-17T11:35:53.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-07-31T22:52:17.000Z (5 months ago)
• Last Synced: 2024-10-01T12:19:05.908Z (3 months ago)
• Language: JavaScript
• Size: 229 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# affineplane-circlepack

[![NPM Version](https://img.shields.io/npm/v/affineplane-circlepack.svg?colorB=7fcd0f)](https://www.npmjs.com/package/affineplane-circlepack)

[![License](https://img.shields.io/npm/l/affineplane)](#license)

Deterministic and order-preserving 2D circle packing algorithm for data visualization. Try the [demo](https://demos.akselipalen.com/circlepack/).

![affineplane-circlepack social banner](docs/affineplane-circlepack.png)

## Install

Install with [npm](https://www.npmjs.com/package/affineplane-circlepack) or [yarn](https://yarnpkg.com/en/package/affineplane-circlepack):

```

$ npm install affineplane-circlepack

$ yarn add affineplane-circlepack

```

## Usage

The basic usage is simple:

```

const pack = require('affineplane-circlepack')

const circles = [

  { x: 1, y: 0, r: 1 },

  { x: 2, y: 4, r: 2 },

  { x: 1, y: 5, r: 2 },

  ...

]

const packed = pack(circles)

// packed is an array that contains the same circles with x and y adjusted.

```

Asynchronic runs are good for packing large sets of circles in a non-blocking way:

```

pack(circles, (batch) => {

  console.log('A batch of packed circles fresh out of the oven.', batch)

}, () => {

  console.log('All packed.')

})

```

## Contribute

Pull requests and [bug reports](https://github.com/axelpale/affineplane-circlepack/issues) are highly appreciated. Please test your contribution with the following scripts:

Run test suite:

    $ npm run test

Run only linter:

    $ npm run lint

## See also

This library uses some tools from [affineplane](https://axelpale.github.io/affineplane/) geometry library.

## License

[MIT](LICENSE)