d3-fetch

This module provides convenient parsing on top of Fetch. For example, to load a text file:

d3.text("/path/to/file.txt").then(function(text) {
  console.log(text); // Hello, world!
});

To load and parse a CSV file:

d3.csv("/path/to/file.csv").then(function(data) {
  console.log(data); // [{"Hello": "world"}, …]
});

This module has built-in support for parsing JSON, CSV, and TSV. You can parse additional formats by using text directly. (This module replaced d3-request.)

Installing

If you use NPM, `npm install d3-fetch`. Otherwise, download the latest release. You can also load directly from d3js.org as a standalone library. AMD, CommonJS, and vanilla environments are supported. In vanilla, a d3 global is exported:

<script src="https://d3js.org/d3-dsv.v1.min.js"></script>
<script src="https://d3js.org/d3-fetch.v1.min.js"></script>
<script>

d3.csv("/path/to/file.csv").then(function(data) {
  console.log(data); // [{"Hello": "world"}, …]
});

</script>

API Reference

<a name="blob" href="#blob">#</a> d3.blob(input[, init]) [<>](https://github.com/d3/d3-fetch/blob/master/src/blob.js "Source")

Fetches the binary file at the specified input URL as a Blob. If init is specified, it is passed along to the underlying call to fetch; see RequestInit for allowed fields.

<a name="buffer" href="#buffer">#</a> d3.buffer(input[, init]) [<>](https://github.com/d3/d3-fetch/blob/master/src/buffer.js "Source")

Fetches the binary file at the specified input URL as an ArrayBuffer. If init is specified, it is passed along to the underlying call to fetch; see RequestInit for allowed fields.

<a name="csv" href="#csv">#</a> d3.csv(input[, init][, row]) [<>](https://github.com/d3/d3-fetch/blob/master/src/dsv.js "Source")

Equivalent to d3.dsv with the comma character as the delimiter.

<a name="dsv" href="#dsv">#</a> d3.dsv(delimiter, input[, init][, row]) [<>](https://github.com/d3/d3-fetch/blob/master/src/dsv.js "Source")

Fetches the DSV file at the specified input URL. If init is specified, it is passed along to the underlying call to fetch; see RequestInit for allowed fields. An optional row conversion function may be specified to map and filter row objects to a more-specific representation; see dsv.parse for details. For example:

d3.dsv(",", "test.csv", function(d) {
  return {
    year: new Date(+d.Year, 0, 1), // convert "Year" column to Date
    make: d.Make,
    model: d.Model,
    length: +d.Length // convert "Length" column to number
  };
}).then(function(data) {
  console.log(data);
});

If only one of init and row is specified, it is interpreted as the row conversion function if it is a function, and otherwise an init object.

See also d3.csv and d3.tsv.

<a name="html" href="#html">#</a> d3.html(input[, init]) [<>](https://github.com/d3/d3-fetch/blob/master/src/xml.js "Source")

Fetches the file at the specified input URL as text and then parses it as HTML. If init is specified, it is passed along to the underlying call to fetch; see RequestInit for allowed fields.

<a name="image" href="#image">#</a> d3.image(input[, init]) [<>](https://github.com/d3/d3-fetch/blob/master/src/image.js "Source")

Fetches the image at the specified input URL. If init is specified, sets any additional properties on the image before loading. For example, to enable an anonymous cross-origin request:

d3.image("https://example.com/test.png", {crossOrigin: "anonymous"}).then(function(img) {
  console.log(img);
});

<a name="json" href="#json">#</a> d3.json(input[, init]) [<>](https://github.com/d3/d3-fetch/blob/master/src/json.js "Source")

Fetches the JSON file at the specified input URL. If init is specified, it is passed along to the underlying call to fetch; see RequestInit for allowed fields.

<a name="svg" href="#svg">#</a> d3.svg(input[, init]) [<>](https://github.com/d3/d3-fetch/blob/master/src/xml.js "Source")

Fetches the file at the specified input URL as text and then parses it as SVG. If init is specified, it is passed along to the underlying call to fetch; see RequestInit for allowed fields.

<a name="text" href="#text">#</a> d3.text(input[, init]) [<>](https://github.com/d3/d3-fetch/blob/master/src/text.js "Source")

Fetches the text file at the specified input URL. If init is specified, it is passed along to the underlying call to fetch; see RequestInit for allowed fields.

<a name="tsv" href="#tsv">#</a> d3.tsv(input[, init][, row]) [<>](https://github.com/d3/d3-fetch/blob/master/src/dsv.js "Source")

Equivalent to d3.dsv with the tab character as the delimiter.

<a name="xml" href="#xml">#</a> d3.xml(input[, init]) [<>](https://github.com/d3/d3-fetch/blob/master/src/xml.js "Source")

Fetches the file at the specified input URL as text and then parses it as XML. If init is specified, it is passed along to the underlying call to fetch; see RequestInit for allowed fields.