@empathyco/x-components
Version:
Empathy X Components
28 lines (17 loc) • 1.01 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [FacetsService](./x-components.facetsservice.md) > [clearFiltersWithMetadata](./x-components.facetsservice.clearfilterswithmetadata.md)
## FacetsService.clearFiltersWithMetadata() method
Deselects the selected filters. This is intended to be used from the wiring where currently we can only provide one argument.
**Signature:**
```typescript
clearFiltersWithMetadata(payload?: {
facetIds?: Array<Facet['id']>;
metadata?: FiltersMetadata;
}): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| payload | { facetIds?: Array<Facet\['id'\]>; metadata?: [FiltersMetadata](./x-components.filtersmetadata.md)<!-- -->; } | _(Optional)_ The event payload that can contain the list of facets ids from whom deselect the filters and the event metadata. |
**Returns:**
void