This is a documentation of an earlier version of Handsontable.

# CellCoords

# Members

# col

Source code (opens new window)

cellCoords.col : number

Column index.

# row

Source code (opens new window)

cellCoords.row : number

Row index.

# Methods

# clone

Source code (opens new window)

cellCoords.clone() ⇒ CellCoords

Clones the coordinates.

# isEqual

Source code (opens new window)

cellCoords.isEqual(cellCoords) ⇒ boolean

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

Param Type Description
cellCoords CellCoords Cell coordinates to equal.

# isNorthEastOf

Source code (opens new window)

cellCoords.isNorthEastOf(testedCoords) ⇒ boolean

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

Param Type Description
testedCoords object Cell coordinates to check.

# isNorthWestOf

Source code (opens new window)

cellCoords.isNorthWestOf(testedCoords) ⇒ boolean

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

Param Type Description
testedCoords object Cell coordinates to check.

# isSouthEastOf

Source code (opens new window)

cellCoords.isSouthEastOf(testedCoords) ⇒ boolean

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

Param Type Description
testedCoords object Cell coordinates to check.

# isSouthWestOf

Source code (opens new window)

cellCoords.isSouthWestOf(testedCoords) ⇒ boolean

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

Param Type Description
testedCoords object Cell coordinates to check.

# isValid

Source code (opens new window)

cellCoords.isValid(wot) ⇒ boolean

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

Param Type Description
wot Walkontable A Walkontable instance.

# normalize

Source code (opens new window)

cellCoords.normalize() ⇒ CellCoords

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

# toObject

Source code (opens new window)

cellCoords.toObject() ⇒ object

Converts CellCoords to literal object with row and col properties.

Returns: object - Returns a literal object with row and col properties.

Last Updated: Nov 30, 2021