Interface FilterFieldInfo

Metadata about a field that can be filtered

interface FilterFieldInfo {
    displayName: string;
    lookupEntityName?: string;
    name: string;
    type: FilterFieldType;
    valueList?: FilterValueOption[];
}

Index

Properties

displayName lookupEntityName? name type valueList?

Properties

displayName

displayName: string

Display name shown in the UI

`Optional`lookupEntityName

lookupEntityName?: string

For lookup fields, the entity name to look up records from

name

name: string

The field name (must match entity field name)

type

type: FilterFieldType

The data type of the field

`Optional`valueList

valueList?: FilterValueOption[]

For fields with a fixed set of values, the available options