File

src/ui/filter/smart-filter-registry.service.ts

Description

A service used to register Smart Filters and obtain references to them.

Example

Index

Properties
Methods

Methods

deregisterFilter
deregisterFilter(name: string)

Deregisters the ISmartFilter registered under the given name and allows another ISmartFilter to be registered under that name.

Parameters :
Name Type Optional
name string No
Returns : void
getFilter
getFilter(name: string)

Returns the ISmartFilter instance registered under the given name.

Parameters :
Name Type Optional
name string No
Returns : ISmartFilter
registerFilter
registerFilter(name: string, filter: ISmartFilter)

Registers a Smart Filter under the given name. Throws an error if a Smart Filter has already been registered under that name.

Parameters :
Name Type Optional
name string No
filter ISmartFilter No
Returns : void
registerStaticFilter
registerStaticFilter(name: string, filter: SmartStaticFilterComponent)

Registers a Static Smart Filter under the given name. Throws an error if a Smart Filter has already been registered under that name.

Parameters :
Name Type Optional
name string No
filter SmartStaticFilterComponent No
Returns : void

Properties

filterRegistered
Type : EventEmitter<FilterRegistryEvent>
Default value : new EventEmitter< FilterRegistryEvent >()

Fires when a Smart Filter has been registered.

filterRemoved
Type : EventEmitter<FilterRegistryEvent>
Default value : new EventEmitter< FilterRegistryEvent >()

Fires when a Smart Filter has been deregistered.

result-matching ""

    No results matching ""