React TreeList - columnChooser

Configures the column chooser.

Type:

Object

The column chooser allows a user to hide columns at runtime. To enable it, assign true to the columnChooser.enabled option.

DevExtreme HTML5 JavaScript jQuery Angular Knockout TreeList Column Chooser

See Also

allowSearch

Specifies whether searching is enabled in the column chooser.

Type:

Boolean

Default Value: false

emptyPanelText

Specifies text displayed by the column chooser when it is empty.

Type:

String

Default Value: 'Drag a column here to hide it'

enabled

Specifies whether a user can open the column chooser.

Type:

Boolean

Default Value: false

When this option is set to true, a user can open the column chooser with a click on the "Column Chooser" icon. Otherwise, this icon is hidden, but you still can open the column chooser from code by calling the showColumnChooser() method.

height

Specifies the height of the column chooser.

Type:

Number

Default Value: 260

mode

Specifies how a user manages columns using the column chooser.

Type:

String

Default Value: 'dragAndDrop'
Accepted Values: 'dragAndDrop' | 'select'

In drag-and-drop mode, a user moves column headers to and from the column chooser by drag-and-drop. In select mode, the user selects column headers in the column chooser using check boxes. The select mode is designed primarily for touch-enabled devices. On mouse-equipped platforms, either mode is suitable.

When using the widget as an ASP.NET MVC Control, specify this option using the GridColumnChooserMode enum. This enum accepts the following values: DragAndDrop and Select.

searchTimeout

Specifies a delay in milliseconds between when a user finishes typing in the column chooser's search panel, and when the search is executed.

Type:

Number

Default Value: 500

title

Specifies the title of the column chooser.

Type:

String

Default Value: 'Column Chooser'

width

Specifies the width of the column chooser.

Type:

Number

Default Value: 250