Members

fromCellCoords

Usually the same as highlight, but in Excel there is distinction - one can change highlight within a selection.

highlightCellCoords

Used to draw bold border around a cell where selection was started and to edit the cell when you press Enter.

toCellCoords

End selection.

Methods

Source code

expand(cellCoords){Boolean}

Adds a cell to a range (only if exceeds corners of the range). Returns information if range was expanded.

Parameters:

Name	Type	Description
cellCoords	CellCoords

Returns: {Boolean}

Source code

expandByRange(expandingRange){Boolean}

Expand the current object by the range passed in the first argument.

Parameters:

Name	Type	Description
expandingRange	CellRange	Object extending the range.

Returns: {Boolean}

Source code

flipDirectionHorizontally()

Flip the direction horizontally. (e.g. NW-SE changes to NE-SW).

Source code

flipDirectionVertically()

Flip the direction vertically. (e.g. NW-SE changes to SW-NE).

Source code

forAll(callback)

Runs a callback function against all cells in the range. You can break the iteration by returning
false in the callback function

Parameters:

Name	Type	Description
callback	function

Source code

getAll(){Array}

Get all selected cell coords defined by this range

Returns: {Array}

Source code

getBordersSharedWith(range){Array}

Parameters:

Name	Type	Description
range	CellRange

Returns: {Array}

Source code

getBottomLeftCorner(){CellCoords}

Gets the bottom left corner of this range.

Returns: {CellCoords}

Source code

getBottomRightCorner(){CellCoords}

Gets the bottom right corner of this range.

Returns: {CellCoords}

Source code

getDirection(){String}

Gets the direction of the selection.

Returns: {String} Returns one of the values: 'NW-SE', 'NE-SW', 'SE-NW', 'SW-NE'.

Source code

getHeight(){Number}

Returns selected range height (in number of rows).

Returns: {Number}

Source code

getHorizontalDirection(){String}

Gets the horizontal direction of the range.

Returns: {String} Returns one of the values: W-E (west->east), E-W (east->west).

Source code

getInner(){Array}

Get inner selected cell coords defined by this range

Returns: {Array}

Source code

getOppositeCorner(coords, expandedRange){CellCoords}

Gets coordinates of the corner which is opposite to the matched. When the passed coordinates matched to the
bottom-right corner of this range then the coordinates for top-left will be returned.

Parameters:

Name	Type	Description
coords	CellCoords	Cell coordinates to check.
expandedRange	CellRange	optional

Returns: {CellCoords}

Source code

getTopLeftCorner(){CellCoords}

Gets the top left corner of this range.

Returns: {CellCoords}

Source code

getTopRightCorner(){CellCoords}

Gets the top right corner of this range.

Returns: {CellCoords}

Source code

getVerticalDirection(){String}

Gets the vertical direction of the range.

Returns: {String} Returns one of the values: N-S (north->south), S-N (south->north).

Source code

getWidth(){Number}

Returns selected range width (in number of columns).

Returns: {Number}

Source code

includes(cellCoords){Boolean}

Checks if given cell coordinates are within from and to cell coordinates of this range.

Parameters:

Name	Type	Description
cellCoords	CellCoords	The cell coordinates to check.

Returns: {Boolean}

Source code

includesRange(cellRange){Boolean}

Checks if given range is within of this range.

Parameters:

Name	Type	Description
cellRange	CellRange	The cells range to check.

Returns: {Boolean}

Source code

isCorner(coords, expandedRange){Boolean}

Checks if coordinates match to one of the 4th corners of this range.

Parameters:

Name	Type	Description
coords	CellCoords	Cell coordinates to check.
expandedRange	CellRange	optional

Returns: {Boolean}

Source code

isEqual(cellRange){Boolean}

Checks if given range is equal to this range.

Parameters:

Name	Type	Description
cellRange	CellRange	The cells range to check.

Returns: {Boolean}

Source code

isNorthWestOf(cellRange){Boolean}

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

Parameters:

Name	Type	Description
cellRange	CellRange	The cells range to check.

Returns: {Boolean}

Source code

isOverlappingHorizontally(cellRange){Boolean}

Returns true if the provided range is overlapping the current range horizontally (e.g. the current range's last
column is 5 and the provided range's first column is 3).

Parameters:

Name	Type	Description
cellRange	CellRange	The cells range to check.

Returns: {Boolean}

Source code

isOverlappingVertically(cellRange){Boolean}

Returns true if the provided range is overlapping the current range vertically (e.g. the current range's last
row is 5 and the provided range's first row is 3).

Parameters:

Name	Type	Description
cellRange	CellRange	The cells range to check.

Returns: {Boolean}

Source code

isSingle(){Boolean}

Checks if this cell range is restricted to one cell

Returns: {Boolean}

Source code

isSouthEastOf(cellRange){Boolean}

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

Parameters:

Name	Type	Description
cellRange	CellRange	The cells range to check.

Returns: {Boolean}

Source code

isValid(wot){Boolean}

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

Parameters:

Name	Type	Description
wot	Walkontable	The Walkontable instance.

Returns: {Boolean}

Source code

overlaps(cellRange){Boolean}

Checks if tested range overlaps with the range. Range A is considered to to be overlapping with range B
if intersection of A and B or B and A is not empty.

Parameters:

Name	Type	Description
cellRange	CellRange	The cells range to check.

Returns: {Boolean}

Source code

setDirection(direction)

Sets the direction of the selection.

Parameters:

Name	Type	Description
direction	String	One of the values: 'NW-SE', 'NE-SW', 'SE-NW', 'SW-NE'.

Source code

setFrom(coords)

Set the new coordinates where selection starts from.

Parameters:

Name	Type	Description
coords	CellCoords	Coordinates to use.

Source code

setHighlight(coords)

Set the new coordinates for highlighting selection.

Parameters:

Name	Type	Description
coords	CellCoords	Coordinates to use.

Source code

setTo(coords)

Set new coordinates where selection ends from.

Parameters:

Name	Type	Description
coords	CellCoords	Coordinates to use.

Source code

toObject(){Object}

Convert CellRange to literal object.

Returns: {Object} Returns a literal object with from and to properties which each of that object
contains row and col keys.