Class: CellCoords

CellCoords

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

3rdparty/walkontable/src/cell/coords.js#L6

Members

colNumber

Column index.

rowNumber

Row index.

Methods

3rdparty/walkontable/src/cell/coords.js#L52

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}
3rdparty/walkontable/src/cell/coords.js#L96

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}
3rdparty/walkontable/src/cell/coords.js#L76

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}
3rdparty/walkontable/src/cell/coords.js#L66

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}
3rdparty/walkontable/src/cell/coords.js#L86

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}
3rdparty/walkontable/src/cell/coords.js#L33

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}
3rdparty/walkontable/src/cell/coords.js#L105

toObject(){Object}

Converts CellCoords to literal object with row and col properties.

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