sisense.com
✅ You are viewing documentation for the latest version of Compose SDK.
Version:

Function withReplacedFilter

withReplacedFilter(filterToReplace, newFilter): (filters) => FilterRelations | Filter[]

Returns a function that replaces a filter with a new filter in existing filters or filter relations.

Parameters

ParameterTypeDescription
filterToReplaceFilterThe filter to replace.
newFilterFilterThe new filter to use as a replacement.

Returns

A function that takes existing filters or filter relations and returns updated filters or filter relations with the filter replaced.

(filters): FilterRelations | Filter[]

Parameters

ParameterType
filtersFilterRelations | Filter[] | undefined

Returns

FilterRelations | Filter[]

Example

// Using with an array of filters
const originalFilters = [filterByAgeRange, filterByRevenue];
const updatedFilters = withReplacedFilter(filterByRevenue, filterByCost)(originalFilters);
// [filterByAgeRange, filterByCost]

// Using with filter relations
const originalFilterRelations = filterFactory.logic.or(filterByAgeRange, filterByRevenue);
const updatedFilterRelations = withReplacedFilter(filterByRevenue, filterByCost)(originalFilterRelations);
// (filterByAgeRange OR filterByCost)
Last Updated: