Public methods

Initializes the grid with specified rows and columns.

If the “columns” parameter is not specified, the columns will be obtained automatically from the “rows” parameter. Each unique property of the row object will represent a column with the same name.

If both the “rows” and “columns” parameters are not specified, the method removes all existing rows and columns.

Table 11: Optional Input parameters for loadData

Return value

Array – an array that contains the IDs of the added rows.

Example of the “rows” array parameter:

[

{

property1: ‘row 1’,

property2: ‘value2’,

someOtherProperties: ‘additional property’

},

{

property1: ‘row 2’

}

]

Example of the “columns” array parameter:

 [

{

label: ‘Column 1’,

width: 55,

name: ‘property1,

metadata: {

formatter: ‘select’,

editor: ‘select’, 

options:     [
                                            

{label: 'Red', value: 'id1'}, 

{label: 'Green', value: 'id2'}, 

{label: 'Blue', value: 'id3'}

]

}

},

{

name: ‘property2’,

settings: {

resizable: false,

sortable: true,

editable: false

}

}

]

obtainRowID is an overridable handler which should return a unique row id for the given row object when adding new rows using the “loadData” or “addRows” methods. It returns null by default. The Unique row id will be generated automatically if the handler returns a falsy value, e.g., false, empty string, null or undefined. If the handler returns a truthy value which is not a string or grid that already contains a row with the same id, an error will be thrown in the “loadData” or “addRows” methods.

Table 12: Input parameters for obtainRowID

Return value

   String—<span class="bold">row ID.</span>
                                            
                                            Example:
                                            dynamicTreeGrid.obtainRowId = function(rowObj, parentId) {     return rowObj.id_property;
                                            };

Adds rows to the specified position in the grid. Table 13: Input parameters for addRows

Return value Array—array which contains IDs of the added rows.

Removes the row with the specified ID from the grid and grid rows collection. Table 14: Input parameters for removeRows

Removes all rows from the grid and the grid rows collection.

Selects the row with the specified ID. Otherwise, the specified row becomes selected, and all previously selected rows stay selected. Table 15: Input parameters for selectRow

Cancels the selection of the specified row. Table 16: Input parameters for deselectRow

Adds a column to the grid. Table 17: Input parameters for addColumn

Removes the specified column from the grid and the grid columns collection. Table 18: Input parameters for removeColumn

Returns an Array containing the child row IDs for the specified parent row. This method returns the IDs of the root rows if the “parentId” parameter is null or undefined. Table 19: Input parameters for getChildRowIds

Return value Array—array with child row IDs or an empty array if there are no children.

Gets user data stored by the specified row and key. Table 20: Input parameters for getRowUserData

Return value Anything—user data stored by the specified row and key. Example: let itemtype = grid.getRowUserData(rowId, ‘itemtype’);

Sets user data for the specified row and key. Table 21: Input parameters for setRowUserData

Example: grid.setRowUserData(rowId, ‘itemtype’, ‘Part’);

Sets cell edit availability. Table 22: Input parameters for setCellEditability

Returns true if the specified cell is editable, otherwise it returns false. Table 23: Input parameters for getCellEditability

Return value Boolean—is cell editable or not.

Sets cell value and updates the corresponding property in the user row object. Table 24: Input parameters for setCellValue

Gets the cell value. Table 25: Input parameters for getCellValue

Return value Anything—cell value.

Gets a count of all columns (visible and invisible). Return value Number

Gets a count of visible columns. Return value Number

Gets a column index by the column name. Returns -1 if the column is not found or is invisible. Table 26: Input parameters for getColumnIndex

Return value Number—column index

Gets the column name using the column index. Table 27: Input parameters for getColumnName

Return value String—column name

Gets Array with the names of visible columns in the same order as they are displayed in the grid. Return value Array

Gets Array with the names of all columns in the order they are added to the grid. Return value Array

Gets the ID of the parent row for the specified row. Returns null if the specified row is root and has no parent. Table 28: Input parameters for getParentId

Return value String—parent row ID.

Returns true if the grid has a row with the specified ID in the rows collection, otherwise it returns false. Table 29: Input parameters for containsRow

Return value Boolean

Returns true if the grid has a column with the specified name in the columns collection, otherwise it returns false. Table 30: Input parameters for containsColumn

Return value Boolean

Expands all rows with their descendants.

Collapses all rows with their descendants.

Returns true if the specified row is expanded, otherwise it returns false. Table 31: Input parameters for isRowExpanded

Return value Boolean

Returns true if the specified row is visible, otherwise it returns false. Table 32: Input parameters for isRowVisible

Return value Boolean

Gets the number of visible rows that can be displayed in the grid.

Return value Number

Gets the number of all rows (visible and invisible) contained in the rows collection. Return value Number

Gets the Array with the IDs of visible rows displayed in the grid. Return value Array

Gets the Array with the IDs of all rows contained in the rows collection. Return value Array

Gets the row ID by the row index. Table 33: Input parameters for getRowId

Return value String—row ID.

Gets the row index using the row ID. The method returns -1 if the row is not found or not visible. Table 34: Input parameters for getRowIndex

Return value Number—row index.

Moves a column to the specified position. Table 35: Input parameters for moveColumn

Sets settings for the specified column. Table 36: Input parameters for setColumnSettings

Gets settings for the specified column. Table 37: Input parameters for getColumnSettings

Return value Object—column settings object described in section Column settings object.

Sets metadata for the specified column that will be used by the column cells without their own metadata. Table 38: Input parameters for setColumnMetadata

Gets metadata for the specified column. Returns null if the column has no metadata. Table 39: Input parameters for getColumnMetadata

Return value Object—metadata object described in section Metadata objects.

Sets column visibility. Table 40: Input parameters for setColumnVisibility

Returns true if the specified column is visible, otherwise it returns false. Table 41: Input parameters for getColumnVisibility

Return value Boolean

Sets the label for the specified column. Table 42: Input parameters for setColumnLabel

Gets the label for the specified column. Table 43: Input parameters for getColumnLabel

Return value String—column label.

Sets the width for the specified column. Table 44: Input parameters for setColumnWidth

Gets the width for the specified column. Table 45: Input parameters for getColumnWidth

Return value Number—column width.

Sets metadata for the specified cell. Table 46: Input parameters for setCellMetadata

Gets metadata for the specified cell. Returns null if the cell has no metadata (even if the column has metadata). Table 47: Input parameters for getCellMetadataOnly

Return value Object—metadata object described in section Metadata objects.