@d3fc/d3fc-zoom

d3fc-zoom

A domain-value based alternative to d3-zoom. Designed to easily allow co-ordinating zoom/pan actions across multiple scales and out-of-band updates to the scale's domains. This is traded off against a slightly reduced feature-set.

Main D3FC package

Installing

npm install @d3fc/d3fc-zoom

API Reference

# fc.zoom()

Constructs a new zoom behaviour instance. The returned behaviour, zoom, is both an object and a function, and is typically applied to selected elements via selection.call.

# zoom(selection, xScale, yScale)

Applies this zoom behaviour to the specified selection, binding the necessary event listeners to allow panning and zooming. It accepts an xScale and/or a yScale to which the pan or zoom operation will be directly applied before the zoom event is raised.

This function is typically not invoked directly, and is instead invoked via selection.call:

selection.call(fc.zoom().on("zoom", render), xScale, yScale)

A d3.zoom component is used internally to bind the necessary event listeners. Therefore you can unbind the behaviour as follows:

selection.on(".zoom", null);

# zoom.on(typenames[, callback])

This component dispatches zoom events. There are no arguments passed to the event handler. Typically this would be used to re-render the chart.

See d3-dispatch's on for a full description.

# zoom.extent(...)

See d3-zoom extent.

# zoom.filter(...)

See d3-zoom filter.

# zoom.wheelDelta(...)

See d3-zoom wheelDelta.

# zoom.touchable(...)

See d3-zoom touchable.

# zoom.clickDistance(...)

See d3-zoom clickDistance.

# zoom.tapDistance(...)

See d3-zoom tapDistance.

# zoom.duration(...)

See d3-zoom duration.

# zoom.interpolate(...)

See d3-zoom interpolate.