/ TreeGrid / SearchSettingsModel
Search results

SearchSettingsModel API in JavaScript TreeGrid API control

Interface for a class SearchSettings

Properties

fields

string[]

Specifies the columns to be searched upon the initial rendering of the TreeGrid. You can also retrieve the list of columns that are currently searched.

hierarchyMode

FilterHierarchyMode

Defines the search hierarchy modes dictating which parts of the tree should be included in search results. The available options are:

  • Parent: Shows the searched record along with its parent record.
  • Child: Shows the searched record along with its child record.
  • Both: Shows the searched record with both its parent and child records.
  • None: Shows only the searched record.

ignoreCase

boolean

When set to true, the search operation ignores case sensitivity, including diacritic characters or accents while filtering.

Check the Diacritics filtering.

key

string

A keyword used for searching within the TreeGrid content.

operator

string

Defines the operator to search records. The available operators are:

Operator
Description
startswith
Checks whether the string begins with the specified string.
endswith
Checks whether the string ends with the specified string.
contains
Checks whether the string contains the specified string.
equal
Checks whether the string is equal to the specified string.
notequal
Checks for strings not equal to the specified string.