If using the new style context, re-declare this in your class to be the
React.ContextType of your static contextType.
Should be used with type annotation or static contextType.
static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
Readonly propsStatic Optional contextIf set, this.context will be set at runtime to the current value of the given Context.
Usage:
type MyContext = number
const Ctx = React.createContext<MyContext>(0)
class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}
Sets or gets the grid selection mode.
Gets or sets the position of the active cell.
Called when the active cell changes.
Called when the active cell changes.
Gets the actual border width.
Gets the height used for the header row.
Gets either the inferred primary key from the data source, or the user provided primary key, if present. Represents the actual primary key that the grid will use in operations that require it.
Gets the actual height for the rows in the grid.
Gets the region of the grid that is visible.
Sets or gets the default animation settings for the grid.
Gets or sets whether to automatically accept edits or require explicit acceptance or rejections of edits when handling the CellValueChanging or DataCommitting events. When True, nothing is required on the part of the developer in order for edits to be accepted. In order to validate and reject a user cell edit you must explicitly handle the CellValueChanging event and call the RejectEdit method using the edit ID provided by the event. In order to reject a whole commit you need to handle the DataComitting event and explicitly call the RejectCommit method using the commit ID provided by the event. When False, cell edits are not immediately accepted until you explicitly call the AcceptEdit method using the edit ID provided by the CellValueChanging event. If you do not handle this event then edits will be auto accepted.
Configures whether or not the grid will autogenerate columns when the data source is set.
Gets or sets the desired properties the grid will automatically generate columns for.
Gets or sets the border color around the grid.
Gets whether a commit can be performed. False if there are any errors present on any pending transactions.
Gets whether a redo can be performed.
Gets whether an undo can be performed.
Gets or sets the default background color to use for content cells
Called when a cell is clicked.
Called when a cell is clicked.
Sets or gets the cell data loaded animation mode to use.
Called when a cell has finished editing.
Called when a cell has finished editing.
Called when a cell has started editing.
Called when a cell has started editing.
Indicates a pointer is down on a cell.
Indicates a pointer is down on a cell.
Indicates a pointer is up on a cell.
Indicates a pointer is up on a cell.
Previews that a pointer is down on a cell.
Previews that a pointer is down on a cell.
Previews that a pointer is up on a cell.
Previews that a pointer is up on a cell.
Gets or sets the default background color to use for content cells when a row is in a selected state
Sets or gets the cell selection animation mode to use.
Gets or sets the default text color to use for content cells
Gets or sets the font to use for content cells
Called when a cell has been edited.
Called when a cell has been edited.
Gets or sets whether selection is cleared when pressing the Escape key.
Sets or gets the Column Adding Animation mode to use.
Sets or gets the column exchanging animation mode to use.
Called when a column is hidden or unhidden.
Called when a column is hidden or unhidden.
Sets or gets the column hiding animation mode to use.
Sets or gets the column moving animation mode to use.
Gets or sets the type column moving to use.
Gets or sets the column resizing seperator settings.
Gets or sets the default background color to use for column moving separator.
Gets or sets the opacity of the column moving separator.
Sets or gets the width to use for the column resizing separator.
Gets or sets the column options icon alignment in header cells.
Gets or sets how the column options icon will behave inside header cells.
Gets or sets the column options icon color in header cells.
Called when a column is pinned or unpinned.
Called when a column is pinned or unpinned.
Sets or gets the Column Property Updating Animation mode to use.
Sets or gets the column resizing animation mode to use. Only applies when resizing in Deferred mode.
Gets or sets the type of column resizing to use.
Gets or sets the column resizing seperator settings.
Gets or sets the default background color to use for column resizing separator.
Gets or sets the opacity of the column Resizing separator.
Sets or gets the width to use for the column resizing separator.
Sets or gets the column showing animation mode to use.
Called when a column's Width property has changed.
Called when a column's Width property has changed.
A collection or manually added columns for the grid.
Called when the columns are autogenerated.
Called when the columns are autogenerated.
Called when edits have been committed to the datasource.
Called when edits have been committed to the datasource.
Called when edits are about to be committed to the datasource.
Called when edits are about to be committed to the datasource.
Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source.
Gets or sets the default minimum width to use on all columns. Ignored if NaN.
Gets or sets the default column width to use if a column as no local width.
Gets or sets whether to defer the SelectedItemsChanged and SelectedKeysChanged events till after the drag selection has completed.
Gets or sets the text color for unsaved deleted rows.
Gets or sets the display density to use for the grid.
Gets or sets the type of edit mode
Gets or sets the type of click action required to enter edit mode.
Gets or sets whether edit mode will begin as soon as you start typing while a cell is active.
Gets or sets the default opacity for unsaved cell edits.
Gets or sets the border color for rows being edited.
Gets or sets the font to use for cells that have been edited.
Gets or sets the behavior of the Enter key.
Gets or sets the behavior of the enter key when exiting edit mode.
Gets or sets whether UI filters are case sensitive or not.
Gets the current filter that is applied to the grid. Collection can be updated to modify the filter for the grid. Once filter expresisons are in this collection, the grid will no longer listen for changes on their properties.
Gets or sets how filters set through the filter UI are combined.
Gets or sets which filter UI type to use.
Gets the current grouping that is applied to the grid. Collection can be updated to modify the grouping for the grid. Once grouping descriptions are in this collection, the grid will no longer listen for changes on their properties.
Called when grouping has changed.
Called when grouping has changed.
Gets or sets how group headers are displayed when there are multiple groups defined in the grid.
Gets or sets the display mode summaries will use inside groups.
Gets or sets the default background color to use for header cells
Returns/sets the action to take when a column header is clicked.
Gets or sets the height to use for the header row.
Gets or sets the header row seperator settings.
Gets or sets the header seperator settings.
Gets or sets the default background color to use for header separators.
Gets or sets the width of the header separators.
Gets or sets the default text color to use for content cells
Gets or sets the default render style for sort indicators in header cells.
Gets or sets the default text color to use for header cells
Gets or sets the font to use for header cells
Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties.
Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties.
Gets the current summaries that are applied to the grid.
Gets or sets the amount of bottom inset space to use around the grid content.
Gets or sets the amount of left inset space to use around the grid content.
Gets or sets the amount of right inset space to use around the grid content.
Gets or sets the amount of top inset space to use around the grid content.
Gets or sets whether the active cell style will be applied to cells when made active.
Gets or sets whether to show the column options UI in the headers for columns.
Gets or sets whether to show the grouping option in the column options menu.
Gets or sets whether to show the summaries option in the column options menu.
Gets or sets if the Column Grouping Area should be shown and enabled
Gets or sets whether group headers are collapsable.
Gets or sets whether groups are expanded or collapsed by default.
Gets or sets if group rows will stick to the top of the grid.
Gets or sets if header separators are rendered.
Gets or sets whether to show the pager or not.
Configures whether or not place holders are used for cells who do not have their data yet.
Gets or sets whether the row will highlight when hovered.
Gets or sets whether to show the column chooser button in the toolbar.
Gets or sets whether to show the column pinning button in the toolbar.
Gets or sets whether to show the toolbar.
Gets or sets the default color to use for the last sticky row
Gets or sets how cells are evaluated for merging.
Gets or sets if and how cell merging is performed for all fields.
Gets or sets the vertical alignment to use for the merged cell content.
Gets or sets the ability to select rows or cells via mouse dragging. Currently only applies when SelectionMode is MultipleRow or RangeCell.
Gets or sets if the grid should notify on programmatic selection changes as well as changes from the UI.
Gets or sets the size of each page when the pager is visible.
Gets or sets the pinned area separator settings.
Gets or sets the width of the pinned area separators.
Gets which items are currently pinned in the grid. Collection can be updated to programatically pin items.
Gets which primary keys are currently pinned in the grid. Collection can be updated to programatically pin items.
Gets or sets the default color to use for pinned rows
Gets or sets the default opacity to use for pinned rows
Sets or gets the user provided primary key to assume for the data. Certain functionality of the grid requires a way to uniquely identify items in order to work correctly. If a primary key cannot be inferred from the data source, you may need to provide one here.
Sets or gets whether the grid will react to filter changes.
Sets or gets whether the grid will react to group changes.
Sets or gets whether the grid will react to sort changes.
A set of states that can be applied to the columns of the grid based on available space.
Called when a row has finished editing.
Called when a row has finished editing.
Called when a row has started editing.
Called when a row has started editing.
Gets or sets the height to use for the rows in the grid. If not set the grid will use the default value for the set display density.
Sets or gets the row hover animation mode to use.
Gets or sets the background color for rows when hovered.
Gets or sets the text color for rows when hovered.
Sets or gets the row selection animation mode to use.
Gets or sets the row seperator settings.
Gets or sets the default background color to use for row separators
Sets or gets the height to use for the row separators.
Gets or sets the default last sticky row background color to use for row separators
Gets or sets the pinned row background color to use for row separators
Gets or sets the default sticky row background color to use for row separators
Gets or sets the scrollbar background color.
Gets or sets the style of scrollbar.
Gets or sets the header type used for sectioning off groups of rows.
Gets or sets the default background color to use for section header cells
Gets or sets the default background color to use for section header cells when a row is in a selected state
Gets or sets the default text color to use for section header cells
Gets or sets the font to use for section header cells
Gets which cell ranges are currently selected in the grid. Collection can be updated to programatically select cells.
Called when the selected cell ranges changed.
Called when the selected cell ranges changed.
Gets which cells are currently selected in the grid. Collection can be updated to programatically select cells.
Called when the selected cells change.
Called when the selected cells change.
Gets which items are currently selected in the grid. Collection can be updated to programatically select items.
Called when the selected items change.
Called when the selected items change.
Gets which primary key values are currently selected in the grid. Collection can be updated to programatically select items.
Called when the selected keys change.
Called when the selected keys change.
Sets or gets how selection behaves in the grid.
Called when an individual selection operation has been made.
Called when an individual selection operation has been made.
Sets or gets the grid selection mode.
Gets or sets if the section header content should be shifted into the normal column scrollable area when there are pinned columns
Called when the grids size has changed.
Called when the grids size has changed.
Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties.
Called when sorting has changed.
Called when sorting has changed.
Gets or sets the default color to use for sticky rows
Gets the current summaries that are applied to the grid.
Called when summaries have changed.
Called when summaries have changed.
Gets or sets the default background color to use for summary cells at the root level.
Gets or sets the default text color to use for summary labels in summary cells at the root level.
Gets or sets the font to use for summary labels at the root level.
Gets or sets the default background color to use for summary cells at the root level.
Gets or sets the default text color to use for summary cells at the root level.
Gets or sets the font to use for summary values at the root level.
Gets or sets the cell definition used for summary rows at the root level.
Gets or sets the cell definition used for summary rows at the section level.
Gets or sets the scope which summaries are calculated for.
Gets or sets the default background color to use for summary cells at the section level.
Gets or sets the default text color to use for summary labels in summary cells at the section level.
Gets or sets the font to use for summary labels at the section level.
Gets or sets the default background color to use for summary cells at the section level.
Gets or sets the default text color to use for summary cells at the section level.
Gets or sets the font to use for summary values at the section level.
Gets or sets the column chooser button text to use in the toolbar.
Gets or sets the column chooser title text to use in the toolbar.
Gets or sets the column pinning button text to use in the toolbar.
Gets or sets the column pinning title text to use in the toolbar.
Gets or sets the title text to use in the toolbar.
Optional UNSAFE_Called immediately before mounting occurs, and before Component#render.
Avoid introducing any side-effects or subscriptions in this method.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
16.3, use componentDidMount or the constructor instead
Optional UNSAFE_Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.
Calling Component#setState generally does not trigger this method.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
16.3, use static getDerivedStateFromProps instead
Optional UNSAFE_Called immediately before rendering when new props or state is received. Not called for the initial render.
Note: You cannot call Component#setState here.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
16.3, use getSnapshotBeforeUpdate instead
Optional componentOptional componentCalled immediately after updating occurs. Not called for the initial render.
The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.
Optional componentCalled immediately before mounting occurs, and before Component#render.
Avoid introducing any side-effects or subscriptions in this method.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
16.3, use componentDidMount or the constructor instead; will stop working in React 17
Optional componentCalled when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.
Calling Component#setState generally does not trigger this method.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
16.3, use static getDerivedStateFromProps instead; will stop working in React 17
Optional componentCalled immediately before rendering when new props or state is received. Not called for the initial render.
Note: You cannot call Component#setState here.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17
Gets the column that appears at the index specified. This is not the columns actual index in the column's collection but the index for how it appears visually in the grid.
Get the cell that contains the provided coordinates.
Optional getRuns before React applies the result of render to the document, and
returns an object to be given to componentDidUpdate. Useful for saving
things such as scroll position before render causes changes to it.
Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.
Resolves the value of a specific cell.
The columns actually present in the grid. Do not directly modify this array. This array's contents can be modified by causing React to reproject the child content. Or adding and removing columns from the manual columns collection on the columns property.