core/data-grid/data-grid.model.ts
Defines an interface for a filter chip object, which represents a filter applied to a column.
Properties |
|
| columnName |
columnName:
|
Type : string | SpecialColumnName
|
|
The name of the column that this filter is applied to. |
| displayValue |
displayValue:
|
Type : string
|
|
The value that the chip will display in the dropdown. |
| externalFilterQuery |
externalFilterQuery:
|
Type : any
|
| Optional |
|
An optional property that holds the form value taken from the column configuration. |
| filteringConfig |
filteringConfig:
|
Type : FormlyColumnFilteringConfig
|
| Optional |
|
An optional property that holds the formly filtering configuration for the column that this filter is applied to. |
| filterPredicate |
filterPredicate:
|
Type : string
|
| Optional |
|
An optional property that holds a string to search for. |
| label |
label:
|
Type : string
|
| Optional |
|
Optional label that will be displayed if filter chips are separated into multiple groups. |
| path |
path:
|
Type : string[]
|
| Optional |
|
An optional property that holds the path to the chip value in the externalFilterQuery. |
| remove |
remove:
|
Type : function
|
| Optional |
|
An optional function to remove this filter from the column.
If not provided will set default removal function that will reduce the external query by removing the object that is resolved by the path set in the FilterChip.
The returned object may also include additional properties defined by the |
| value |
value:
|
Type : any
|
|
The actual value that the chip will hold. It can be just a string or a more complex object like {id: 123, name: Test, value: test}. |