Filter

You can use Filters to show/hide or edit particular nodes view dynamically, filtered by criteria. Filtering data in FamilyTree JS is easy to do. You can filter by one or more criteria.

Add Filtering

To add the filter funtionality you need to add filterBy option in the chart configuration.
Then you should add template or CSS for the filtered nodes.

The value of filterBy can be:
- an array of node properties
- 'all'
- object that contains filtering properties and initial state values

You can also change the text values in the filter

 
       Copy 
    //filterBy: ['gender', 'city'],
    //filterBy: 'all',
    filterBy: {
        gender: {},
        city: {
            Moscow: { checked: false, text: 'Moscow is hidden' },
            London: { checked: true, text: 'London is not hidden' }
        }
    },

     

Hiding the filtered nodes

To hide the filtered nodes, you need to add filter in the tag configuration and set 'dot' for a template.

 
       Copy 
    tags: {
        filter: {
            template: 'dot'
        }
    }
     

Edit in BALKAN Code

Change the template of the filtered nodes

To change the template of the filtered nodes, you need to add filter in the tag configuration and set the desired template for it.

 
       Copy 
    tags: {
        filter: {
            template: 'filtered'
        }
    }
     

Edit in BALKAN Code

Filtering with CSS

You can use CSS to change the filtered nodes:

 
       Copy 
.filter rect, .filter image, .filter text, .filter use {
    filter: blur(10px);
}
     

Edit in BALKAN Code

UI Customization

You can use these event listeners to change the filters UI: add-filter, add-item and show-items.

Localization

You can change the texts "Filter by" and "all":

 
       Copy 
FamilyTree.filterUI.textFilterBy = 'Filtre par';
FamilyTree.filterUI.all = '[Toute]'