Interface: FilterData

Filter.FilterData

Description

Interface containing information about a Filter on a field

Properties

• conditions
• enabled
• field
• fieldDisplayNameOverride
• global
• hidden
• multiple
• pivotOnField
• searchNodeToHide
• userGlobal
• widgetNative
• widgetUuid

Properties

conditions

• conditions: FilterCondition[]

Filter conditions to be applied to the given field

enabled

• Optionalenabled: boolean

Toggle to determine if filter should be used or not

field

• field: string

Name of field being filtered on

fieldDisplayNameOverride

• OptionalfieldDisplayNameOverride: string

Optional field to override the display name of a field. If this field is set then it will be used to display on filter cards

global

• Optionalglobal: boolean

Toggle to determine if this filter should be applied to the Global filter sub section

hidden

• Optionalhidden: boolean

Toggle to determine if this filter should be applied to the Hidden filter sub section

multiple

• Optionalmultiple: boolean

Optional GUID field to uniquely identify conditions when multiple conditions are placed on the same field

pivotOnField

• OptionalpivotOnField: string

Optional field set by visualization filters to represent the pivot on field of pivot filters

searchNodeToHide

• OptionalsearchNodeToHide: number

Optional field set by CustomConditionService to remove search from list of saved searches

userGlobal

• OptionaluserGlobal: boolean

Toggle to determine if this filter should be applied to the UserGlobal filter sub section

widgetNative

• OptionalwidgetNative: boolean

Toggle to determine if this filter should be applied to the WidgetNative filter sub section

widgetUuid

• OptionalwidgetUuid: string

Optional GUID field to specify what widget created the filter