## zinface / d3

Explore and code with more than 6 million developers，Free private repositories ！：）
API.md 137.35 KB
Mike Bostock authored 2019-12-29 08:50 . Update dependencies.

# D3 API Reference

D3 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 major versions, see CHANGES; see also the release notes and the 3.x reference.

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

## Arrays (d3-array)

Array manipulation, ordering, searching, summarizing, etc.

### Statistics

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.

### Search

Methods for searching arrays for a specific element.

### Transformations

Methods for transforming arrays and for generating new arrays.

• d3.cross - compute the Cartesian product of two 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.tickIncrement - 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.

### Histograms

Bin discrete samples into continuous, non-overlapping intervals.

## Brushes (d3-brush)

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

## Collections (d3-collection)

Handy data structures for elements keyed by string.

### Objects

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.

### Maps

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.

### Sets

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.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.

### Nests

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.

## Colors (d3-color)

Color manipulation and color space conversion.

## Color Schemes (d3-scale-chromatic)

Color ramps and palettes for quantitative, ordinal and categorical scales.

## Contours (d3-contour)

Compute contour polygons using marching squares.

## Dispatches (d3-dispatch)

Separate concerns using named callbacks.

## Dragging (d3-drag)

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

## Delimiter-Separated Values (d3-dsv)

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

## Easings (d3-ease)

Easing functions for smooth animation.

## Fetches (d3-fetch)

Convenience methods on top of the Fetch API.

• d3.blob - get a file as a blob.
• d3.buffer - get a file as an array buffer.
• d3.csv - get a comma-separated values (CSV) file.
• d3.dsv - get a delimiter-separated values (CSV) file.
• d3.image - get an image.
• d3.json - get a JSON file.
• d3.text - get a plain text file.
• d3.tsv - get a tab-separated values (TSV) file.

## Forces (d3-force)

Force-directed graph layout using velocity Verlet integration.

## Number Formats (d3-format)

Format numbers for human consumption.

## Geographies (d3-geo)

Geographic projections, shapes and math.

### Paths

• d3.geoPath - create a new geographic path generator.
• path - project and render the specified feature.
• path.area - compute the projected planar area of a given feature.
• path.bounds - compute the projected planar bounding box of a given feature.
• path.centroid - compute the projected planar centroid of a given feature.
• path.measure - compute the projected planar length of a given feature.
• path.projection - set the geographic projection.
• path.context - set the render context.

### Spherical 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.geoContains - test whether a point is inside 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.

## Hierarchies (d3-hierarchy)

Layout algorithms for visualizing hierarchical data.

## Interpolators (d3-interpolate)

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

## Paths (d3-path)

Serialize Canvas path commands to SVG.

## Polygons (d3-polygon)

Geometric operations for two-dimensional polygons.

Two-dimensional recursive spatial subdivision.

## Random Numbers (d3-random)

Generate random numbers from various distributions.

## Scales (d3-scale)

Encodings that map abstract data to visual representation.

### Continuous Scales

Map a continuous, quantitative domain to a continuous range.

### Sequential Scales

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

### Diverging Scales

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

### Quantize Scales

Map a continuous, quantitative domain to a discrete range.

### Ordinal Scales

Map a discrete domain to a discrete range.

## Selections (d3-selection)

Transform the DOM by selecting elements and joining to data.

## Shapes (d3-shape)

Graphical primitives for visualization.

### Arcs

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

### Pies

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

### Lines

A spline or polyline, as in a line chart.

### Areas

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

### Curves

Interpolate between points to produce a continuous shape.

A smooth cubic Bézier curve from a source to a target.

### Symbols

A categorical shape encoding, as in a scatterplot.

### Stacks

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

## Time Formats (d3-time-format)

Parse and format times, inspired by strptime and strftime.

## Time Intervals (d3-time)

A calculator for humanity’s peculiar conventions of time.

## Timers (d3-timer)

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.

## Transitions (d3-transition)

Animated transitions for selections.

## Voronoi Diagrams (d3-voronoi)

Compute the Voronoi diagram of a given set of points.

## Zooming (d3-zoom)

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