Class WidgetFilterSettingProvider

Hierarchy (View Summary)

WidgetSettingProvider<WidgetFilterRecord>
- WidgetFilterSettingProvider

Implements

WidgetFilterSettingProviderType

Index

Constructors

Accessors

widgetAttributeName widgetElement

Methods

getData getFilter getMenuItems getTags getWidgetAttributeValue parseWidgetAttribute readWidgetAttribute selectMenuItem serializeData setData setFilter subscribe unsubscribe updateWidgetAttribute

Constructors

constructor

new WidgetFilterSettingProvider(
__namedParameters: WidgetFilterSettingProviderConfig,
): WidgetFilterSettingProvider
Parameters
- __namedParameters: WidgetFilterSettingProviderConfig
Returns WidgetFilterSettingProvider
Overrides WidgetSettingProvider.constructor
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-filter-setting-provider.ts:39

Accessors

widgetAttributeName

get widgetAttributeName(): null | string
Returns null | string
Inherited from WidgetSettingProvider.widgetAttributeName
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-setting-provider.ts:40

widgetElement

get widgetElement(): HTMLElement
Returns HTMLElement
Inherited from WidgetSettingProvider.widgetElement
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-setting-provider.ts:36

Methods

getData

getData(): null | WidgetFilterRecord
Returns null | WidgetFilterRecord
Implementation of WidgetFilterSettingProviderType.getData
Inherited from WidgetSettingProvider.getData
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-setting-provider.ts:44

getFilter

getFilter(): null | WidgetFilterRecord
Returns null | WidgetFilterRecord
Implementation of WidgetFilterSettingProviderType.getFilter
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-filter-setting-provider.ts:47

getMenuItems

getMenuItems(): WidgetMenuItem[]
Returns WidgetMenuItem[]
Implementation of WidgetFilterSettingProviderType.getMenuItems
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-filter-setting-provider.ts:59

getTags

getTags(): Promise<WidgetFilterTag[]>
Returns Promise<WidgetFilterTag[]>
Implementation of WidgetFilterSettingProviderType.getTags
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-filter-setting-provider.ts:55

getWidgetAttributeValue

getWidgetAttributeValue(): string
Returns string
Inherited from WidgetSettingProvider.getWidgetAttributeValue
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-setting-provider.ts:111

parseWidgetAttribute

parseWidgetAttribute(): null | WidgetFilterRecord
Returns null | WidgetFilterRecord
Inherited from WidgetSettingProvider.parseWidgetAttribute
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-setting-provider.ts:119

readWidgetAttribute

readWidgetAttribute(): void
Returns void
Inherited from WidgetSettingProvider.readWidgetAttribute
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-setting-provider.ts:81

selectMenuItem

selectMenuItem(_item: WidgetMenuItem): void
Parameters
- _item: WidgetMenuItem
Returns void
Implementation of WidgetFilterSettingProviderType.selectMenuItem
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-filter-setting-provider.ts:64

serializeData

serializeData(): string
Returns string
Inherited from WidgetSettingProvider.serializeData
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-setting-provider.ts:135

setData

setData(data: null | WidgetFilterRecord): void
Parameters
- data: null | WidgetFilterRecord
Returns void
Implementation of WidgetFilterSettingProviderType.setData
Inherited from WidgetSettingProvider.setData
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-setting-provider.ts:48

setFilter

setFilter(value: null | WidgetFilterRecord): void
Parameters
- value: null | WidgetFilterRecord
Returns void
Implementation of WidgetFilterSettingProviderType.setFilter
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-filter-setting-provider.ts:51

subscribe(callback: WidgetSettingCallback<null | WidgetFilterRecord>): string
Parameters
- callback: WidgetSettingCallback<null | WidgetFilterRecord>
Returns string
Implementation of WidgetFilterSettingProviderType.subscribe
Inherited from WidgetSettingProvider.subscribe
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-setting-provider.ts:57

unsubscribe

unsubscribe(subscriberId: string): void
Parameters
- subscriberId: string
Returns void
Implementation of WidgetFilterSettingProviderType.unsubscribe
Inherited from WidgetSettingProvider.unsubscribe
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-setting-provider.ts:63

updateWidgetAttribute

updateWidgetAttribute(): void
Returns void
Inherited from WidgetSettingProvider.updateWidgetAttribute
- Defined in packages/ux-utils/src/widgetApi/widget-setting-provider/widget-setting-provider.ts:89