React Data GridGhostTable

On this page

• Members
  • columns
  • container
  • hot
  • injected
  • rows
  • samples
  • settings
• Methods
  • addColumn
  • addColumnHeadersRow
  • addRow
  • appendColumnHeadersRow
  • clean
  • createCol
  • createColElement
  • createColGroupsCol
  • createContainer
  • createRow
  • createTable
  • getHeights
  • getSetting
  • getSettings
  • getWidths
  • injectTable
  • isHorizontal
  • isVertical
  • removeTable
  • setSetting
  • setSettings

Members

columns

Source code

ghostTable.columns : Array

Added columns collection.

container

Source code

ghostTable.container : HTMLElement | null

Container element where every table will be injected.

hot

Source code

ghostTable.hot : Core

Handsontable instance.

injected

Source code

ghostTable.injected : boolean

Flag which determine is table was injected to DOM.

rows

Source code

ghostTable.rows : Array

Added rows collection.

samples

Source code

ghostTable.samples : Map

Samples prepared for calculations.

Default: {null}

settings

Source code

ghostTable.settings : object

Ghost table settings.

Default: {Object}

Methods

addColumn

Source code

ghostTable.addColumn(column, samples)

Add column.

Param	Type	Description
column	number	Visual column index.
samples	Map	A map with sampled table values.

addColumnHeadersRow

Source code

ghostTable.addColumnHeadersRow(samples)

Add a row consisting of the column headers.

Param	Type	Description
samples	Map	A map with sampled table values.

addRow

Source code

ghostTable.addRow(row, samples)

Add row.

Param	Type	Description
row	number	Visual row index.
samples	Map	Samples Map object.

appendColumnHeadersRow

Source code

ghostTable.appendColumnHeadersRow()

Creates DOM elements for headers and appends them to the THEAD element of the table.

clean

Source code

ghostTable.clean()

Remove table from document and reset internal state.

createCol

Source code

ghostTable.createCol(column) ⇒ DocumentFragment

Create table column elements.

Param	Type	Description
column	number	Visual column index.

Returns: DocumentFragment - Returns created column table column elements.

createColElement

Source code

ghostTable.createColElement(column, row) ⇒ HTMLElement

Create col element.

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

createColGroupsCol

Source code

ghostTable.createColGroupsCol(row) ⇒ DocumentFragment

Create colgroup col elements.

Param	Type	Description
row	number	Visual row index.

createContainer

Source code

ghostTable.createContainer(className) ⇒ object

Create container for tables.

Param	Type	Description
className	string	The CSS classes to add.

createRow

Source code

ghostTable.createRow(row) ⇒ DocumentFragment

Create table row element.

Param	Type	Description
row	number	Visual row index.

Returns: DocumentFragment - Returns created table row elements.

createTable

Source code

ghostTable.createTable(className) ⇒ object

Create table element.

Param	Type	Description
className	string	The CSS classes to add.

getHeights

Source code

ghostTable.getHeights(callback)

Get calculated heights.

Param	Type	Description
callback	function	Callback which will be fired for each calculated row.

getSetting

Source code

ghostTable.getSetting(name) ⇒ boolean | null

Get a single Ghost Table setting.

Param	Type	Description
name	string	The setting name to get.

getSettings

Source code

ghostTable.getSettings() ⇒ object | null

Get the Ghost Table settings.

getWidths

Source code

ghostTable.getWidths(callback)

Get calculated widths.

Param	Type	Description
callback	function	Callback which will be fired for each calculated column.

injectTable

Source code

ghostTable.injectTable([parent])

Inject generated table into document.

Param	Type	Default	Description
[parent]	HTMLElement	null	optional The element to which the ghost table is injected.

isHorizontal

Source code

ghostTable.isHorizontal() ⇒ boolean

Checks if table is raised horizontally (checking columns).

isVertical

Source code

ghostTable.isVertical() ⇒ boolean

Checks if table is raised vertically (checking rows).

removeTable

Source code

ghostTable.removeTable()

Remove table from document.

setSetting

Source code

ghostTable.setSetting(name, value)

Set a single setting of the Ghost Table.

Param	Type	Description
name	string	Setting name.
value	*	Setting value.

setSettings

Source code

ghostTable.setSettings(settings)

Set the Ghost Table settings to the provided object.

Param	Type	Description
settings	object	New Ghost Table Settings.