Class FiltersPanel
Filters panel component that renders a list of filter tiles
Example
Here's how to render a filters panel with a set of filters.
<script setup lang="ts">
import { ref } from 'vue';
import { FiltersPanel } from '@sisense/sdk-ui-vue';
import { filterFactory, type Filter, type FilterRelations } from '@sisense/sdk-data';
import * as DM from '../assets/sample-ecommerce-model.js';
const filters = ref<Filter[]>([
filterFactory.members(DM.Commerce.Gender, ['Male', 'Female']),
filterFactory.members(DM.Commerce.AgeRange, ['0-18', '19-24']),
]);
const handleFiltersChange = (updatedFilters: Filter[] | FilterRelations) => {
filters.value = updatedFilters as Filter[];
console.log('Filters changed:', updatedFilters);
};
</script>
<template>
<FiltersPanel
:filters="filters"
:defaultDataSource="DM.DataSource"
:onFiltersChange="handleFiltersChange"
/>
</template>
Param
FiltersPanel props
Properties
config
readonlyconfig?:FiltersPanelConfig
The configuration for the filters panel
defaultDataSource
readonlydefaultDataSource?:DataSource
Default data source used for filter tiles
filters
readonlyfilters:FilterRelations|Filter[]
Array of filters to display
onFiltersChange
readonlyonFiltersChange: (filters) =>void
Callback to handle changes in filters
Parameters
| Parameter | Type |
|---|---|
filters | FilterRelations | Filter[] |
Returns
void