d3-fisheye v2.1.2

d3-fisheye

A fisheye module that includes the option to smoothly transition out of the fisheye effect rather than the abrupt discontinuity at the edge of Sarkar-Brown-based implementations. See https://observablehq.com/@duaneatat/smoothed-fisheye for details.

Installing

npm install d3-fisheye or yarn add d3-fisheye

API Reference

See https://bl.ocks.org/duaneatat/315b00c4747e747054ba0287035794d6 for an example comparing fisheye with and without smoothing enabled.

Example:

const fisheye = d3Fisheye.radial()
  .radius(250)
  .distortion(4)
  .smoothing(0.5);

fisheye.focus([10, 50]);
console.log(fisheye([10, 100])); // [ 10, 168.48674177847914, 2.369734835569583 ]

The values returned correspond to the x, y, and z coordinates of the transformed input point. The z value can be used to scale elements inside the fisheye effect. The z value is maximum at the center of the fisheye effect, where it will equal the distortion. 1 is the z value for un-transformed points.

The smoothing option is the fraction of the radius that is used to smoothly transition back out of the fisheye effect. A value of 0 would result in the usual Sarkar-Brown fisheye effect, e.g. here and here. A value of 1 would result in no fisheye effect at all. Default is 0.2.

Inverse

The original point can be recovered by passing true as the second parameter to the fisheye function.

Example:

const fisheye = d3Fisheye.radial()
  .radius(250)
  .distortion(4)
  .smoothing(0.5);

fisheye.focus([10, 50]);
console.log(fisheye(fisheye([10, 100]), true)); // ~[ 10, 100 ]