HandsontableEditor

Members

EDITOR_TYPE

Ask AI

Source code

HandsontableEditor.EDITOR_TYPE

Returns the unique editor type identifier for the Handsontable editor.

isFlippedHorizontally

Ask AI

Source code

handsontableEditor.isFlippedHorizontally : boolean

The flag determining if the editor is flipped horizontally (rendered on the inline start of the edited cell) or not.

isFlippedVertically

Ask AI

Source code

handsontableEditor.isFlippedVertically : boolean

The flag determining if the editor is flipped vertically (rendered on the top of the edited cell) or not.

Methods

beginEditing

Ask AI

Source code

handsontableEditor.beginEditing(newInitialValue, event)

Begins editing on a highlighted cell and hides fillHandle corner if was present.

Param	Type	Description
newInitialValue	*	The editor initial value.
event	*	The keyboard event object.

close

Ask AI

Source code

handsontableEditor.close()

Closes the editor.

createElements

Ask AI

Source code

handsontableEditor.createElements()

Creates an editor’s elements and adds necessary CSS classnames.

finishEditing

Ask AI

Source code

handsontableEditor.finishEditing(restoreOriginalValue, ctrlDown, callback)

Finishes editing and start saving or restoring process for editing cell or last selected range.

Param	Type	Description
restoreOriginalValue	boolean	If true, then closes editor without saving value from the editor into a cell.
ctrlDown	boolean	If true, then saveValue will save editor’s value to each cell in the last selected range.
callback	function	The callback function, fired after editor closing.

getDropdownHeight

Ask AI

Source code

handsontableEditor.getDropdownHeight() ⇒ number

Return the DOM height of the editor’s container.

getDropdownWidth

Ask AI

Source code

handsontableEditor.getDropdownWidth() ⇒ number

Return the DOM width of the editor’s container.

getTargetDropdownHeight

Ask AI

Source code

handsontableEditor.getTargetDropdownHeight() ⇒ number

Calculates the proposed/target editor height that should be set once the editor is opened. The method may be overwritten in the child class to provide a custom size logic.

getTargetDropdownWidth

Ask AI

Source code

handsontableEditor.getTargetDropdownWidth() ⇒ number

Calculates the proposed/target editor width that should be set once the editor is opened. The method may be overwritten in the child class to provide a custom size logic.

open

Ask AI

Source code

handsontableEditor.open()

Opens the editor and adjust its size.

prepare

Ask AI

Source code

handsontableEditor.prepare(row, col, prop, td, value, cellProperties)

Prepares editor’s meta data and configuration of the internal Handsontable’s instance.

Param	Type	Description
row	number	The visual row index.
col	number	The visual column index.
prop	number string	The column property (passed when datasource is an array of objects).
td	HTMLTableCellElement	The rendered cell element.
value	*	The rendered value.
cellProperties	object	The cell meta object (see Core#getCellMeta).