Home > widget-integration > FilterRender > clearFilter
FilterRender.clearFilter() method
Clears one or more filters from the active filter state Removes filters from the filter tree, updates URL, and triggers API call if needed
Signature:
clearFilter(action: {
key: string;
value: string;
type?: string;
displayType?: string;
dependencies?: Array<{
key: string;
value: string;
type?: string;
displayType?: string;
}>;
}, options?: {
emitReset?: boolean;
}): void;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
action |
{ key: string; value: string; type?: string; displayType?: string; dependencies?: Array<{ key: string; value: string; type?: string; displayType?: string; }>; } |
Filter action containing the filter to clear and optional dependencies |
|
options |
{ emitReset?: boolean; } |
(Optional) |
Returns:
void