Search

Localization

We have localization for the FamilyTree JS Search option. You just have to set the SEARCH_PLACEHOLDER constant with the required value:

 
     
// set before family declaration
FamilyTree.SEARCH_PLACEHOLDER = "Chercher"; // the default value is "Search"

Enable or Disable Search

You can disable the FamilyTree JS Search option, setting the enableSearch option to false. It is enabled(true) by default.

 
         
    enableSearch: false

Search in particular fields

You can Search in the fields defined in searchFields. By default the fuction search in all the fields. 

 
         
    searchFields: ["name", "birthDate", etc...],

Search by weight of the fields

You can say what will be the weight of every field, using the searchFieldsWeight option. The hiegher value has higher priority in searching.

For example searching for Irinain the following example...

If you have these options: 
 
     
    searchFieldsWeight: {
        "name": 100, //percent
        "friends": 20 //percent
    }
you will get this result:
Search by weight Click here to see the example

If you have these options: 
 
     
    searchFieldsWeight: {
        "name": 20, //percent
        "friends": 100 //percent
    }
you will get this result:
Search by weight Click here to see the example

Highlight nodes on search enter

You can cange the match and no match nodes on search enter using .match or .no-match classes.
Press enter to see the result.

Click here to see the example with CSS

Click here to see the example with templates

Search fields abbreviation

You can search by field abbreviation. The abbreviations by default are the first letters form the data fields.
To search by abbreviation just type "n Ashley" for example.

Search field abbreviation Click here to see the example

You can also set your own search field abbreviations using the searchFiledsAbbreviation property:

 
         
    searchFiledsAbbreviation: {        
        tel: 'phone',
        n: 'name'
    },

Search field abbreviation Click here to see the example

Help

You can type ? for help. In help you see the search field abbreviations that you can use to search in particular fields.

Search field abbreviation Click here to see the example

You can change this help symbol setting SEARCH_HELP_SYMBOL constant. It could also be a word.
Leave it empty for searsch help to open on click or focus.

 
         
FamilyTree.SEARCH_HELP_SYMBOL = "help";

Display a field in the search result

You can use searchDisplayField to set a field that you'd like to display in the search result. 

 
         
    searchDisplayField: "title",

Search using a function

You can use the search function to search in the tree.

family.search(value, searchInFileds, retrieveFields); 

 
         
    family.search("c", ["Name"], ["Name"]);

Search UI Customization

You can use show-items and add-item event listeners to customize the UI.

In this article