Providing Custom Column Values when Editing

Summary

AdapTable usually fetches a Column's distinct values when using the Select Cell Editor or Bulk Update dropdown
Developers are able to override this default behaviour by providing a bespoke list of custom values

By default, when using the Select Cell Editor or the Bulk Update dropdown, AdapTable will loop through all the values in AG Grid for that column, retrieving and then displaying all the distinct items.

Hint

AdapTable will ignore case sensitivity by default, e.g. will return "EUR" and "eur" as 2 separate items
This can be changed by setting the caseSensitivePredicates property in Predicate Options to true

Alternatively developers can supply a list of bespoke, custom values to be displayed instead.

This is provided using the customEditColumnValues property in Edit Options.

customEditColumnValues

CustomEditColumnValueInfo[]

Provide custom list of values to display in Edit controls

CustomEditColumnValueInfo[]

Use this property to change the list shown by AdapTable when using Edit controls that display distinct column values.

It is a function that receives a CustomEditColumnValuesContext object and returns a CustomEditColumnValueInfo array.

Hint

The function can also be run asynchronously to return a Promise<CustomEditColumnValueInfo[]> if required

The CustomEditColumnValuesContext object received by the function is defined as follows:

Property	Description
currentSearchValue	Search text in Edit - used when fetching values from server
defaultValues	Current distinct values in Column
gridCell	Currently edited Grid Cell
adaptableContext	Custom application Context provided in `AdaptableOptions.adaptableContext`

The CustomEditColumnValueInfo object returned by the function (as an array) is defined as follows:

Property
label
value

Edit Custom Values

Fork Fork

In this Demo we provide custom editing values for 2 Columns by using the customEditColumnValues property:
- License - returns 'Permissive', 'LGPL', 'MIT', 'Public Domain'
- Language - returns a different list for rows where Licence is not MIT License
Note: we provide a Select Cell Editor for both columns

Try It Out

Click in a cell in either Column to see the bespoke values
Attempt a Bulk Update on either Column to see the same bespoke values

PreviousStyling Editable Cells NextTechnical Reference