Skip to content

Latest commit

 

History

History
1166 lines (1001 loc) · 117 KB

API.md

File metadata and controls

1166 lines (1001 loc) · 117 KB

D3 API Reference

D3 4.0 is a collection of modules that are designed to work together; you can use the modules independently, or you can use them together as part of the default build. The source and documentation for each module is available in its repository. Follow the links below to learn more. For changes between 3.x and 4.0, see CHANGES; see also the 3.x reference.

D3 uses semantic versioning. The current version is exposed as d3.version.

Array manipulation, ordering, searching, summarizing, etc.

Methods for computing basic summary statistics.

  • d3.min - compute the minimum value in an array.
  • d3.max - compute the maximum value in an array.
  • d3.extent - compute the minimum and maximum value in an array.
  • d3.sum - compute the sum of an array of numbers.
  • d3.mean - compute the arithmetic mean of an array of numbers.
  • d3.median - compute the median of an array of numbers (the 0.5-quantile).
  • d3.quantile - compute a quantile for a sorted array of numbers.
  • d3.variance - compute the variance of an array of numbers.
  • d3.deviation - compute the standard deviation of an array of numbers.

Methods for searching arrays for a specific element.

Methods for transforming arrays and for generating new arrays.

  • d3.merge - merge multiple arrays into one array.
  • d3.pairs - create an array of adjacent pairs of elements.
  • d3.permute - reorder an array of elements according to an array of indexes.
  • d3.shuffle - randomize the order of an array.
  • d3.ticks - generate representative values from a numeric interval.
  • d3.tickStep - generate representative values from a numeric interval.
  • d3.range - generate a range of numeric values.
  • d3.transpose - transpose an array of arrays.
  • d3.zip - transpose a variable number of arrays.

Bin discrete samples into continuous, non-overlapping intervals.

Human-readable reference marks for scales.

Select a one- or two-dimensional region using the mouse or touch.

Handy data structures for elements keyed by string.

Methods for converting associative arrays (objects) to arrays.

  • d3.keys - list the keys of an associative array.
  • d3.values - list the values of an associated array.
  • d3.entries - list the key-value entries of an associative array.

Like ES6 Map, but with string keys and a few other differences.

  • d3.map - create a new, empty map.
  • map.has - returns true if the map contains the given key.
  • map.get - get the value for the given key.
  • map.set - set the value for the given key.
  • map.remove - remove the entry for given key.
  • map.clear - remove all entries.
  • map.keys - get the array of keys.
  • map.values - get the array of values.
  • map.entries - get the array of entries (key-values objects).
  • map.each - call a function for each entry.
  • map.empty - returns false if the map has at least one entry.
  • map.size - compute the number of entries.

Like ES6 Set, but with string keys and a few other differences.

  • d3.set - create a new, empty set.
  • set.has - returns true if the set contains the given value.
  • set.add - add the given value.
  • set.remove - remove the given value.
  • set.clear - remove all values.
  • set.values - get the array of values.
  • set.each - call a function for each value.
  • set.empty - returns true if the set has at least one value.
  • set.size - compute the number of values.

Group data into arbitrary hierarchies.

  • d3.nest - create a new nest generator.
  • nest.key - add a level to the nest hierarchy.
  • nest.sortKeys - sort the current nest level by key.
  • nest.sortValues - sort the leaf nest level by value.
  • nest.rollup - specify a rollup function for leaf values.
  • nest.map - generate the nest, returning a map.
  • nest.object - generate the nest, returning an associative array.
  • nest.entries - generate the nest, returning an array of key-values tuples.

Color manipulation and color space conversion.

Separate concerns using named callbacks.

Drag and drop SVG, HTML or Canvas using mouse or touch input.

