Class FilterService

Service for working with filter.

Constructors

constructor

new FilterService(sisenseContextService): FilterService

Parameters

Parameter	Type
sisenseContextService	SisenseContextService

Returns

FilterService

Methods

getFilterMembers

getFilterMembers(params): Promise< GetFilterMembersData >

Retrieves members of the provided filter.

Those members can be used to display a list of members in a third-party filter component such as Material UI Select.

Example

Retrieve selected members from a Filter on Country of the Sample ECommerce data model.

try {
  const data = await filterService.getFilterMembers({
    filter: filterFactory.members(DM.Country.Country, ['United States', 'Canada'])
  });

  const { selectedMembers, allMembers, excludeMembers, enableMultiSelection } = data;
  console.log('selectedMembers', selectedMembers);
} catch (error) {
  console.error('Error:', error);
}

Parameters

Parameter	Type	Description
params	GetFilterMembersParams	Parameters for retrieving filter members

Returns

Promise< GetFilterMembersData >

Promise that resolves to the filter members data