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}</>;
}
}
Gets or sets the background color to use.
Gets or sets the amount of bottom activation border to use for the cell content of this column.
Gets or sets the amount of left activation border to use for the cell content for this column.
Gets or sets the amount of right activation border to use for the cell content of this column.
Gets or sets the amount of top activation border to use for the cell content for this column.
Gets the actual background color that will be used.
Gets the actual background color that will be used.
Gets the actual border color that will be used.
Gets the actual column options icon alignment for this column.
Gets or sets how the column option icon will behave in the column header.
Gets the actual column options icon color for this column.
Gets the actual text color used for deleted rows.
Gets the actual font style used for unsaved cell edits.
Gets the actual opacity for unsaved edited cell values.
Gets the actual error border color that will be used.
Gets the actual text displayed in the header of the column
Gets the actual background color that is used for the cells when they are hovered.
Gets the actual state of the column options for this column.
Gets the actual state of grouping menu in the column options for this column.
Gets the actual state of summaries menu in the column options for this column.
Gets the actual color for the last row in the sticky row area.
Gets the actual line break mode which will be used if text is present in the cell.
Gets the actual background color for cells belonging to rows marked as pinned.
Gets or sets the color to use for displaying text.
Gets the actual text color that is used for the cells when they are hovered.
Gets the actual background color that is used for the cells when they are selected
Gets the actual background color for content that sticks to the top of the grid.
Gets the actual color used for displaying text.
Gets or sets the animation settings to use for this column.
Gets or sets the background color to use.
Gets or sets the background color to use.
Gets or sets the amount of bottom border to use for the cell content of this column.
Gets or sets the amount of left border to use for the cell content for this column.
Gets or sets the amount of right border to use for the cell content of this column.
Gets or sets the amount of top border to use for the cell content for this column.
Called when the style key for a cell is needed. Used for recycling the cell.
Called when the style key for a cell is needed. Used for recycling the cell.
Gets or sets whether the column options icon is aligned opposite the header text or not.
Gets or sets how the column option icon will behave in the column header.
Gets or sets the column options icon color for this column.
Gets or sets the opacity of the content.
Called when a cell is data binding.
Called when a cell is data binding.
Called when a cell has been data bound.
Called when a cell has been data bound.
Gets or sets the text color used for deleted rows.
Gets or sets the opacity to use for unsaved edited cell values.
Gets or sets the ComboBox data source.
Gets or sets the ComboBox text field.
Gets or sets the editor type used for editing cells in this column.
Gets or sets the ComboBox value field.
Gets or sets the error border color to use.
Gets or sets the key used for the column binding
Gets or sets a filter to apply on the values of this column
Gets or sets whether UI filters are case sensitive or not.
Gets or sets a filter to apply to the values of this column.
Gets a list of the current custom filters for this column.
Gets or sets the INTL NumericFormat object to use for formatting the date values.
Gets or sets the format string to apply to the value. If set, the other value formatting properties on this column are ignored.
Gets or sets the header definition for this column.
Gets or sets the text displayed in the header of the column
Gets or sets the horizontal alignment to use for the cell content.
Gets whether this column was auto generated.
Gets or sets the preferred state of the column options for this column. If the feature is disabled at the grid level then it will be disabled for the column regardless of what this is set to.
Gets or sets whether to show the grouping option in the column options menu for this column.
Gets or sets whether to show the summaries option in the column options menu for this column.
Gets or sets if the column is editable.
Gets or sets whether filtering is enabled for this column.
Gets whether this column was projected from markup/templates and is constrained.
Gets or sets whether or not a column is hidden from the grid
Gets or sets whether resizing is enabled for this column.
Gets or sets the color for the last row in the sticky row area.
Gets or sets the line breaking mode to use if text is present in the cell.
Gets or sets the maximum fraction digits. If FormatString is specificied this value is ignored.
Gets or sets how cells are evaluated for merging.
Gets or sets if and how cell merging is performed for this field.
Gets or sets the amount of bottom padding to use for the cell content of this column.
Gets or sets the amount of left padding to use for the cell content for this column.
Gets or sets the amount of right padding to use for the cell content of this column.
Gets or sets the amount of top padding to use for the cell content for this column.
Gets or sets the vertical alignment to use for the merged cell content.
Gets or sets the minimum fraction digits. If FormatString is specificied this value is ignored.
Gets or sets the minimum integer digits. If FormatString is specificied this value is ignored.
Gets or sets the minimum width to use for this column. Overrides the DefaultColumnMinWidth from the grid, if set.
Gets or sets an unique name of the Column
Gets or sets the string to prefix a negative value. If FormatString is specificied this value is ignored.
Gets or sets the string to suffix a negative value. If FormatString is specificied this value is ignored.
Gets or sets the amount of bottom padding to use for the cell content of this column.
Gets or sets the amount of left padding to use for the cell content for this column.
Gets or sets the amount of right padding to use for the cell content of this column.
Gets or sets the amount of top padding to use for the cell content for this column.
Gets or sets the current fixed position for this column.
Gets or sets the background color for cells belonging to rows marked as pinned.
Gets or sets the color to use for displaying text.
Gets or sets the string to prefix a positive value. If FormatString is specificied this value is ignored.
Gets or sets the string to suffix a positive value. If FormatString is specificied this value is ignored.
Gets or sets the background color to use for the cells when the row is hovered.
Gets or sets the text color to use for the cells when the row is hovered.
Gets or sets the background color to use for the cells when they are selected
Gets or sets if a column should be removed from the grid when it is fully hidden
Gets or sets whether to show a grouping separator. If FormatString is specificied this value is ignored.
Gets the current sort direction (None, Ascending, Descending) for this column.
Gets or sets the background color for content that sticks to the top of the grid.
Gets or sets the color to use for displaying text.
Gets or sets the font style to use for unsaved cell edits.
Gets or sets the vertical alignment to use for the cell content.
Gets or sets the width to use for this column.
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
componentOptional
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
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.
Static
_create
Represents a Numeric grid column, used to allow the developer to display a formatted number in a cell.