AGGrid

AGGrid

Provide a grid control.

This class is a wrapper around the public ag-grid utility. It is intended that this class be used exclusively rather than any of the raw ag-grid API. It provides a higher-level and more convenient API.

Please refer to ag-grid documentation on https://www.ag-grid.com/documentation-main/documentation.php for more information.

Constructor

new AGGrid(id, columns, keyColumn)

Description:
  • Create a new AGGrid instance.

    The HTML portion of this should look like:

    <div id="grid" style="margin-top: 10px; width: 100%; height: calc(100% - 90px);"></div>

    CSS calc can be used to set the width or height so that the grid dynamically resizes when the browser window gets resized.
Source:
Parameters:
Name Type Description
id string the ID of the div that represents the grid
columns an ag-grid columnDefs data structure
keyColumn string the ID of the key column (optional)

Methods

addComponent(tag, cls) → {AGGrid}

Description:
  • Add a class that defines special cell formatting.
Source:
Parameters:
Name Type Description
tag
cls
Returns:
Type
AGGrid

addRecord(data) → {AGGrid}

Description:
  • Add a single record to the grid.

    Note that if several records are going to be added at a time, it is far faster to use addRecords().
Source:
Parameters:
Name Type Description
data object each element represents a column on the grid
Returns:
Type
AGGrid

addRecords(data) → {AGGrid}

Description:
  • Add an array of records to the grid.

    Note that this method is far faster than a series of addRecord() calls.
Source:
Parameters:
Name Type Description
data array each element of the array is an object representing a row
Returns:
Type
AGGrid

clear() → {AGGrid}

Description:
  • Erase all the rows in the grid.
Source:
Returns:
Type
AGGrid

clearSelection() → {AGGrid}

Description:
  • Clear the selection from the currently selected rows.
Source:
Returns:
Type
AGGrid

columnShow(colId, val) → {boolean}

Description:
  • Hide or show column colId.
Source:
Parameters:
Name Type Description
colId
val boolean true=show, false=hide
Returns:
previous value
Type
boolean

deleteRow(id) → {AGGrid}

Description:
  • Delete the row who's key column is equal to id.
Source:
Parameters:
Name Type Description
id
Returns:
Type
AGGrid

deleteRowIndex(n) → {AGGrid}

Description:
  • Delete row at index n.
Source:
Parameters:
Name Type Description
n
Returns:
Type
AGGrid

deleteSelectedRows() → {AGGrid}

Description:
  • Delete the selected rows.
Source:
Returns:
Type
AGGrid

deselectAll() → {AGGrid}

Description:
  • De-select all rows.
Source:
Returns:
Type
AGGrid

destroy()

Description:
  • Free all of the internal data structures associated with the grid.

    This method must be called once a grid is no longer needed.

    Please note that this function is normally handled by the framework. If your application code is calling it, you are most likely doing something wrong.
Source:

disable(flg)

Description:
  • Disables the clicks on the AGGrid control.
Source:
Parameters:
Name Type Default Description
flg boolean true true=disable, false=enable

enable(flg)

Description:
  • Enables the clicks on the AGGrid control.
Source:
Parameters:
Name Type Default Description
flg boolean true true=enable, false=disable

getAllRows() → {array}

Description:
  • Returns all the rows.
Source:
Returns:
Type
array

getFirstRow() → {*|null}

Description:
  • Returns the first row in the grid. If there are no rows, a null is returned. Row selection is ignored.
Source:
Returns:
Type
* | null

getLastRow() → {*|null}

Description:
  • Returns the last row in the grid. If there are no rows, a null is returned. Row selection is ignored.
Source:
Returns:
Type
* | null

getNumberOfRows() → {number}

Description:
  • Returns the number of rows in the grid.
Source:
Returns:
Type
number

getRowAtIndex(n) → {*}

Description:
  • Get row at index n (indexes are zero origin)
Source:
Parameters:
Name Type Description
n
Returns:
Type
*

getSelectedRow() → {*}

Description:
  • Return the selected row or null if none is selected.
Source:
Returns:
Type
*

getSelectedRowIndex() → {null|number}

Description:
  • Return the index of the selected row. null is returned if no row is selected. If multiple rows are selected, the index of the first selected row is returned.
Source:
Returns:
Type
null | number

