A formatting function. Must be a member of (property of) canvasDatagrid.formatters and match a type from one of the canvasDatagrid.headers in canvasDatagrid.schema.
| Name | Type | Optional | Default | Description |
|---|
| e | object | | | Formatting event object. |
| e.cell | canvasDatagrid.cell | | | Cell being formatted. |
filter
A filter function. Filter should return true when the value should be kept, and false if the value should be filtered out. Must be a member of (property of) {canvasDatagrid.filters} and match a type from one of the canvasDatagrid.headers in canvasDatagrid.schema.
| Name | Type | Optional | Default | Description |
|---|
| value | string | | | The current value being checked. |
| filterFor | string | | | The value being filtered against. |
sorter
A sorter function. Must be a member of (property of) canvasDatagrid.sorters and match a type from one of the canvasDatagrid.headers in canvasDatagrid.schema.
| Name | Type | Optional | Default | Description |
|---|
| columnName | string | | | Name of the column being sorted. |
| direction | string | | | Direction of the column being sorted, either asc or desc. |
fillCellCallback
The additional function to invoke when a cell is filled. The return value of this
function sets the new data of the cell.
| Name | Type | Optional | Default | Description |
|---|
| args | object | | | Arguments that are passed to the function. |
| args.rows | array | | | Data that is being filled into all the cells, including this one. |
| args.direction | string | | | Direction of the fill operation, which can be 'horizontal' for x axis, 'vertical' for y axis, or 'both' when it goes both ways, e.g., when pasting unevenly. |
| args.newRowData | object | | | New row data that is going to replace 'existingRowData'. The result of this function will be kept in this object. |
| args.existingRowData | object | | | Existing data of the row. This will be replaced with 'newRowData'. |
| args.rowIndex | number | | | Index of the row on the grid. |
| args.rowOffset | number | | | Position/offset of 'cells' in 'rows'. Starts with '0'. |
| args.cells | array | | | New data for all the cells, including this one, for the current row. This is the same as accessing 'rows' using 'rowOffset'. |
| args.reversed | boolean | | | Whether the fill operation is applied in the reverse order, meaning if horizontal, we are going from right to left, and if vertical, we are going from bottom to top. |
| args.isFillingRow | boolean | | | Whether the current row is being filled. If the 'direction' is 'vertical', this will always be true, or sometimes true if the 'direction' is 'both'. |
| args.fillingRowPosition | number | | | Increase in position since the first filling of the rows. This will be '-1' if 'isFillingRow' is false. Starts with '0'. |
| args.fillingRowLength | number | | | Total length that 'fillingRowPosition' will go. This will be '-1' if 'isFillingRow' is false. |
| args.column | object | | | Column that this cell is on. |
| args.columnIndex | number | | | The index of the column on the grid. |
| args.newCellData | string | | | Data from 'cells' to be set for this cell. You can modify this and return the result to set the new data for this cell. |
| args.existingCellData | string | | | Existing data on this cell that is about to be replaced with the data you will return. |
| args.columnOffset | number | | | Position/offset of the 'newCellData' in 'cells'. Starts with '0'. |
| args.isFillingColumn | boolean | | | Whether the current column is being filled. If the 'direction' is 'horizontal', this will always be true, or sometimes true if the 'direction' is 'both'. |
| args.fillingColumnPosition | number | | | Increase in position since the first filling of the columns. This will be '-1' if 'isFillingColumn' is false. Starts with '0'. |
| args.fillingColumnLength | number | | | Total length that 'fillingColumnPosition' will go. This will be '-1' if 'isFillingColumn' is false. |
exports
| Name | Type | Optional | Default | Description |
|---|
integerToAlpha
Converts a integer into a letter A - ZZZZZ...
| Name | Type | Optional | Default | Description |
|---|
| n | column | | | The number to convert. |
integerToAlpha
| Name | Type | Optional | Default | Description |
|---|
insertColumn
Inserts a new column before the specified index into the schema.
| Name | Type | Optional | Default | Description |
|---|
| c | column | | | The column to insert into the schema. |
| index | number | | | The index of the column to insert before. |
insertColumn
| Name | Type | Optional | Default | Description |
|---|
deleteColumn
Deletes a column from the schema at the specified index.
| Name | Type | Optional | Default | Description |
|---|
| index | number | | | The index of the column to delete. |
deleteColumn
| Name | Type | Optional | Default | Description |
|---|
addColumn
Adds a new column into the schema.
| Name | Type | Optional | Default | Description |
|---|
| c | column | | | The column to add to the schema. |
addColumn
| Name | Type | Optional | Default | Description |
|---|
deleteRow
Deletes a row from the dataset at the specified index.
| Name | Type | Optional | Default | Description |
|---|
| index | number | | | The index of the row to delete. |
deleteRow
| Name | Type | Optional | Default | Description |
|---|
insertRow
Inserts a new row into the dataset before the specified index.
| Name | Type | Optional | Default | Description |
|---|
| d | object | | | data. |
| index | number | | | The index of the row to insert before. |
insertRow
| Name | Type | Optional | Default | Description |
|---|
addRow
Adds a new row into the dataset.
| Name | Type | Optional | Default | Description |
|---|
| d | object | | | data. |
addRow
| Name | Type | Optional | Default | Description |
|---|
setRowHeight
Sets the height of a given row by index number.
| Name | Type | Optional | Default | Description |
|---|
| rowIndex | number | | | The index of the row to set. |
| height | number | | | Height to set the row to. |
setRowHeight
| Name | Type | Optional | Default | Description |
|---|
setColumnWidth
Sets the width of a given column by index number.
| Name | Type | Optional | Default | Description |
|---|
| colIndex | number | | | The index of the column to set. |
| width | number | | | Width to set the column to. |
setColumnWidth
| Name | Type | Optional | Default | Description |
|---|
resetColumnWidths
Removes any changes to the width of the columns due to user or api interaction, setting them back to the schema or style default.
| Name | Type | Optional | Default | Description |
|---|
resetColumnWidths
| Name | Type | Optional | Default | Description |
|---|
resetRowHeights
Removes any changes to the height of the rows due to user or api interaction, setting them back to the schema or style default.
| Name | Type | Optional | Default | Description |
|---|
resetRowHeights
| Name | Type | Optional | Default | Description |
|---|
setFilter
Sets the value of the filter.
| Name | Type | Optional | Default | Description |
|---|
| column | string | | | Name of the column to filter. |
| value | string | | | The value to filter for. |
setFilter
| Name | Type | Optional | Default | Description |
|---|
Returns the number of pixels to scroll down to line up with row rowIndex.
| Name | Type | Optional | Default | Description |
|---|
| rowIndex | number | | | The row index of the row to scroll find. |
| Name | Type | Optional | Default | Description |
|---|
Returns the number of pixels to scroll to the left to line up with column columnIndex.
| Name | Type | Optional | Default | Description |
|---|
| columnIndex | number | | | The column index of the column to find. |
| Name | Type | Optional | Default | Description |
|---|
gotoCell
Scrolls to the cell at columnIndex x, and rowIndex y. If you define both rowIndex and columnIndex additional calculations can be made to center the cell using the target cell's height and width. Defining only one rowIndex or only columnIndex will result in simpler calculations.
| Name | Type | Optional | Default | Description |
|---|
| x | number | | | The column index of the cell to scroll to. |
| y | number | | | The row index of the cell to scroll to. |
| offsetX | number | | | Percentage offset the cell should be from the left edge (not including headers). The default is 0, meaning the cell will appear at the left edge. Valid values are 0 through 1. 1 = Left, 0 = Right, 0.5 = Center. |
| offsetY | number | | | Percentage offset the cell should be from the top edge (not including headers). The default is 0, meaning the cell will appear at the top edge. Valid values are 0 through 1. 1 = Bottom, 0 = Top, 0.5 = Center. |
gotoCell
| Name | Type | Optional | Default | Description |
|---|
gotoRow
Scrolls the row y.
| Name | Type | Optional | Default | Description |
|---|
| y | number | | | The row index of the cell to scroll to. |
gotoRow
| Name | Type | Optional | Default | Description |
|---|
Add a button into the cell.
| Name | Type | Optional | Default | Description |
|---|
| columnIndex | number | | | The column index of the cell to to add a button. |
| rowIndex | number | | | The row index of the cell to to add a button. |
| offset | object | | | Offset how far go away from cell. |
| items | object | | | a list of items to add into button menu. |
| imgSrc | string | | | icon path to add into button. |
| Name | Type | Optional | Default | Description |
|---|
toggleCellCollapseTree
Expand/Collapse CellTree.
| Name | Type | Optional | Default | Description |
|---|
| treeData | array | | | The array of cellTree to expand or collapse. |
toggleCellCollapseTree
| Name | Type | Optional | Default | Description |
|---|
expandCollapseCellTree
Expand/Collapse CellTree.
| Name | Type | Optional | Default | Description |
|---|
| treeData | array | | | The array of cellTree to expand or collapse. |
expandCollapseCellTree
| Name | Type | Optional | Default | Description |
|---|
Scrolls the cell at cell x, row y into view if it is not already.
| Name | Type | Optional | Default | Description |
|---|
| x | number | | | The column index of the cell to scroll into view. |
| y | number | | | The row index of the cell to scroll into view. |
| offsetX | number | | | Percentage offset the cell should be from the left edge (not including headers). The default is 0, meaning the cell will appear at the left edge. Valid values are 0 through 1. 1 = Left, 0 = Right, 0.5 = Center. |
| offsetY | number | | | Percentage offset the cell should be from the top edge (not including headers). The default is 0, meaning the cell will appear at the top edge. Valid values are 0 through 1. 1 = Bottom, 0 = Top, 0.5 = Center. |
| Name | Type | Optional | Default | Description |
|---|
setActiveCell
Sets the active cell. Requires redrawing.
| Name | Type | Optional | Default | Description |
|---|
| x | number | | | The column index of the cell to set active. |
| y | number | | | The row index of the cell to set active. |
setActiveCell
| Name | Type | Optional | Default | Description |
|---|
dispatchDataChanged
Dispatches datachanged with the source of the change so listeners can
react to edits, pastes, deletions and row/column changes, not only to the
data setter (#250, #512).
| Name | Type | Optional | Default | Description |
|---|
| source | string | | | One of data, edit, paste, cut, delete, fill, addrow, insertrow, deleterow, addcolumn, insertcolumn, deletecolumn. |
| details | object | | | Extra event details. |
dispatchResizeRow
Dispatches the resizerow event with one consistent payload (#503).
Canonical keys: rowIndex, height, width, x, y, draggingItem,
NativeEvent. cellHeight and row are kept as deprecated aliases of
height for listeners written against older versions.
| Name | Type | Optional | Default | Description |
|---|
| details | object | | | Event details; height is required. |
collapseTree
Collapse a tree grid by row index.
| Name | Type | Optional | Default | Description |
|---|
| index | number | | | The index of the row to collapse. |
collapseTree
| Name | Type | Optional | Default | Description |
|---|
expandTree
Expands a tree grid by row index.
| Name | Type | Optional | Default | Description |
|---|
| index | number | | | The index of the row to expand. |
expandTree
| Name | Type | Optional | Default | Description |
|---|
toggleTree
Toggles tree grid open and close by row index.
| Name | Type | Optional | Default | Description |
|---|
| index | number | | | The index of the row to toggle. |
toggleTree
| Name | Type | Optional | Default | Description |
|---|
Returns a header from the schema by name.
| Name | Type | Optional | Default | Description |
|---|
| name | string | | | The name of the column to resize. |
| Name | Type | Optional | Default | Description |
|---|
hideColumns
Hide column/columns
| Name | Type | Optional | Default | Description |
|---|
| beginColumnOrderIndex | number | | | The begin column order index |
| endColumnOrderIndex | number | | | The end column order index |
hideColumns
| Name | Type | Optional | Default | Description |
|---|
unhideColumns
Unihde column/columns
| Name | Type | Optional | Default | Description |
|---|
| beginColumnOrderIndex | number | | | The begin column order index |
| endColumnOrderIndex | number | | | The end column order index |
unhideColumns
| Name | Type | Optional | Default | Description |
|---|
hideRows
Hide rows
| Name | Type | Optional | Default | Description |
|---|
| beginRowIndex | number | | | The begin row index |
| endRowIndex | number | | | The end row index |
hideRows
| Name | Type | Optional | Default | Description |
|---|
unhideRows
Unhide rows
| Name | Type | Optional | Default | Description |
|---|
| beginRowIndex | number | | | The begin row index |
| endRowIndex | number | | | The end row index |
unhideRows
| Name | Type | Optional | Default | Description |
|---|
fitColumnToValues
Resizes a column to fit the longest value in the column. Call without a value to resize all columns.
Warning, can be slow on very large record sets (1m records ~3-5 seconds on an i7).
| Name | Type | Optional | Default | Description |
|---|
| name | string | | | The name of the column to resize. |
fitColumnToValues
| Name | Type | Optional | Default | Description |
|---|
isCellVisible
Checks if a cell is currently visible.
| Name | Type | Optional | Default | Description |
|---|
| columnIndex | number | | | The column index of the cell to check. |
| rowIndex | number | | | The row index of the cell to check. |
isCellVisible
| Name | Type | Optional | Default | Description |
|---|
order
Sets the order of the data.
| Name | Type | Optional | Default | Description |
|---|
| columnName | number | | | Name of the column to be sorted. |
| direction | string | | | asc for ascending or desc for descending. |
| sortFunction | function | | | When defined, override the default sorting method defined in the column's schema and use this one. |
| dontSetStorageData | bool | | | Don't store this setting for future use. |
order
| Name | Type | Optional | Default | Description |
|---|
addGroup
Add grouping
| Name | Type | Optional | Default | Description |
|---|
| groupFor | 'columns','rows' | | | |
| from | number | | | |
| to | number | | | |
removeGroup
Remove grouping
| Name | Type | Optional | Default | Description |
|---|
| allGroups | Array.<Array.<{from:number, to:number, collapsed:boolean}>> | | | |
| from | number | | | |
| to | number | | | |
groupColumns
Grouping columns
| Name | Type | Optional | Default | Description |
|---|
| firstColumnName | number,string | | | Name of the first column to be grouped. |
| lastColumnName | number,string | | | Name of the last column to be grouped. |
groupColumns
| Name | Type | Optional | Default | Description |
|---|
groupRows
Grouping columns
| Name | Type | Optional | Default | Description |
|---|
| rowIndexFrom | number | | | The row index which is the beginning of the group |
| rowIndexTo | number | | | The row index which is the end of the group |
groupRows
| Name | Type | Optional | Default | Description |
|---|
removeGroupColumns
Remove grouping columns
| Name | Type | Optional | Default | Description |
|---|
| firstColumnName | number,string | | | Name of the first column to be grouped. |
| lastColumnName | number,string | | | Name of the last column to be grouped. |
removeGroupColumns
| Name | Type | Optional | Default | Description |
|---|
removeGroupRows
Remove grouping columns
| Name | Type | Optional | Default | Description |
|---|
| rowIndexFrom | number | | | The row index which is the beginning of the group |
| rowIndexTo | number | | | The row index which is the end of the group |
removeGroupRows
| Name | Type | Optional | Default | Description |
|---|
toggleGroupColumns
Toggle(expand/collapsed) grouping columns
| Name | Type | Optional | Default | Description |
|---|
| firstColumnName | number,string | | | Name of the first column to be grouped. |
| lastColumnName | number,string | | | Name of the last column to be grouped. |
toggleGroupColumns
| Name | Type | Optional | Default | Description |
|---|
toggleGroupRows
Toggle(expand/collapsed) grouping rows
| Name | Type | Optional | Default | Description |
|---|
| rowIndexFrom | number | | | The row index which is the beginning of the group |
| rowIndexTo | number | | | The row index which is the end of the group |
toggleGroupRows
| Name | Type | Optional | Default | Description |
|---|
isInGrid
| Name | Type | Optional | Default | Description |
|---|
moveTo
Moves data in the provided selection to another position in the grid. Moving data off the edge of the schema (columns/x) will truncate data.
| Name | Type | Optional | Default | Description |
|---|
| sel | array | | | 2D array representing selected rows and columns. canvasDatagrid.selections is in this format and can be used here. |
| x | number | | | The column index to start inserting the selection at. |
| y | number | | | The row index to start inserting the selection at. |
moveTo
| Name | Type | Optional | Default | Description |
|---|
getGroupsColumnBelongsTo
Get the column group info given column belongs to
| Name | Type | Optional | Default | Description |
|---|
| columnIndex | number | | | Column index. |
getGroupsColumnBelongsTo
| Name | Type | Optional | Default | Description |
|---|
getGroupsRowBelongsTo
Get the row group info given row belongs to
| Name | Type | Optional | Default | Description |
|---|
| rowIndex | number | | | Row index. |
getGroupsRowBelongsTo
| Name | Type | Optional | Default | Description |
|---|
isColumnVisible
Checks if a given column is visible.
| Name | Type | Optional | Default | Description |
|---|
| columnIndex | number | | | Column index. |
isColumnVisible
| Name | Type | Optional | Default | Description |
|---|
isRowVisible
Checks if a given row is visible.
| Name | Type | Optional | Default | Description |
|---|
| rowIndex | number | | | Row index. |
isRowVisible
| Name | Type | Optional | Default | Description |
|---|
getVisibleCellByIndex
Gets the cell at columnIndex and rowIndex.
| Name | Type | Optional | Default | Description |
|---|
| x | number | | | Column index. |
| y | number | | | Row index. |
getVisibleCellByIndex
| Name | Type | Optional | Default | Description |
|---|
getUnhideIndicator
Get an unhide indicator at grid pixel coordinate x and y.
| Name | Type | Optional | Default | Description |
|---|
| x | number | | | Number of pixels from the left. |
| y | number | | | Number of pixels from the top. |
getUnhideIndicator
| Name | Type | Optional | Default | Description |
|---|
getColumnGroupAt
Get a column group at grid pixel coordinate x and y.
| Name | Type | Optional | Default | Description |
|---|
| x | number | | | Number of pixels from the left. |
| y | number | | | Number of pixels from the top. |
getColumnGroupAt
| Name | Type | Optional | Default | Description |
|---|
getRowGroupAt
Get a row group at grid pixel coordinate x and y.
| Name | Type | Optional | Default | Description |
|---|
| x | number | | | Number of pixels from the left. |
| y | number | | | Number of pixels from the top. |
getRowGroupAt
| Name | Type | Optional | Default | Description |
|---|
getCellAt
Gets the cell at grid pixel coordinate x and y. Author's note. This function ties drawing and events together. This is a very complex function and is core to the component.
| Name | Type | Optional | Default | Description |
|---|
| x | number | | | Number of pixels from the left. |
| y | number | | | Number of pixels from the top. |
getCellAt
| Name | Type | Optional | Default | Description |
|---|
getBorder
| Name | Type | Optional | Default | Description |
|---|
getSchemaFromData
Returns an auto generated schema based on data structure.
| Name | Type | Optional | Default | Description |
|---|
getSchemaFromData
| Name | Type | Optional | Default | Description |
|---|
clearChangeLog
Clears the change log grid.changes that keeps track of changes to the data set.
This does not undo changes or alter data it is simply a convince array to keep
track of changes made to the data since last this method was called.
| Name | Type | Optional | Default | Description |
|---|
clearChangeLog
| Name | Type | Optional | Default | Description |
|---|
findColumnMaxTextLength
Returns the maximum text width for a given column by column name.
| Name | Type | Optional | Default | Description |
|---|
| name | string | | | The name of the column to calculate the value's width of. |
findColumnMaxTextLength
| Name | Type | Optional | Default | Description |
|---|
Gets the total width of all header columns.
| Name | Type | Optional | Default | Description |
|---|
| Name | Type | Optional | Default | Description |
|---|
getRowHeight
Gets the height of a row by index.
| Name | Type | Optional | Default | Description |
|---|
| rowIndex | number | | | The row index to lookup. |
getRowHeight
| Name | Type | Optional | Default | Description |
|---|
getColumnWidth
Gets the width of a column by index.
| Name | Type | Optional | Default | Description |
|---|
| columnIndex | number | | | The column index to lookup. |
getColumnWidth
| Name | Type | Optional | Default | Description |
|---|
getLastVisibleColumnIndex
| Name | Type | Optional | Default | Description |
|---|
isColumnCollapsed
| Name | Type | Optional | Default | Description |
|---|
string
| Name | Type | Optional | Default | Description |
|---|
string
| Name | Type | Optional | Default | Description |
|---|
toComparable
| Name | Type | Optional | Default | Description |
|---|
number
| Name | Type | Optional | Default | Description |
|---|
date
| Name | Type | Optional | Default | Description |
|---|
| Name | Type | Optional | Default | Description |
|---|