Array2D

Javascript library for managing 2D arrays

For arrays of more than 2 dimensions, see ArrayND

Constructors

array2D(x, y)				//creates a new array2D object, with dimensions (x, y)
array2D(x, y, default)		//same as above, but sets the default value and fills all elements
array2D(<array2D>)			//copy constructor

API Functions

All API functions operate in-place (on the existing array).

All callback functions are of the format:

function(value, x, y, array2D)

All rectangular area parameters follow the format:

(x, y, width, height)

###Traversal

forEach(callback)							//iterates over all elements
forArea(x, y, width, height, callback)		//iterates over the given rectangular area
forRow(y, callback)							//iterates over the given row
forCol(x, callback)							//iterates over the given column

###Fill Statements

fill(value)						//sets all elements to the given value
fill()							//if no value is given, the default value will be used

fillRow(y, value)				//sets each element of the row or column to the given value
fillCol(x, value)
fillRow(y)						//if no value is given, the default value will be used
fillCol(x)

fillArea(x, y, w, h, value)		//set rectangular area to the given value
fillArea(x, y, w, h)			//if no value is given, the default value will be used

###2D Operations

Resize the array by relatively adding or deleting the specified number of rows or columns. Positive numbers add, negative numbers delete. New elements will be filled with the default value.

resize(right, bottom, left, top)

Reduce the array to the given rectangular area by deleting elements.

crop(x, y, width, height)

Shift the array by the specified number of rows and columns. Negative shifts are welcome. Note: data that has been shifted out of bounds will be lost. New values (on the opposite edge) will be set to the default value.

shift(x, y)

Rotate the array 90 degrees in the specified direction.

rotate(clockwise)

Inverts the array across the X or Y axis.

invertX()
invertY()

###Row and Column Operations

getRow(y)				//returns the row or column as an array
getCol(x)

setRow(y, array)		//sets the row or column to the contents of the array
setCol(x, array)

swapRow(y1, y2)			//swaps the specified rows or columns
swapCol(x1, x2)

deleteRow(y)			//deletes the specified row or column
deleteCol(x)

###Debug & Misc

log()					//prints the array to the console
log(callback)			//optional callback for element rendering (please return your value)
inBounds(x, y)			//return true/false whether the point is within the array
inBounds(x, y, w, h)	//return true/false whether the rectangular area is within the array