d3-interpolate-path

d3-interpolate-path is a zero-dependency that adds an interpolator optimized for SVG <path> elements. It can also work directly with object representations of path commands that can be later interpreted for use with canvas or WebGL.

Note this package no longer has a dependency on d3 or d3-interpolate, but in web usage adds itself to the d3 namespace like other d3 plugins do.

Blog: Improving D3 Path Animation

Demo: https://pbeshai.github.io/d3-interpolate-path/

Example Usage

1var line = d3.line()
2  .curve(d3.curveLinear)
3  .x(function (d) { return x(d.x); })
4  .y(function (d) { return y(d.y); });
5
6d3.select('path.my-path')
7  .transition()
8  .duration(2000)
9  .attrTween('d', function (d) {
10    var previous = d3.select(this).attr('d');
11    var current = line(d);
12    return d3.interpolatePath(previous, current);
13  });

If you're using it in a module environment, you can import it as follows:

1import { interpolatePath } from 'd3-interpolate-path';

Otherwise, you can use it via a <script> tag as follows:

1<script src="https://unpkg.com/d3-interpolate-path/build/d3-interpolate-path.min.js"></script>

Development

Get rollup watching for changes and rebuilding

1npm run watch

Run a web server in the docs directory

1cd docs
2php -S localhost:8000

Go to http://localhost:8000

Installing

If you use NPM, npm install d3-interpolate-path. Otherwise, download the latest release.

API Reference

# interpolatePath(a, b, excludeSegment)

Returns an interpolator between two path attribute d strings a and b. The interpolator extends a and b to have the same number of points before applying linear interpolation on the values. It uses De Castlejau's algorithm for handling bezier curves.

1var pathInterpolator = interpolatePath('M0,0 L10,10', 'M10,10 L20,20 L30,30')
2pathInterpolator(0)   // 'M0,0 L10,10 L10,10'
3pathInterpolator(0.5) // 'M5,5 L15,15 L20,20'
4pathInterpolator(1)   // 'M10,10 L20,20 L30,30'

You can optionally provide a function excludeSegment that takes two adjacent path commands and returns true if that segment should be excluded when splitting the line. A command object has form { type, x, y } (with possibly more attributes depending on type). An example object:

1// equivalent to M0,150 in a path `d` string
2{
3  type: 'M',
4  x: 0,
5  y: 150
6}

This is most useful when working with d3-area. Excluding the final segment (i.e. the vertical line at the end) from being split ensures a nice transition. If you know that highest x value in the path, you can exclude the final segment by passing an excludeSegment function similar to:

1function excludeSegment(a, b) {
2  return a.x === b.x && a.x === 300; // here 300 is the max X
3}

# interpolatePathCommands(aCommands, bCommands, excludeSegment)

Returns an interpolator between two paths defined as arrays of command objects a and b. The interpolator extends a and b to have the same number of points if they differ. This can be useful if you want to work with paths in other formats besides SVG (e.g. canvas or WebGL).

Command objects take the following form:

1| { type: 'M', x: number, y: number },
2| { type: 'L', x, y }
3| { type: 'H', x }
4| { type: 'V', y }
5| { type: 'C', x1, y1, x2, y2, x, y }
6| { type: 'S', x2, y2, x, y }
7| { type: 'Q', x1, y1, x, y }
8| { type: 'T', x, y }
9| { type: 'A', rx, ry, xAxisRotation, largeArcFlag, sweepFlag, x, y }
10| { type: 'Z' }

Example usage:

1const a = [
2  { type: 'M', x: 0, y: 0 },
3  { type: 'L', x: 10, y: 10 },
4];
5const b = [
6  { type: 'M', x: 10, y: 10 },
7  { type: 'L', x: 20, y: 20 },
8  { type: 'L', x: 200, y: 200 },
9];
10
11const interpolator = interpolatePathCommands(a, b);
12
13> interpolator(0);
14[
15  { type: 'M', x: 0, y: 0 },
16  { type: 'L', x: 5, y: 5 },
17  { type: 'L', x: 10, y: 10 },
18]
19
20> interpolator(0.5);
21[
22  { type: 'M', x: 5, y: 5 },
23  { type: 'L', x: 12.5, y: 12.5 },
24  { type: 'L', x: 105, y: 105 },
25]

# pathCommandsFromString(pathDString)

Converts a path d string into an array of path command objects to work with interpolatePathCommands.

Example usage:

1const a = 'M0,0L10,10';
2
3> pathCommandsFromString(a)
4[
5  { type: 'M', x: 0, y: 0 },
6  { type: 'L', x: 10, y: 10 },
7]