95 lines
5.2 KiB
Markdown
95 lines
5.2 KiB
Markdown
# d3-dispatch
|
||
|
||
Dispatching is a convenient mechanism for separating concerns with loosely-coupled code: register named callbacks and then call them with arbitrary arguments. A variety of D3 components, such as [d3-drag](https://github.com/d3/d3-drag), use this mechanism to emit events to listeners. Think of this like Node’s [EventEmitter](https://nodejs.org/api/events.html), except every listener has a well-defined name so it’s easy to remove or replace them.
|
||
|
||
For example, to create a dispatch for *start* and *end* events:
|
||
|
||
```js
|
||
const dispatch = d3.dispatch("start", "end");
|
||
```
|
||
|
||
You can then register callbacks for these events using [*dispatch*.on](#dispatch_on):
|
||
|
||
```js
|
||
dispatch.on("start", callback1);
|
||
dispatch.on("start.foo", callback2);
|
||
dispatch.on("end", callback3);
|
||
```
|
||
|
||
Then, you can invoke all the *start* callbacks using [*dispatch*.call](#dispatch_call) or [*dispatch*.apply](#dispatch_apply):
|
||
|
||
```js
|
||
dispatch.call("start");
|
||
```
|
||
|
||
Like *function*.call, you may also specify the `this` context and any arguments:
|
||
|
||
```js
|
||
dispatch.call("start", {about: "I am a context object"}, "I am an argument");
|
||
```
|
||
|
||
Want a more involved example? See how to use [d3-dispatch for coordinated views](http://bl.ocks.org/mbostock/5872848).
|
||
|
||
## Installing
|
||
|
||
If you use npm, `npm install d3-dispatch`. You can also download the [latest release on GitHub](https://github.com/d3/d3-dispatch/releases/latest). For vanilla HTML in modern browsers, import d3-dispatch from Skypack:
|
||
|
||
```html
|
||
<script type="module">
|
||
|
||
import {dispatch} from "https://cdn.skypack.dev/d3-dispatch@3";
|
||
|
||
const d = dispatch("start", "end");
|
||
|
||
</script>
|
||
```
|
||
|
||
For legacy environments, you can load d3-dispatch’s UMD bundle from an npm-based CDN such as jsDelivr; a `d3` global is exported:
|
||
|
||
```html
|
||
<script src="https://cdn.jsdelivr.net/npm/d3-dispatch@3"></script>
|
||
<script>
|
||
|
||
const d = d3.dispatch("start", "end");
|
||
|
||
</script>
|
||
```
|
||
|
||
[Try d3-dispatch in your browser.](https://observablehq.com/collection/@d3/d3-dispatch)
|
||
|
||
## API Reference
|
||
|
||
<a name="dispatch" href="#dispatch">#</a> d3.<b>dispatch</b>(<i>types…</i>) · [Source](https://github.com/d3/d3-dispatch/blob/master/src/dispatch.js)
|
||
|
||
Creates a new dispatch for the specified event *types*. Each *type* is a string, such as `"start"` or `"end"`.
|
||
|
||
<a name="dispatch_on" href="#dispatch_on">#</a> *dispatch*.<b>on</b>(<i>typenames</i>[, <i>callback</i>]) · [Source](https://github.com/d3/d3-dispatch/blob/master/src/dispatch.js)
|
||
|
||
Adds, removes or gets the *callback* for the specified *typenames*. If a *callback* function is specified, it is registered for the specified (fully-qualified) *typenames*. If a callback was already registered for the given *typenames*, the existing callback is removed before the new callback is added.
|
||
|
||
The specified *typenames* is a string, such as `start` or `end.foo`. The type may be optionally followed by a period (`.`) and a name; the optional name allows multiple callbacks to be registered to receive events of the same type, such as `start.foo` and `start.bar`. To specify multiple typenames, separate typenames with spaces, such as `start end` or `start.foo start.bar`.
|
||
|
||
To remove all callbacks for a given name `foo`, say `dispatch.on(".foo", null)`.
|
||
|
||
If *callback* is not specified, returns the current callback for the specified *typenames*, if any. If multiple typenames are specified, the first matching callback is returned.
|
||
|
||
<a name="dispatch_copy" href="#dispatch_copy">#</a> *dispatch*.<b>copy</b>() · [Source](https://github.com/d3/d3-dispatch/blob/master/src/dispatch.js)
|
||
|
||
Returns a copy of this dispatch object. Changes to this dispatch do not affect the returned copy and <i>vice versa</i>.
|
||
|
||
<a name="dispatch_call" href="#dispatch_call">#</a> *dispatch*.<b>call</b>(<i>type</i>[, <i>that</i>[, <i>arguments…</i>]]) · [Source](https://github.com/d3/d3-dispatch/blob/master/src/dispatch.js)
|
||
|
||
Like [*function*.call](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/call), invokes each registered callback for the specified *type*, passing the callback the specified *arguments*, with *that* as the `this` context. See [*dispatch*.apply](#dispatch_apply) for more information.
|
||
|
||
<a name="dispatch_apply" href="#dispatch_apply">#</a> *dispatch*.<b>apply</b>(<i>type</i>[, <i>that</i>[, <i>arguments</i>]]) · [Source](https://github.com/d3/d3-dispatch/blob/master/src/dispatch.js)
|
||
|
||
Like [*function*.apply](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/call), invokes each registered callback for the specified *type*, passing the callback the specified *arguments*, with *that* as the `this` context. For example, if you wanted to dispatch your *custom* callbacks after handling a native *click* event, while preserving the current `this` context and arguments, you could say:
|
||
|
||
```js
|
||
selection.on("click", function() {
|
||
dispatch.apply("custom", this, arguments);
|
||
});
|
||
```
|
||
|
||
You can pass whatever arguments you want to callbacks; most commonly, you might create an object that represents an event, or pass the current datum (*d*) and index (*i*). See [function.call](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function/Call) and [function.apply](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function/Apply) for further information.
|