API calls for the Flexmonster control
Learn more about available API calls for the Flexmonster composite control.
closeFieldList
closeFieldList()
Closes the field list dialog.
Example:
flexmonster.closeFieldList();
dispose
dispose()
Disposes of the component and cleans up used resources.
Prepares the instance to be deleted with the browser's garbage collection.
Example:
flexmonster.dispose();
getCell
getCell(rowIdx: Number, colIdx: Number): GridCellObject
Gets the cell object at the specified row and column coordinates.
Parameters
Example:
flexmonster.getCell(1,1);
Returns: GridCellObject, which contains information about the cell.
getOptions
getOptions(): FlexmonsterControlOptionsObject
Gets the current component options.
Example:
flexmonster.getOptions();
Returns: FlexmonsterControlOptionsObject
getSelectedCells
getSelectedCells(): GridCellObject[]
Gets all currently selected cells.
Example:
flexmonster.getSelectedCells();
Returns: GridCellObject[]
openFieldList
openFieldList()
Opens the field list dialog.
Example:
flexmonster.openFieldList();
scrollToColumn
scrollToColumn(columnIndex: Number)
Scrolls the grid to the specified column.
Parameters
| Parameter/Type | Description |
|---|---|
| columnIndexNumber | The index of the column to which the grid will be scrolled. Indexes start from 0. |
Example:
flexmonster.scrollToColumn(5);
scrollToRow
scrollToRow(rowIndex: Number)
Scrolls the grid to the specified row.
Parameters
| Parameter/Type | Description |
|---|---|
| rowIndexNumber | The index of the row to which the grid will be scrolled. Indexes start from 0. |
Example:
flexmonster.scrollToRow(5);
setActiveViewType
setActiveViewType(viewType: String)
Sets the active view type for the component.
| Parameter/Type | Description |
|---|---|
| viewTypeString | Specifies the view type. Possible values: "flat-table" and "pivot-table. |
Example:
flexmonster.setActiveViewType("flat-table");