From 2e57bda4374e2183dbd628694604585bd3dc8bf7 Mon Sep 17 00:00:00 2001 From: Mike Bostock Date: Thu, 7 Jan 2016 11:57:41 -0800 Subject: [PATCH] Checkpoint API reference. --- README.md | 41 +++++++++++++++++++++++++++++------------ 1 file changed, 29 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 22abe1f2..6fd257ac 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ If you use NPM, `npm install d3@4.0.0-alpha.2`. Otherwise, download the [latest * [Random Numbers](#random-numbers) * [Requests](#requests) * [Scales](#scales) ([Continuous](#continuous), [Sequential](#sequential), [Quantize](#quantize), [Ordinal](#ordinal), [Categorical](#categorical)) -* [Selections](#selections) +* [Selections](#selections) ([Selection](#selection), [Transformation](#transformation), [Data](#data), [Events](#events), [Control](#control), [Namespaces](#namespaces)) * [Shapes](#shapes) ([Arcs](#arcs), [Pies](#pies), [Lines](#lines), [Areas](#areas), [Curves](#curves), [Symbols](#symbols), [Stacks](#stacks)) * [Time Formats](#time-formats) * [Time Intervals](#time-intervals) @@ -442,9 +442,17 @@ Map a discrete domain to a discrete, fixed categorical color range. Transform the DOM by selecting elements and joining to data. +### Selection + +* [d3.selection](https://github.com/d3/d3-selection#selection) - select the root document element. * [d3.select](https://github.com/d3/d3-selection#select) - select an element from the document. * [d3.selectAll](https://github.com/d3/d3-selection#selectAll) - select multiple elements from the document. -* [d3.selection](https://github.com/d3/d3-selection#selection) - select the root document element. +* [*selection*.select](https://github.com/d3/d3-selection#selection_select) - select a descendant element for each selected element. +* [*selection*.selectAll](https://github.com/d3/d3-selection#selection_selectAll) - select multiple descendants for each selected element. +* [*selection*.filter](https://github.com/d3/d3-selection#selection_filter) - filter elements based on data. + +### Transformation + * [*selection*.attr](https://github.com/d3/d3-selection#selection_attr) - get or set an attribute. * [*selection*.classed](https://github.com/d3/d3-selection#selection_classed) - get, add or remove CSS classes. * [*selection*.style](https://github.com/d3/d3-selection#selection_style) - get or set a style property. @@ -453,27 +461,36 @@ Transform the DOM by selecting elements and joining to data. * [*selection*.html](https://github.com/d3/d3-selection#selection_html) - get or set the inner HTML. * [*selection*.append](https://github.com/d3/d3-selection#selection_append) - create, append and select new elements. * [*selection*.remove](https://github.com/d3/d3-selection#selection_remove) - remove elements from the document. +* [*selection*.sort](https://github.com/d3/d3-selection#selection_sort) - sort elements in the document based on data. +* [*selection*.order](https://github.com/d3/d3-selection#selection_order) - reorders elements in the document to match the selection. + +### Data + * [*selection*.data](https://github.com/d3/d3-selection#selection_data) - join elements to data. * [*selection*.enter](https://github.com/d3/d3-selection#selection_enter) - get the enter selection (data missing elements). * [*selection*.exit](https://github.com/d3/d3-selection#selection_exit) - get the exit selection (elements missing data). * [*selection*.datum](https://github.com/d3/d3-selection#selection_datum) - get or set element data (without joining). -* [*selection*.filter](https://github.com/d3/d3-selection#selection_filter) - filter elements based on data. -* [*selection*.sort](https://github.com/d3/d3-selection#selection_sort) - sort elements in the document based on data. -* [*selection*.order](https://github.com/d3/d3-selection#selection_order) - reorders elements in the document to match the selection. + +### Events + * [*selection*.on](https://github.com/d3/d3-selection#selection_on) - add or remove event listeners. +* [*selection*.dispatch](https://github.com/d3/d3-selection#selection_dispatch) - dispatch a custom event. +* [d3.event](https://github.com/d3/d3-selection#event) - the current user event, during interaction. +* [d3.mouse](https://github.com/d3/d3-selection#mouse) - get the mouse position relative to a given container. +* [d3.touch](https://github.com/d3/d3-selection#touch) - get a touch position relative to a given container. +* [d3.touches](https://github.com/d3/d3-selection#touches) - get the touch positions relative to a given container. + +### Control + * [*selection*.each](https://github.com/d3/d3-selection#selection_each) - call a function for each element. * [*selection*.call](https://github.com/d3/d3-selection#selection_call) - call a function with this selection. * [*selection*.empty](https://github.com/d3/d3-selection#selection_empty) - returns true if this selection is empty. * [*selection*.nodes](https://github.com/d3/d3-selection#selection_nodes) - returns an array of all selected elements. * [*selection*.node](https://github.com/d3/d3-selection#selection_node) - returns the first (non-null) element. * [*selection*.size](https://github.com/d3/d3-selection#selection_size) - returns the count of elements. -* [*selection*.select](https://github.com/d3/d3-selection#selection_select) - select a descendant element for each selected element. -* [*selection*.selectAll](https://github.com/d3/d3-selection#selection_selectAll) - select multiple descendants for each selected element. -* [*selection*.dispatch](https://github.com/d3/d3-selection#selection_dispatch) - dispatch a custom event. -* [d3.event](https://github.com/d3/d3-selection#event) - the current user event, during interaction. -* [d3.mouse](https://github.com/d3/d3-selection#mouse) - get the mouse position relative to a given container. -* [d3.touch](https://github.com/d3/d3-selection#touch) - get a touch position relative to a given container. -* [d3.touches](https://github.com/d3/d3-selection#touches) - get the touch positions relative to a given container. + +### Namespaces + * [d3.namespace](https://github.com/d3/d3-selection#namespace) - qualify a prefixed XML name, such as “xlink:href”. * [d3.namespaces](https://github.com/d3/d3-selection#namespaces) - the built-in XML namespaces. * [d3.requote](https://github.com/d3/d3-selection#requote) - quote a string for use in a regular expression.