array-2d-js
v1.0.1
Published
Array2D is an auxiliary tool to create, manage and manipulate 2d arrays.
Downloads
9
Maintainers
Readme
Array2D
Array2D is an auxiliary tool to create, manage and manipulate 2d arrays. I made this component to help me develop board game prototypes. If you want to use this component, please! If you want to modify or expand this component, you are welcome to do so. See notes in contribution.
Installation
$ npm i Array2D --save
Usage
import Array2D from 'array-2d-js'
export default class Map extends Array2D {
constructor (width, height) {
super(width, height)
}
}
or
import Array2D from 'array-2d-js'
const array2D = new Array2D(10, 10)
or
const Array2D = require("array-2d-js")
const array2D = new Array2D(10, 10)
API
constructor
Intitialize Array2D class.
Parameters
width
Number Number corresponding with the width(column count) of the 2d array.height
Number Number corresponding with the height(row count) of the 2d array.
getColumn
Return the column of the given position.
Parameters
position
Number Position for the column.
Returns Array Returns the column.
addColumn
Add the column at the given position.
Parameters
position
Number Position for the column.
removeColumn
Remove the column at the given position.
Parameters
position
Number Position for the column.
fillColumn
Executes the provided function once for each array element for column at given position.
Parameters
clearColumn
Clear the column at the given position.
Parameters
position
Number Position for the column.
condenseColumns
Condense the 2d array to the minimum by removing all the empty columns on the outside. This process is irreversible.
getRow
Get the row of the given position.
Parameters
position
Number Position for the row.
Returns Array Returns the row.
addRow
Add the row at the given position.
Parameters
position
Number Position for the row.
removeRow
Remove the row at the given position.
Parameters
position
Number Position for the row.
fillRow
Executes the provided function once for each array element for row at given position.
Parameters
clearRow
Clear the row at the given position.
Parameters
position
Number Position for the row.
condenseRows
Condense the 2d array to the minimum by removing all the empty rows on the outside. This process is irreversible.
getPosition
Get the item of the given position.
Parameters
Returns any Returns the item.
fillPosition
Fill position with item
Parameters
x
Number Column position for in the 2d array.y
Number Row position for in the 2d array.item
any Item for in the 2d array.
clearPosition
Clear given position
Parameters
findPosition
Find the postion for given item
Parameters
item
any Item for which you want to find the position.
Returns any Item position.
forEach
Executes a provided function once for each 2d array element.
Parameters
f
function Fill function for the 2d array.
condense
Condense the 2d array to the minimum by removing all the empty rows and columns on the outside. This process is irreversible.
array2D
Returns the 2d array.
Returns Array2D Returns the 2d array.
width
return the width(column count) of the 2d array.
Returns Number Returns the width of the 2d array.
height
return the height(row count) of the 2d array.
Returns Number Returns the height of the 2d array.
Contributing
Issues are welcome. The best way to report a problem is to reproduce it with a code example.
Pull requests are welcome. If you want to change the API, it's better to discuss it using an issue ticket.
License
Array2D is MIT licensed.