| grid | Grid | the grid you'd like to act upon, usually available
diff --git a/docs/partials/api/ui.grid.class.Grid.html b/docs/partials/api/ui.grid.class.Grid.html
index 863b27236..a131c4e13 100644
--- a/docs/partials/api/ui.grid.class.Grid.html
+++ b/docs/partials/api/ui.grid.class.Grid.html
@@ -1,4 +1,4 @@
- Improve this doc View source Grid
+ Improve this doc View sourceGrid
function in module ui.grid
@@ -12,7 +12,7 @@ Usage
Parameters| Param | Type | Details |
|---|
| options | object | Object map of options to pass into the grid. An 'id' property is expected.
|
Methods
- -
addRowHeaderColumn(colDef, order, stopColumnBuild)
+-
addRowHeaderColumn(colDef, order, stopColumnBuild)
adds a row header column to the grid
Parameters| Param | Type | Details |
|---|
| colDef | object | Column definition object.
| | order | float | Number that indicates where the column should be placed in the grid.
@@ -20,16 +20,16 @@ Parameters assignTypes()
+-
assignTypes()
uses the first row of data to assign colDef.type for any types not defined.
--
buildColumnDefsFromData(rowBuilder)
+ -
buildColumnDefsFromData(rowBuilder)
Populates columnDefs from the provided data
Parameters
--
buildColumns(options)
+ -
buildColumns(options)
creates GridColumn objects from the columnDefinition. Calls each registered
columnBuilder to further process the column
Parameters| Param | Type | Details |
|---|
| options | object | An object contains options to use when building columns
@@ -39,11 +39,11 @@ ParametersReturns| Promise | a promise to load any needed column resources
|
--
buildStyles()
+ -
buildStyles()
calls each styleComputation function
--
callDataChangeCallbacks(type)
+ -
callDataChangeCallbacks(type)
Calls the callbacks based on the type of data change that
has occurred. Always calls the ALL callbacks, calls the ROW, EDIT, COLUMN and OPTIONS callbacks if the
event type is matching, or if the type is ALL.
@@ -52,7 +52,7 @@ Parameters clearAllFilters(refreshRows, clearConditions, clearFlags)
+-
clearAllFilters(refreshRows, clearConditions, clearFlags)
Clears all filters and optionally refreshes the visible rows.
Parameters| Param | Type | Details |
|---|
| refreshRows | object | | | clearConditions | object | Defaults to false.
@@ -60,7 +60,7 @@ ParametersReturns| promise | If refreshRows is true, returns a promise of the rows refreshing.
|
--
columnRefreshCallback(grid, options)
+ -
columnRefreshCallback(grid, options)
refreshes the grid when a column refresh
is notified, which triggers handling of the visible flag.
This is called on uiGridConstants.dataChange.COLUMN, and is
@@ -69,96 +69,96 @@ ParametersobjectAny options passed into the callback.
|
- -
createLeftContainer()
+ -
createLeftContainer()
creates the left render container if it doesn't already exist
- -
createRightContainer()
+ -
createRightContainer()
creates the right render container if it doesn't already exist
- -
+
-
- -
+
-
- -
getCellDisplayValue(row, col)
+ -
getCellDisplayValue(row, col)
Gets the displayed value of a cell after applying any the cellFilter
Parameters
- -
getCellValue(row, col)
+ -
getCellValue(row, col)
Gets the value of a cell for a particular row and column
Parameters
- -
getColDef(name)
+ -
getColDef(name)
returns a grid colDef for the column name
Parameters
- -
getColumn(name)
+ -
getColumn(name)
returns a grid column for the column name
Parameters
- -
getColumnSorting()
+ -
getColumnSorting()
Return the columns that the grid is currently being sorted by
Returns
- -
getGridQualifiedColField(col)
+ -
getGridQualifiedColField(col)
Returns the $parse-able accessor for a column within its $scope
Parameters
- -
getOnlyDataColumns()
+ -
getOnlyDataColumns()
returns all columns except for rowHeader columns
- -
getRow(rowEntity, lookInRows)
+ -
getRow(rowEntity, lookInRows)
returns the GridRow that contains the rowEntity
Parameters| Param | Type | Details |
|---|
| rowEntity | object | the gridOptions.data array element instance
| | lookInRows | array | [optional] the rows to look in - if not provided then
looks in grid.rows
|
- -
handleWindowResize()
+ -
handleWindowResize()
Triggered when the browser window resizes; automatically resizes the grid
Returns| Promise | A resolved promise once the window resize has completed.
|
- -
hasLeftContainer()
+ -
hasLeftContainer()
returns true if leftContainer exists
- -
hasLeftContainerColumns()
+ -
hasLeftContainerColumns()
returns true if leftContainer has columns
- -
hasRightContainer()
+ -
hasRightContainer()
returns true if rightContainer exists
- -
hasRightContainerColumns()
+ -
hasRightContainerColumns()
returns true if rightContainer has columns
- -
isRTL()
+ -
isRTL()
Returns true if grid is RightToLeft
- -
isRowHeaderColumn(column)
+ -
isRowHeaderColumn(column)
returns true if the column is a row Header
Parameters
- -
modifyRows(newRawData)
+ -
modifyRows(newRawData)
creates or removes GridRow objects from the newRawData array. Calls each registered
rowBuilder to further process the row
Parameters| Param | Type | Details |
|---|
| newRawData | array | Modified set of data
@@ -191,7 +191,7 @@ Parameters notifyDataChange(type)
+-
notifyDataChange(type)
Notifies us that a data change has occurred, used in the public
api for users to tell us when they've changed data or some other event that
our watches cannot pick up
@@ -206,60 +206,60 @@ Parameters preCompileCellTemplates()
+-
preCompileCellTemplates()
precompiles all cell templates
--
processRowBuilders(gridRow)
+ -
processRowBuilders(gridRow)
processes all RowBuilders for the gridRow
ParametersReturns| GridRow | the gridRow with all additional behavior added
|
--
processRowsCallback(name)
+ -
processRowsCallback(name)
calls the row processors, specifically
intended to reset the sorting when an edit is called,
registered as a dataChangeCallback on uiGridConstants.dataChange.EDIT
Parameters
--
queueGridRefresh()
+ -
queueGridRefresh()
queues a grid refresh, a way of debouncing all the refreshes we might otherwise issue
--
queueRefresh()
+ -
queueRefresh()
queues a grid refreshCanvas, a way of debouncing all the refreshes we might otherwise issue
--
redrawInPlace([rowsAdded])
+ -
redrawInPlace([rowsAdded])
Redraw the rows and columns based on our current scroll position
Parameters| Param | Type | Details |
|---|
| [rowsAdded] | boolean | Optional to indicate rows are added and the scroll percentage must be recalculated
|
--
refresh([rowsAltered])
+ -
refresh([rowsAltered])
Refresh the rendered grid on screen.
Parameters| Param | Type | Details |
|---|
| [rowsAltered] | boolean | Optional flag for refreshing when the number of rows has changed.
|
--
refreshCanvas(buildStyles)
+ -
refreshCanvas(buildStyles)
Builds all styles and recalculates much of the grid sizing
Parameters| Param | Type | Details |
|---|
| buildStyles | object | optional parameter. Use TBD
|
Returns| promise | promise that is resolved when the canvas
has been refreshed
|
--
refreshRows()
+ -
refreshRows()
Refresh the rendered rows on screen? Note: not functional at present
Returns| promise | promise that is resolved when render completes?
|
--
registerColumnBuilder(columnBuilder)
+ -
registerColumnBuilder(columnBuilder)
When the build creates columns from column definitions, the columnbuilders will be called to add
additional properties to the column.
Parameters
--
registerColumnsProcessor(columnProcessor, priority)
+ -
registerColumnsProcessor(columnProcessor, priority)
Register a "columns processor" function. When the columns are updated,
the grid calls each registered "columns processor", which has a chance
to alter the set of columns, as long as the count is not modified.
@@ -272,7 +272,7 @@ Parameters registerDataChangeCallback(callback, types)
+-
registerDataChangeCallback(callback, types)
When a data change occurs, the data change callbacks of the specified type
will be called. The rules are:
@@ -298,13 +298,13 @@ ParametersReturns| function | deregister function - a function that can be called to deregister this callback
|
--
registerRowBuilder(rowBuilder)
+ -
registerRowBuilder(rowBuilder)
When the build creates rows from gridOptions.data, the rowBuilders will be called to add
additional properties to the row.
Parameters
--
registerRowsProcessor(processorFunction, priority)
+ -
registerRowsProcessor(processorFunction, priority)
Register a "rows processor" function. When the rows are updated,
the grid calls each registered "rows processor", which has a chance
to alter the set of rows (sorting, etc) as long as the count is not
@@ -317,23 +317,23 @@ Parameters registerStyleComputation(styleComputation)
+-
registerStyleComputation(styleComputation)
registered a styleComputation function
If the function returns a value it will be appended into the grid's <style> block
Parameters
--
removeRowsProcessor(rows)
+ -
removeRowsProcessor(rows)
Remove a registered rows processor
Parameters
--
resetColumnSorting([excludedColumn])
+ -
resetColumnSorting([excludedColumn])
Return the columns that the grid is currently being sorted by
Parameters| Param | Type | Details |
|---|
| [excludedColumn] | GridColumn | Optional GridColumn to exclude from having its sorting reset
|
--
+
-
|
|
|
|
|