After editing cells in the grid you have the opportunity to parse the value before inserting it into your data. This is done using Value Parsers.
For example suppose you are editing a number using a text editor. The result will be a
string, however you will probably want to store the result as a
number. Use a Value Parser to convert the
string to a
/* other grid options ... */>
this.columnDefs = [
// name is a string, so don't need to convert
// age is a number, so want to convert from string to number
valueParser: params => Number(params.newValue)
Typestring | ValueParserFunc
Function or expression. Parses the value for saving.
If using Cell Data Types, Value Parsers are set by default to handle the conversion of each of the different data types.
The return value of a value parser should be the result of the parse, i.e. return the value you want stored in the data.
Below shows an example using value parsers. The following can be noted:
- All columns are editable. After any edit, the console prints the new data for that row.
- Column 'Name' is a string column. No parser is needed.
- Column 'Bad Number' is bad because after an edit, the value is stored as a string in the data, whereas the data value should be number type.
- Column 'Good Number' is good because after an edit, the value is converted to a number using the value parser.
By default, the grid uses the value parser when performing other grid operations that can update values.
This behaviour can be prevented by setting the column definition property
useValueParserForImport = false (note this does not apply to editing).
By default, values are parsed using the column's
valueParser when importing data to the grid.
This applies to clipboard operations and the fill handle.
false to prevent values from being parsed for these operations.
Regardless of this option, if custom handling is provided for the import operation, the value parser will not be used.
Using the value parser for import applies to the following features:
The following example demonstrates using the value parser for import with each of the supported features mentioned above.
Note that if you are providing your own custom handling for the following features, then
useValueParserForImport is ignored and the value will be either the original value or that set in the custom handler:
processCellFromClipboardis provided when using paste.
fillOperationis provided when using fill handle.
processCellFromClipboardis provided when using copy range down.