Member Junction
    Preparing search index...

    Interface FilterFieldInfo

    Metadata about a field that can be filtered

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

    Properties

    description? displayName lookupEntityName? name sqlType? type valueList?

    Properties

    description?: string

    Optional description shown as helper text in the field picker

    displayName: string

    Display name shown in the UI

    lookupEntityName?: string

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

    name: string

    The field name (must match entity field name)

    sqlType?: string

    Optional underlying SQL or technical type badge shown in the field picker

    type: FilterFieldType

    The data type of the field

    valueList?: FilterValueOption[]

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

    Settings

    Member Visibility

    On This Page

    Properties