ColumnPicker
Feature

Displays a column picker (to show/hide columns) in the header context menu. Columns can be displayed in sub menus by region or tag. Grouped headers are displayed as menu hierarchies.

This feature is enabled by default.

Configs

Configs are options you supply in a configuration object when creating an instance of this class

createColumnsFromModel : Booleanfalse

Configure this as true to have the fields from the Grid's Store's modelClass added to the menu to create new columns to display the fields.

This may be combined with the stateful ability of the grid to create a self-configuring grid.
groupByRegion : Booleanfalse

Groups columns in the picker by region (each region gets its own sub menu)
groupByTag : Booleanfalse

Groups columns in the picker by tag, each column may be shown under multiple tags. See tags

Properties

Properties are getters/setters or publicly accessible variables on this class

isColumnPicker : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of ColumnPicker class, or subclass thereof.

isColumnPicker : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of ColumnPicker class, or subclass thereof.

Functions

Functions are methods available for calling on the class

buildColumnMenu( )

private

Traverses columns to build menu items for the column picker.
getColumnDragToolbarItems( )

private

Supply items to ColumnDragToolbar
getColumnPickerItems( columnStore )
: MenuItemEntry[]

private

Get menu items, either a straight list of columns or sub menus per subgrid
getColumnsForTag( tag )
: Column[]

private

Get all columns that has the specified tag.
onColumnToggle( event )
: Promise

private

ASYNC

Handler for column hide/show menu checkitems.
populateHeaderMenu( options )

internal

Populates the header context menu items.
refreshTagMenu( )

private

Refreshes checked status for a tag menu. Needed since columns can appear under multiple tags.

id: columnPicker

Source path

Grid/feature/ColumnPicker.js

Demo

examples/columns

ColumnPicker
Feature

See also

Configs

Properties

Functions

Source path

Demo

Inheritance tree3

Mixins2

Contents

ColumnPicker Feature

See also

Configs

Properties

Functions

Source path

Demo

Inheritance tree3

Mixins2

Contents

ColumnPicker
Feature