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

Function withAddedFilters

withAddedFilters(filtersToAdd): (filters) => FilterRelations | Filter[]

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

Parameters

ParameterTypeDescription
filtersToAddFilter[]An array of filters to add.

Returns

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

(filters): FilterRelations | Filter[]

Parameters

ParameterType
filtersFilterRelations | Filter[] | undefined

Returns

FilterRelations | Filter[]

Example

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

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