Components Filters Filter

Filter

Overview API Examples

The LmnFilter is an abstract class that can be extended to create a new custom filter and can be used in a LmnFilterContainerDirective.

LmnFilter

import { LmnFilter } from '@elemental/ui';
Generic types:SelectionType

Properties

NameTypeDescription
filterId
a
Signal<string>

The filter id.

selectedValues
a
Signal<SelectionType | SelectionType[] | undefined>

A reactive property that represent the selected values. @warning You must use this property AFTER the component is initialized by positioning it in the template after the component declaration. If you need to print the selected values before, use the output selectedValuesChange to capture the changes and store the values in a our property.

selectedValuesChange
a
OutputRef<SelectionType | SelectionType[] | undefined>

An output that emits every times the selected values change. The initial value is not emitted.

Methods

abstract

clear()

Clear the selected values.

Presentation
abstract clear(): void;
Returns
void
Overload #1

Clear the selected values.

Presentation
abstract clear(): void;
Returns
void
abstract

selectValues()

Select the given values.

Presentation
abstract selectValues(values: SelectionType | SelectionType[] | undefined): void;
Parameters
NameTypeDescription
values
SelectionType | SelectionType[] | undefined
Returns
void
Overload #1

Select the given values.

Presentation
abstract selectValues(values: SelectionType | SelectionType[] | undefined): void;
Parameters
NameTypeDescription
values
SelectionType | SelectionType[] | undefined
Returns
void