MergedCellCoords

Description

The MergedCellCoords class represents a single merged cell.

Description

Initializes the merged cell coordinates with its top-left position, span dimensions, and factories for creating cell coordinate and range objects.

Members

removed

Ask AI

Source code

mergedCellCoords.removed : boolean

true only if the merged cell is bound to be removed.

Methods

containsNegativeValues

Ask AI

Source code

MergedCellCoords.containsNegativeValues(mergedCell) ⇒ boolean

Check whether the values provided for a merged cell contain any negative values.

Param	Type	Description
mergedCell	Object	Object containing information about the merged cells that was about to be added.

getLastColumn

Ask AI

Source code

mergedCellCoords.getLastColumn() ⇒ number

Get the rightmost column index of the merged cell.

getLastRow

Ask AI

Source code

mergedCellCoords.getLastRow() ⇒ number

Get the bottom row index of the merged cell.

getRange

Ask AI

Source code

mergedCellCoords.getRange() ⇒ CellRange

Get the range coordinates of the merged cell.

includes

Ask AI

Source code

mergedCellCoords.includes(row, column) ⇒ boolean

Returns true if the provided coordinates are inside the merged cell.

Param	Type	Description
row	number	The row index.
column	number	The column index.

includesHorizontally

Ask AI

Source code

mergedCellCoords.includesHorizontally(column) ⇒ boolean

Returns true if the provided column property is within the column span of the merged cell.

Param	Type	Description
column	number	The column index.

includesVertically

Ask AI

Source code

mergedCellCoords.includesVertically(row) ⇒ boolean

Returns true if the provided row property is within the row span of the merged cell.

Param	Type	Description
row	number	Row index.

IS_OUT_OF_BOUNDS_WARNING

Ask AI

Source code

MergedCellCoords.IS_OUT_OF_BOUNDS_WARNING(mergedCell) ⇒ string

Get a warning message for when the declared merged cell data contains values exceeding the table limits.

Param	Type	Description
mergedCell	Object	Object containing information about the merged cells that was about to be added.

IS_SINGLE_CELL

Ask AI

Source code

MergedCellCoords.IS_SINGLE_CELL(mergedCell) ⇒ string

Get a warning message for when the declared merged cell data represents a single cell.

Param	Type	Description
mergedCell	Object	Object containing information about the merged cells that was about to be added.

isFarther

Ask AI

Source code

mergedCellCoords.isFarther(mergedCell, direction) ⇒ boolean | null

Check if the second provided merged cell is “farther” in the provided direction.

Param	Type	Description
mergedCell	MergedCellCoords	The merged cell to check.
direction	string	Drag direction.

Returns: boolean | null - true if the second provided merged cell is “farther”.

isOutOfBounds

Ask AI

Source code

MergedCellCoords.isOutOfBounds(mergeCell, rowCount, columnCount) ⇒ boolean

Check whether the provided merged cell object is to be declared out of bounds of the table.

Param	Type	Description
mergeCell	object	Object containing the row, col, rowspan and colspan properties.
rowCount	number	Number of rows in the table.
columnCount	number	Number of rows in the table.

NEGATIVE_VALUES_WARNING

Ask AI

Source code

MergedCellCoords.NEGATIVE_VALUES_WARNING(mergedCell) ⇒ string

Get a warning message for when the declared merged cell data contains negative values.

Param	Type	Description
mergedCell	Object	Object containing information about the merged cells that was about to be added.

normalize

Ask AI

Source code

mergedCellCoords.normalize(hotInstance)

Sanitize (prevent from going outside the boundaries) the merged cell.

Param	Type	Description
hotInstance	Core	The Handsontable instance.

shift

Ask AI

Source code

mergedCellCoords.shift(shiftVector, indexOfChange) ⇒ boolean

Shift (and possibly resize, if needed) the merged cell.

Param	Type	Description
shiftVector	Array	2-element array containing the information on the shifting in the x and y axis.
indexOfChange	number	Index of the preceding change.

Returns: boolean - Returns false if the whole merged cell was removed.

ZERO_SPAN_WARNING

Ask AI

Source code

MergedCellCoords.ZERO_SPAN_WARNING(mergedCell) ⇒ string

Get a warning message for when the declared merged cell data contains “colspan” or “rowspan”, that equals 0.

Param	Type	Description
mergedCell	Object	Object containing information about the merged cells that was about to be added.