searchPanel

Configures the search panel.

Type: Object

The search panel allows searching for values in several columns at once. The widget searches against only those columns whose allowSearch option is set to true.

DevExtreme HTML5 JavaScript jQuery Angular Knockout Widget DataGrid SearchPanel

To make the search panel visible, set the searchPanel | visible option to true.

View Demo

See Also
Show Example:
AngularJS
Knockout
jQuery

In this example, the search panel is made visible using the visible option of the searchPanel object. Additionally, its width is changed using the width option of the same object.


                                    

                                    

In this example, the search panel is made visible using the visible option of the searchPanel object. Additionally, its width is changed using the width option of the same object.


                                    

                                    

In this example, the search panel is made visible using the visible option of the searchPanel object. Additionally, its width is changed using the width option of the same object.


                                    

                                    

highlightCaseSensitive

Notifies the widget whether search is case-sensitive to ensure proper highlightning of search results. Applies only if highlightSearchText is true.

Type: Boolean
Default Value: false

highlightSearchText

Specifies whether found substrings should be highlighted.

Type: Boolean
Default Value: true

Show Example:
AngularJS
Knockout
jQuery

In this example, you can change the value of the searchPanel | highlightSearchText option using the check box under the grid. Type something in the search panel and see the changes.


                                    

                                    

In this example, you can change the value of the searchPanel | highlightSearchText option using the check box under the grid. Type something in the search panel and see the changes.


                                    

                                    

In this example, you can change the value of the searchPanel | highlightSearchText option using the check box under the grid. Type something in the search panel and see the changes.


                                    

                                    

placeholder

Specifies a placeholder for the search panel.

Type: String
Default Value: 'Search...'

Show Example:
AngularJS
Knockout
jQuery

In this example, the text displayed by an empty search panel is changed using the searchPanel | placeholder option.


                                    

                                    

In this example, the text displayed by an empty search panel is changed using the searchPanel | placeholder option.


                                    

                                    

In this example, the text displayed by an empty search panel is changed using the searchPanel | placeholder option.


                                    

                                    

searchVisibleColumnsOnly

Specifies whether the widget should search against all columns or only visible ones.

Type: Boolean
Default Value: false

By default, the widget searches against all columns configured in the columns array. Some of them may be invisible, and finding a result in them may confuse a user. To avoid this, set the searchVisibleColumnsOnly option to true.

text

Sets a search string for the search panel.

Type: String
Default Value: ''

Show Example:
AngularJS
Knockout
jQuery

In this example, the search string is specified initially using the searchPanel | text option.


                                    

                                    

In this example, the search string is specified initially using the searchPanel | text option.


                                    

                                    

In this example, the search string is specified initially using the searchPanel | text option.


                                    

                                    

visible

Specifies whether the search panel is visible or not.

Type: Boolean
Default Value: false

Show Example:
AngularJS
Knockout
jQuery

In this example, you can change the visibility of the search panel at runtime using the check box located below the grid.


                                    

                                    

In this example, you can change the visibility of the search panel at runtime using the check box located below the grid.


                                    

                                    

In this example, you can change the visibility of the search panel at runtime using the check box located below the grid.


                                    

                                    

width

Specifies the width of the search panel in pixels.

Type: Number
Default Value: 160

Show Example:
AngularJS
Knockout
jQuery

In this example, the width of the search panel is changed using the searchPanel | width option.


                                    

                                    

In this example, the width of the search panel is changed using the searchPanel | width option.


                                    

                                    

In this example, the width of the search panel is changed using the searchPanel | width option.