Spyral.Table(data, config) → {Spyral.Table}

The Spyral.Table class in Spyral provides convenience functions for working with tabular data.

There are several ways of initializing a Table, here are some of them:

Provide an array of data with 3 rows:

let table = createTable([1,2,3]);

Provide a nested array of data with multiple rows:

	let table = createTable([[1,2],[3,4]]);

Same nested array, but with a second argument specifying headers

	let table = createTable([[1,2],[3,4]], {headers: ["one","two"]});

Create table with comma-separated values:

let table = createTable("one,two\\n1,2\\n3,4");

Create table with tab-separated values

	let table = createTable("one\\ttwo\\n1\\t2\\n3\\t4");

Create table with array of objects

let table = createTable([{one:1,two:2},{one:3,two:4}]);

It's also possible simple to create a sorted frequency table from an array of values:

	let table = createTable(["one","two","one"], {count: "vertical", headers: ["Term","Count"]})

Working with a Corpus is easy. For instance, we can create a table from the top terms:

	loadCorpus("austen").terms({limit:500, stopList: 'auto'}).then(terms => {
		return createTable(terms);
	})

Similarly, we could create a frequency table from the first 1,000 words of the corpus:

	loadCorpus("austen").words({limit:1000, docIndex: 0, stopList: 'auto'}).then(words => {
		return createTable(words, {count: "vertical"});
	});

Some of the configuration options are as follows:

  • format: especially for forcing csv or tsv when the data is a string
  • hasHeaders: determines if data has a header row (usually determined automatically)
  • headers: a Array of Strings that serve as headers for the table
  • count: forces Spyral to create a sorted frequency table from an Array of data, this can be set to "vertical" if the counts are shown vertically or set to true if the counts are shown horizontally

Tables are convenient in Spyral because you can simply show them to preview a version in HTML.

new Table(data, config) → {Spyral.Table}
voyantjs/src/table.js, line 67

Create a new Table

Parameters:
Name Type Description
data Object | Array | String | Number

An array of data or a string with CSV or TSV.
config Spyral.Table~TableConfig

an Object for configuring the table initialization
Returns:
Spyral.Table

Methods

addColumn(config, ind) → {Spyral.Table}
voyantjs/src/table.js, line 426

Add a column (at the specified index)

Parameters:
Name Type Description
config Object | String
ind number | string
Returns:
Spyral.Table

addRow(data) → {Spyral.Table}
voyantjs/src/table.js, line 229

Add a row to the Table

Parameters:
Name Type Description
data Array | Object
Returns:
Spyral.Table

addRows(data) → {Spyral.Table}
voyantjs/src/table.js, line 219

Add rows to the Table

Parameters:
Name Type Description
data Array
Returns:
Spyral.Table

cell(rowInd, colInd) → {number}
voyantjs/src/table.js, line 346

Get the value of a cell

Parameters:
Name Type Description
rowInd number | string

The row index
colInd number | string

The column index
Returns:
number

chart(targetopt, configopt) → {Highcharts.Chart}
voyantjs/src/table.js, line 1104

Show a chart representing the Table

Parameters:
Name Type Attributes Description
target String | HTMLElement <optional>
config HighchartsConfig <optional>
Returns:
Highcharts.Chart

column(ind, asObjopt) → {Object|Number|String}
voyantjs/src/table.js, line 600

Get the specified column

Parameters:
Name Type Attributes Description
ind number | string
asObj boolean <optional>
Returns:
Object | Number | String

columnCounts(ind) → {number}
voyantjs/src/table.js, line 763

Get the count of each unique value in the specified column

Parameters:
Name Type Description
ind number | string
Returns:
number

columnMax(ind) → {number}
voyantjs/src/table.js, line 709

Get the maximum value in the specified column

Parameters:
Name Type Description
ind number | string
Returns:
number

columnMean(ind) → {number}
voyantjs/src/table.js, line 745

Get the mean of the values in the specified column

Parameters:
Name Type Description
ind number | string
Returns:
number

columnMin(ind) → {number}
voyantjs/src/table.js, line 700

Get the minimum value in the specified column

Parameters:
Name Type Description
ind number | string
Returns:
number

columnRollingMean(ind, neighbors, overwrite) → {Array}
voyantjs/src/table.js, line 789

Get the rolling mean for the specified column

Parameters:
Name Type Description
ind number | string
neighbors number
overwrite boolean
Returns:
Array

columnSort() → {Spyral.Table}
voyantjs/src/table.js, line 913

TODO Sort the specified columns

Returns:
Spyral.Table

columnStandardDeviation(ind) → {number}
voyantjs/src/table.js, line 829

Get the standard deviation for the specified column

Parameters:
Name Type Description
ind number | string
Returns:
number

columnSum(ind) → {number}
voyantjs/src/table.js, line 727

Get the sum of the values in the specified column

