Cell - Documentation

new Cell(x, y)

Source:

cell.js, line 6

Parameters:

Name	Type	Description
`x`	number
`y`	number

Members

(readonly) x :number

Source:

cell.js, line 98

Type:

number

(readonly) y :number

Source:

cell.js, line 106

Type:

number

(readonly) neighbors :Array.<Neighbor>

Source:

cell.js, line 114

Type:

Array.<Neighbor>

(readonly) row :Row

Source:

cell.js, line 122

Type:

(readonly) data :*

Source:

cell.js, line 130

Type:

Methods

getRelativePosition(cell) → {RelativePosition}

Source:

cell.js, line 24

Parameters:

Name	Type	Description
`cell`	Cell

Returns:

Type: RelativePosition

getAxisCells(axis, pathopt, axisCellsopt) → {Array.<Cell>}

Source:

cell.js, line 59

Example

getAxisCells(RelativePosition.AXIS.VERTICAL)

Parameters:

Name	Type	Attributes	Default
`axis`	Axis
`path`	string	<optional>
`axisCells`	string	<optional>	`[]`

Returns:

Type: Array.<Cell>

getNeighborByCell(cell) → {Neighbor}

Source:

cell.js, line 90

Parameters:

Name	Type	Description
`cell`	Cell

Returns:

Type: Neighbor