Members

dataBuf

src/Grid.js, line 125

A Uint8Array for the raw data underlying the Grid

height

src/Grid.js, line 120

How tall the Grid is

width

src/Grid.js, line 115

How wide the Grid is

Methods

static diff(src, dst) → {Array.<object>|null}

src/Grid.js, line 227

Compares two Grids and returns an Array of the differences. Grids must be the same height and width.

Parameters:

Name	Type	Description
src	Grid	The first grid to compare.
dst	Grid	The second grid to compare.

Returns:

Array.<object> | null -

An Array of Objects describing the differences. Object for each change is {x, y, srcVal, dstVal}. Returns null if there are no differences.

static from(val)

src/Grid.js, line 199

Creates a new Grid from an Array of strings.

Parameters:

Name	Type	Description
val	Array.<string>	An array of equal length strings to set the initial value of the Grid. The Grid height will be equal to the number of elements in the array, and the width will be equal to the length of the strings.

clear()

src/Grid.js, line 174

Resets all data in the Grid to zero.

copy() → {Grid}

src/Grid.js, line 161

Creates a copy of the Grid with the same values but different underlying data.

Returns:

Grid -

A duplicate of the Grid

forEach(cb)

src/Grid.js, line 183

Iterates all the cells of the Grid

Parameters:

Name	Type	Description
cb	function	Called for each cell of the Grid. Signature is cb(value, x, y, grid).

toString() → {string}

src/Grid.js, line 140

Convert the Grid to a human-readable string. If converter was specified as an option during construction, it is used to convert each element.

Returns:

string -

A human-readable string representing the Grid.