Parse and format delimiter-separated values, most commonly CSV and TSV.

  • d3.dsvFormat - create a new parser and formatter for the given delimiter.
  • dsv.parse - parse the given string, returning an array of objects.
  • dsv.parseRows - parse the given string, returning an array of rows.
  • dsv.format - format the given array of objects.
  • dsv.formatRows - format the given array of rows.
  • d3.csvParse - parse the given CSV string, returning an array of objects.
  • d3.csvParseRows - parse the given CSV string, returning an array of rows.
  • d3.csvFormat - format the given array of objects as CSV.
  • d3.csvFormatRows - format the given array of rows as CSV.
  • d3.tsvParse - parse the given TSV string, returning an array of objects.
  • d3.tsvParseRows - parse the given TSV string, returning an array of rows.
  • d3.tsvFormat - format the given array of objects as TSV.
  • d3.tsvFormatRows - format the given array of rows as TSV.

Easing functions for smooth animation.

Force-directed graph layout using velocity Verlet integration.

Format numbers for human consumption.

Geographic projections, shapes and math.

  • d3.geoArea - compute the spherical area of a given feature.
  • d3.geoBounds - compute the latitude-longitude bounding box for a given feature.
  • d3.geoCentroid - compute the spherical centroid of a given feature.
  • d3.geoDistance - compute the great-arc distance between two points.
  • d3.geoLength - compute the length of a line string or the perimeter of a polygon.
  • d3.geoInterpolate - interpolate between two points along a great arc.
  • d3.geoRotation - create a rotation function for the specified angles.
  • rotation - rotate the given point around the sphere.
  • rotation.invert - unrotate the given point around the sphere.

Raw Projections

Layout algorithms for visualizing hierarchical data.

Interpolate numbers, colors, strings, arrays, objects, whatever!

Serialize Canvas path commands to SVG.

Geometric operations for two-dimensional polygons.

Two-dimensional recursive spatial subdivision.

Evaluate asynchronous tasks with configurable concurrency.

  • d3.queue - manage the concurrent evaluation of asynchronous tasks.
  • queue.defer - register a task for evaluation.
  • queue.abort - abort any active tasks and cancel any pending ones.
  • queue.await - register a callback for when tasks complete.
  • queue.awaitAll - register a callback for when tasks complete.

Generate random numbers from various distributions.

A convenient alternative to asynchronous XMLHttpRequest.

Encodings that map abstract data to visual representation.

Map a continuous, quantitative domain to a continuous range.

Map a continuous, quantitative domain to a continuous, fixed interpolator.

Map a continuous, quantitative domain to a discrete range.

Map a discrete domain to a discrete range.

Transform the DOM by selecting elements and joining to data.

  • selection.on - add or remove event listeners.
  • selection.dispatch - dispatch a custom event.
  • d3.event - the current user event, during interaction.
  • d3.customEvent - temporarily define a custom event.
  • d3.mouse - get the mouse position relative to a given container.
  • d3.touch - get a touch position relative to a given container.
  • d3.touches - get the touch positions relative to a given container.

Graphical primitives for visualization.

Circular or annular sectors, as in a pie or donut chart.

Compute the necessary angles to represent a tabular dataset as a pie or donut chart.

A spline or polyline, as in a line chart.

An area, defined by a bounding topline and baseline, as in an area chart.

Interpolate between points to produce a continuous shape.

A categorical shape encoding, as in a scatterplot.

Stack shapes, placing one adjacent to another, as in a stacked bar chart.

Parse and format times, inspired by strptime and strftime.

A calculator for humanity’s peculiar conventions of time.

An efficient queue for managing thousands of concurrent animations.

  • d3.now - get the current high-resolution time.
  • d3.timer - schedule a new timer.
  • timer.restart - reset the timer’s start time and callback.
  • timer.stop - stop the timer.
  • d3.timerFlush - immediately execute any eligible timers.
  • d3.timeout - schedule a timer that stops on its first callback.
  • d3.interval - schedule a timer that is called with a configurable period.

Animated transitions for selections.

Compute the Voronoi diagram of a given set of points.

Pan and zoom SVG, HTML or Canvas using mouse or touch input.