CSVLoader

Streaming loader for comma-separated value and delimiter-separated value encoded files.

Loader	Characteristic
File Format	CSV
Data Format	Tables
File Type	Text
File Extension	.csv, .tsv, .dsv
MIME Types	text/csv, text/tab-separated-values, text/dsv
Supported APIs	load, parse, parseSync, parseInBatches

Usage

import {load} from '@loaders.gl/core';
import {CSVLoader} from '@loaders.gl/csv';

const data = await load(url, CSVLoader);
// or
const data = await load(url, CSVLoader, {csv: options});

A complication with the CSV format is that CSV files can come with or without an initial header line. While the CSVLoader will attempt to detect if the first line is a header, this can fail. If you know the format of the file you can use options.csv.header to specify how to handle the first line.

import {load} from '@loaders.gl/core';
import {CSVLoader} from '@loaders.gl/csv';

const data = await load(url_to_csv_with_header, CSVLoader, {csv: {header: true});
const data = await load(url_to_csv_without_header, CSVLoader, {csv: {header: false});

Options

Option	Type	Default	Description
csv.shape	'object-row-table' | 'array-row-table'	object-row-table	Output rows as objects keyed by column name or as arrays of values.
csv.optimizeMemoryUsage	boolean	false	Optimize memory usage at the cost of additional parsing time.
csv.header	boolean | 'auto'	auto	If true, treat the first row as field names. If false, treat the first row as data. 'auto' attempts to detect headers.
csv.columnPrefix	string	column	Prefix used when generating column names for files without headers (for example, column1, column2, ...).
csv.quoteChar	string	"	Character used to quote fields.
csv.escapeChar	string	"	Character used to escape the quote character within a field.
csv.dynamicTyping	boolean	true	Convert numeric and boolean values from strings to their native types.
csv.comments	boolean	false	Skip lines that start with a comment indicator.
csv.skipEmptyLines	boolean | 'greedy'	true	Skip empty lines; 'greedy' also skips lines that only contain whitespace.
csv.delimitersToGuess	string[]	[',', '\t', '|', ';']	Delimiters to try when no delimiter is specified.