Registry / visualization / circular-migration-plot

circular-migration-plot

library1.2.0jsnpmunverified

A D3-based library for creating interactive circular migration plots (chord diagrams) for the web, inspired by global-migration.info and german-migration.info. Version 1.2.0 (stable, last release ca. 2014) provides CLI tools for data filtration and compilation of CSV migration flows into JSON, plus a browser-based visualization component. Key differentiators: bundled CLI workflow for data preprocessing, minimal setup via global npm install, and dependency on D3 for rendering. The library is in maintenance mode with no recent updates.

visualization

npm install circular-migration-plot

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · CIRCULAR-MIGRATION

circular-migration-plot

visualizationjavascriptv1.2.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

CircularMigrationPlot

✓ import CircularMigrationPlot from 'circular-migration-plot';

✗ // Not a CommonJS module; use browser script tag or bundler with default import

Library is designed for browser use via <script> tag. No ESM export; imports via bundler may require default import.

CircularMigrationPlot

✓ <script src="node_modules/circular-migration-plot/dist/circular-migration-plot.js"></script> <script> CircularMigrationPlot({...}); </script>

✗ const CircularMigrationPlot = require('circular-migration-plot');

The library exposes a global variable 'CircularMigrationPlot'. In Node.js, use global install and CLI tools instead.

cmp-filter

✓ cmp-filter data/countries.csv data/flows.csv

✗ npx cmp-filter ...

CLI tool installed globally via npm install -g. Not available as a programmatic API.

cmp-compile

✓ cmp-compile flows.csv --regions North,West --pretty

✗ cmp-compile --help

CLI tool for converting CSV to JSON. Input can be stdin or file.

Shows global installation, CLI data pipeline, and browser integration for an interactive circular migration chart.

// Install globally // npm install -g circular-migration-plot // Prepare data: filter and compile // head -n30 data/flows.csv | cmp-filter data/countries.csv | cmp-compile > migration-flows.json // In browser: // <script src="node_modules/circular-migration-plot/dist/circular-migration-plot.js"></script> // <div id="chart"></div> // <div id="timeline"></div> // <script> // CircularMigrationPlot({ // data: 'migration-flows.json', // chart: '#chart', // timeline: '#timeline' // }); // </script>

Debug

Known issues

breakingGlobal installation required for CLI tools (cmp-filter, cmp-compile). Not available as programmatic Node.js API.

fix

Use 'npm install -g circular-migration-plot' and run commands from shell.

affects: >=1.0.0

gotchaNo type definitions provided; TypeScript users must declare module or use *.d.ts.

fix

Add 'declare module "circular-migration-plot";' in a .d.ts file.

affects: >=1.0.0

deprecatedD3 v3 is used internally; newer D3 v4+ chord layout API changed significantly. The library may not work with modern D3.

fix

Pin to D3 v3 if using alongside other D3 v3 components, or expect incompatibility.

affects: >=1.0.0

gotchaSample data is under Creative Commons NonCommercial license. Commercial use may require different data.

fix

Use own data or verify license compatibility for commercial projects.

affects: >=1.0.0

breakingNo ES module (ESM) export; only CommonJS build via Browserify. May not tree-shake with modern bundlers.

fix

Use the UMD bundle directly or configure bundler to include the full library.

affects: >=1.0.0

Errors

Common errors & fixes

ReferenceError: CircularMigrationPlot is not defined

Script not loaded before usage or wrong path to dist file.

fix

Ensure <script src="node_modules/circular-migration-plot/dist/circular-migration-plot.js"></script> is included before calling CircularMigrationPlot.

Cannot find module 'circular-migration-plot'

Attempted to require in Node.js without global install.

fix

This library is meant for browser use. Use the CLI tools via global install: 'npm install -g circular-migration-plot' then run commands from terminal.

cmp-filter: command not found

Package not installed globally.

fix

Run 'npm install -g circular-migration-plot' to install CLI tools globally.

Upgrade

Version history

1.2.0latest on npm

Audit

Dependencies

d3requiredCore dependency for rendering the circular migration plot (D3 chord layout).

browserifyoptionalUsed for building the browser bundle (development dependency).

Agent activity

36 hits · last 30 days

node

Resources

githubgit://github.com/jo/circular-migration-plot ↗

packagecircular-migration-plot ↗

homepagehttps://github.com/jo/circular-migration-plot ↗