CellCoords

CellCoords holds cell coordinates (row, column) and few method to validate them and retrieve as an array or an object.

Members

colnumber

Column index.

rownumber

Row index.

Methods

clone(){CellCoords}

Clones the coordinates.

Returns: {CellCoords}

isEqual(cellCoords){boolean}

Checks if this cell coordinates are the same as cell coordinates given as an argument.

Parameters:
Name Type Description
cellCoords CellCoords

Cell coordinates to equal.

Returns: {boolean}

isNorthEastOf(testedCoords){boolean}

Checks if tested coordinates are positioned in north-east from this cell coordinates.

Parameters:
Name Type Description
testedCoords object

Cell coordinates to check.

Returns: {boolean}

isNorthWestOf(testedCoords){boolean}

Checks if tested coordinates are positioned in north-east from this cell coordinates.

Parameters:
Name Type Description
testedCoords object

Cell coordinates to check.

Returns: {boolean}

isSouthEastOf(testedCoords){boolean}

Checks if tested coordinates are positioned in south-east from this cell coordinates.

Parameters:
Name Type Description
testedCoords object

Cell coordinates to check.

Returns: {boolean}

isSouthWestOf(testedCoords){boolean}

Checks if tested coordinates are positioned in south-west from this cell coordinates.

Parameters:
Name Type Description
testedCoords object

Cell coordinates to check.

Returns: {boolean}

isValid(wot){boolean}

Checks if given set of coordinates is valid in context of a given Walkontable instance.

Parameters:
Name Type Description
wot Walkontable

A Walkontable instance.

Returns: {boolean}

normalize(){CellCoords}

Normalizes the coordinates to the nearest valid position. The coordinates that point
to the headers (negative values) are normalized to 0.

Returns: {CellCoords}

toObject(){object}

Converts CellCoords to literal object with row and col properties.

Returns: {object} Returns a literal object with row and col properties.
Class: CellCoords