getSelectedRowIndexes() → {array}

Description:
  • Return an array of the indexes of all of the selected rows.
Source:
Returns:
Type
array

getSelectedRows() → {*}

Description:
  • Return an array containing all of the selected rows.
Source:
Returns:
Type
*

highlightRows(idx)

Description:
  • Highlight a row or an array of particular rows.

    Note that highlighting a row and selecting a row are two different things.

    Pass row index or an array or row indexes to highlight. Pass null to un-highlight all rows.
Source:
Parameters:
Name Type Description
idx null, number, or array of numbers

isEmpty() → {boolean}

Description:
  • Return true if the grid is empty.
Source:
Returns:
Type
boolean

multiSelect() → {AGGrid}

Description:
  • By default, grids are single-row-select enabled. This method enables multi-row-select. It must be called prior to show().
Source:
Returns:
Type
AGGrid

noRowSelection() → {AGGrid}

Description:
  • Disallow any row selection. This must be called before show()
Source:
Returns:
Type
AGGrid

numberOfSelectedRows() → {*}

Description:
  • Returns the number of selected rows
Source:
Returns:
Type
*

rowStyleFunction(fun) → {AGGrid}

Description:
  • This method allows you to set a function that determines the style of each individual row.
Source:
Parameters:
Name Type Description
fun function
Returns:
Type
AGGrid

selectId(id) → {AGGrid}

Description:
  • Select the row specified in which the key column of that row is equal to id.
Source:
Parameters:
Name Type Description
id
Returns:
Type
AGGrid

setDragFunction(fun) → {AGGrid}

Description:
  • If a row is dragged, this function will be called when the drag operation is complete. fun is passed two arguments. The first is the row being dragged. The second is the row over which it was released.
Source:
Parameters:
Name Type Description
fun function
Returns:
Type
AGGrid

setOnRowDoubleClicked(fn) → {AGGrid}

Description:
  • Execute function fn whenever the user double-clicks on a row.
Source:
Parameters:
Name Type Description
fn function
Returns:
Type
AGGrid

setOnSelectionChanged(fn)

Description:
  • Execute fn anytime a row selection is changed.

    fn is passwd an array of the selected rows.
Source:
Parameters:
Name Type Description
fn function

setRowData(data) → {AGGrid}

Description:
  • Erase all existing rows and set the new rows.
Source:
Parameters:
Name Type Description
data array the data to display in the grid
Returns:
Type
AGGrid

show() → {AGGrid}

Description:
  • Initialize and show the grid.

    Important! Once this is called, you must call the destroy() method when the grid is no longer needed.
Source:
Returns:
Type
AGGrid

updateSelectedRecord(row) → {AGGrid}

Description:
  • Update the selected row with the new data provided in row.
Source:
Parameters:
Name Type Description
row
Returns:
Type
AGGrid

(static) addGrid(grid)

Description:
  • Add a grid to the current context.
Source:
Parameters:
Name Type Description
grid

(static) date(params) → {string}

Description:
  • Format for date times formatted as mm/dd/yyyy

    Usage: in columnDefs: valueFormatter: AGGrid.date
Source:
Parameters:
Name Type Description
params
Returns:
Type
string

(static) dateTime(params) → {string}

Description:
  • Format for date times formatted as mm/dd/yyyy hh:mm AM/PM

    Usage: in columnDefs: valueFormatter: AGGrid.dateTime
Source:
Parameters:
Name Type Description
params
Returns:
Type
string

(static) newGridContext()

Description:
  • Create a new grid context.
Source:

(static) numericFormat(params) → {string}

Description:
  • Format a numeric field

    Usage: in columnDefs: valueFormatter: AGGrid.numericFormat, mask: 'xxx', decimalPlaces: N
Source:
See:
  • Utils.format()
Parameters:
Name Type Description
params
Returns:
Type
string

(static) popAllGridContexts()

Description:
  • Destroys all popup and screen grids that have been created
Source:

(static) popGridContext()

Description:
  • Destroy all grids in last context and remove the context
Source:

(static) time(params) → {string}

Description:
  • Format times as HH:MM AM/PM

    Usage: in columnDefs: valueFormatter: AGGrid.time
Source:
Parameters:
Name Type Description
params
Returns:
Type
string