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

Function withAddedFilter

withAddedFilter(filter): (filters) => FilterRelations | Filter[]

Returns a function that adds a filter to existing filters or filter relations.

Parameters

ParameterTypeDescription
filterFilterThe filter to add.

Returns

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

(filters): FilterRelations | Filter[]

Parameters

ParameterType
filtersFilterRelations | Filter[] | undefined

Returns

FilterRelations | Filter[]

Example

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

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