Parameters:
Name Type Description
ind number | string
Returns:
number

columnVariance(ind) → {number}
voyantjs/src/table.js, line 811

Get the variance for the specified column

Parameters:
Name Type Description
ind number | string
Returns:
number

columnZScores(ind) → {Array}
voyantjs/src/table.js, line 847

Get the z scores for the specified column

Parameters:
Name Type Description
ind number | string
Returns:
Array

columns(indsopt, configopt) → {Number|Array}
voyantjs/src/table.js, line 546

This function returns different values depending on the arguments provided. When there are no arguments, it returns the number of columns in this table. When the first argument is the boolean value true all columns are returned. When the first argument is a number a slice of the columns is returned and if the second argument is a number it is treated as the length of the slice to return (note that it isn't the end index like with Array.slice()).

Parameters:
Name Type Attributes Description
inds Boolean | Array | Number | String <optional>
config Object | Number | String <optional>
Returns:
Number | Array

forEach(fn)
voyantjs/src/table.js, line 673

Runs the specified function on each row. The function is passed the row and the row index.

Parameters:
Name Type Description
fn function

getColumnIndex(ind, create) → {number}
voyantjs/src/table.js, line 399

Get (and create) the column index

Parameters:
Name Type Description
ind number | string

The index
create boolean
Returns:
number

getRowIndex(ind, create) → {number}
voyantjs/src/table.js, line 368

Get (and create) the row index

Parameters:
Name Type Description
ind number | string

The index
create boolean
Returns:
number

hasColumn(ind) → {number|string}
voyantjs/src/table.js, line 664

Does the specified column exist

Parameters:
Name Type Description
ind number | string
Returns:
number | string

Get the specified header

Parameters:
Name Type Description
ind number | string
Returns:
number | string

headers(inds) → {Number|Array}
voyantjs/src/table.js, line 634

This function returns different values depending on the arguments provided. When there are no arguments, it returns the number of headers in this table. When the first argument is the boolean value true all headers are returned. When the first argument is a number a slice of the headers is returned. When the first argument is an array the slices specified in the array are returned.

Parameters:
Name Type Description
inds Boolean | Array | Number | String
Returns:
Number | Array

html(target, configopt) → {Spyral.Table}
voyantjs/src/table.js, line 1016

Set the target's contents to an HTML representation of the Table

Parameters:
Name Type Attributes Description
target function | String | Object
config Object <optional>
Returns:
Spyral.Table

row(ind, asObjopt) → {Object|Number|String}
voyantjs/src/table.js, line 522

Get the specified row

Parameters:
Name Type Attributes Description
ind number | string
asObj boolean <optional>
Returns:
Object | Number | String

rowCounts(ind) → {number}
voyantjs/src/table.js, line 754

Get the count of each unique value in the specified row

Parameters:
Name Type Description
ind number | string
Returns:
number

rowMax(ind) → {number}
voyantjs/src/table.js, line 691

Get the maximum value in the specified row

Parameters:
Name Type Description
ind number | string
Returns:
number

rowMean(ind) → {number}
voyantjs/src/table.js, line 736

Get the mean of the values in the specified row

Parameters:
Name Type Description
ind number | string
Returns:
number

rowMin(ind) → {number}
voyantjs/src/table.js, line 682

Get the minimum value in the specified row

Parameters:
Name Type Description
ind number | string
Returns:
number

rowRollingMean(ind, neighbors, overwrite) → {Array}
voyantjs/src/table.js, line 774

Get the rolling mean for the specified row

Parameters:
Name Type Description
ind number | string
neighbors number
overwrite boolean
Returns:
Array

rowSort() → {Spyral.Table}
voyantjs/src/table.js, line 856

TODO Sort the specified rows

Returns:
Spyral.Table

rowStandardDeviation(ind) → {number}
voyantjs/src/table.js, line 820

Get the standard deviation for the specified row

Parameters:
Name Type Description
ind number | string
Returns:
number

rowSum(ind) → {number}
voyantjs/src/table.js, line 718

Get the sum of the values in the specified row

Parameters:
Name Type Description
ind number | string
Returns:
number

rowVariance(ind) → {number}
voyantjs/src/table.js, line 802

Get the variance for the specified row

Parameters:
Name Type Description
ind number | string
Returns:
number

rowZScores(ind) → {Array}
voyantjs/src/table.js, line 838

Get the z scores for the specified row

Parameters:
Name Type Description
ind number | string
Returns:
Array

rows(indsopt, configopt) → {Number|Array}
voyantjs/src/table.js, line 468

This function returns different values depending on the arguments provided. When there are no arguments, it returns the number of rows in this table. When the first argument is the boolean value true all rows are returned. When the first argument is a an array then the rows corresponding to the row indices or names are returned. When all arguments except are numbers or strings then each of those is returned.

Parameters:
Name Type Attributes Description
inds Boolean | Array | Number | String <optional>
config Object | Number | String <optional>
Returns:
Number | Array

setCell(row, column, value) → {Spyral.Table}
voyantjs/src/table.js, line 357

Set the value of a cell

Parameters:
Name Type Description
row number | string

The row index
column number | string

The column index
value number

The value to set
Returns:
Spyral.Table

setColumn(ind, data, create) → {Spyral.Table}
voyantjs/src/table.js, line 298

Set a column

Parameters:
Name Type Description
ind number | string

The column index
data Object | Array
create boolean
Returns:
Spyral.Table

setHeaders(data) → {Spyral.Table}
voyantjs/src/table.js, line 199

Set the headers for the Table

Parameters:
Name Type Description
data Object | Array
Returns:
Spyral.Table

setRow(ind, data, create) → {Spyral.Table}
voyantjs/src/table.js, line 247

Set a row

Parameters:
Name Type Description
ind number | string

The row index
data Object | Array
create boolean
Returns:
Spyral.Table

toArray(rowsAsObjectsopt) → {Array}
voyantjs/src/table.js, line 996

Get an array of the rows of the Table.

Parameters:
Name Type Attributes Default Description
rowsAsObjects Boolean <optional>
 false

If true, each row will be returned as an object with the headers as keys
Returns:
Array

toCsv(configopt) → {string}
voyantjs/src/table.js, line 972

Get a CSV representation of the Table

Parameters:
Name Type Attributes Description
config Object <optional>
Returns:
string

toDataTable(targetopt, config) → {DataTable}
voyantjs/src/table.js, line 1047

Displays an interactive table using DataTables

Parameters:
Name Type Attributes Description
target HTMLElement <optional>
config Object
Returns:
DataTable

toHtml()
voyantjs/src/table.js, line 1037

Same as toString.

toString(configopt) → {string}
voyantjs/src/table.js, line 1075

Get an HTML representation of the Table

Parameters:
Name Type Attributes Description
config Object <optional>
Returns:
string

toTsv(configopt) → {string}
voyantjs/src/table.js, line 986

Get a TSV representation of the Table

Parameters:
Name Type Attributes Description
config Object <optional>
Returns:
string

updateCell(row, column, value, overwrite)
voyantjs/src/table.js, line 332

Add to or set a cell value

Parameters:
Name Type Description
row number | string

The row index
column number | string

The column index
value number

The value to set/add
overwrite boolean

True to set, false to add to current value

static cmp(a, b) → {number}
voyantjs/src/table.js, line 1220

Compare two values

Parameters:
Name Type Description
a number | string
b number | string
Returns:
number

static counts(data) → {Object}
voyantjs/src/table.js, line 1207

Get the count of each unique value in the data

Parameters:
Name Type Description
data Array
Returns:
Object

static create(data, config) → {Spyral.Table}
voyantjs/src/table.js, line 1178

Create a new Table

Parameters:
Name Type Description
data Object | Array | String | Number
config Spyral.Table~TableConfig
Returns:
Spyral.Table

static fetch(input, api, config) → {Promise}
voyantjs/src/table.js, line 1190

Fetch a Table from a source

Parameters:
Name Type Description
input String | Request
api Object
config Object
Returns:
Promise

static mean(data) → {number}
voyantjs/src/table.js, line 1240

Get the mean of the provided values

Parameters:
Name Type Description
data Array
Returns:
number

static rollingMean(data, neighbors) → {Array}
voyantjs/src/table.js, line 1251

Get rolling mean for the provided values

Parameters:
Name Type Description
data Array
neighbors number
Returns:
Array

static standardDeviation(data) → {number}
voyantjs/src/table.js, line 1278

Get the standard deviation for the provided values

Parameters:
Name Type Description
data Array
Returns:
number

static sum(data) → {number}
voyantjs/src/table.js, line 1230

Get the sum of the provided values

Parameters:
Name Type Description
data Array
Returns:
number

static variance(data) → {number}
voyantjs/src/table.js, line 1267

Get the variance for the provided values

Parameters:
Name Type Description
data Array
Returns:
number

static zScores(data) → {Array}
voyantjs/src/table.js, line 1288

Get the z scores for the provided values

Parameters:
Name Type Description
data Array
Returns:
Array

static zip(…data) → {Array}
voyantjs/src/table.js, line 1300

Perform a zip operation of the provided arrays. Learn more about zip on Wikipedia.

Parameters:
Name Type Attributes Description
data Array <repeatable>
Returns:
Array

Type Definitions

TableConfig
voyantjs/src/table.js, line 68

The Table config object

Properties:
Name Type Description
format string

The format of the provided data, either "tsv" or "csv"
headers Object | Array

The table headers
hasHeaders boolean

True if the headers are the first item in the data
count string

Specify "vertical" or "horizontal" to create a table of unique item counts in the provided data