dotfiles/vscode/.vscode/extensions/randomfractalsinc.vscode-data-preview-2.3.0/node_modules/@d3fc/d3fc-pointer/README.md
Errol Sancaktar ff17c17e23 vscode
2024-06-14 09:31:58 -06:00

975 B

d3fc-pointer

Very simple component which emits an event to indicate the current mouse or touch position over a selection. Useful for implementing uni-directional data flow in a visualisation and not a lot else.

Main D3FC package

Installing

npm install @d3fc/d3fc-pointer

API Reference

# fc.pointer()

Constructs a new pointer component instance.

# pointer.on(typenames[, callback])

This component dispatches point events. The sole argument to the event handler is an array. If the mouse or touch interaction is over the selection then the array will contain a single object representing the co-ordinate (e.g. { x: 10, y: 10 }). If the mouse or touch interaction is not over the selection then the array will be empty.

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