Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CategoricalPulseFilter

A Pulse Categorical Filter

Hierarchy

Index

Properties

Properties

appliedValues

appliedValues: PulseFieldValueArray

A list of values applied to this categorical filter. Notice that if the Pulse metric has a definition filter, the current relevant values can be fetched by calling getDomainAsync(FilterDomainType.Relevant).

fieldName

fieldName: string

The name of the field being filtered. Note that this is the caption as shown in the UI, and not the actual database field name.

filterType

filterType: FilterType

The type of the filter.

getDomainAsync

getDomainAsync: (searchTerm?: undefined | string, pageSize?: undefined | number, nextPageToken?: undefined | string, domainType?: FilterDomainType) => Promise<PulseCategoricalDomain>

Gets the domain of a categorical filter.

param

The term to search for in the domain.

param

The maximum number of values to return. Ignored when nextPageToken is not provided.

param

The next page token returned by Pulse when additional values are available.

param

The domain type of the filter.

returns

A promise containing the categorical domain for the filter.

Type declaration

Optional isAllSelected

isAllSelected: undefined | false | true

True if all the values are selected for this filter. When 'All' is selected, appliedValues returns an empty list.

isExcludeMode

isExcludeMode: boolean

True if this filter is an exclude filter, false if an include filter.

metricId

metricId: string

The Pulse metric ID.