API Docs for: 0.0.2
Show:

grid.ColumnManager Class

Extends Core
Defined in: api/src/grid/column-manager.js:1
Module: effect

Column manager for grids. Grids will listen to events fired by this component. A column manager is usually created by sending a "columnManager" config object to the constructor of a grid.Grid view.

Constructor

grid.ColumnManager

(
  • config
)

Defined in api/src/grid/column-manager.js:1

Parameters:

Example:

columnManager:{ columns:{ 'country':{ heading:'Country', removable:false, sortable:true, movable:true, width:200, renderer:function (val) { return '' + val + ''; } }, 'capital':{ heading:'Capital', sortable:true, removable:true, movable:true, width:150 }, population:{ heading:'Population', movable:true, removable:true } } } Is example of a ColumnManager config object sent to a grid. It defines three columns, "country", "capital" and "population". These names corresponds to keys in the data sets. How to configure columns is specified in grid.Column

Methods

getColumnsInRow

(
  • rowNumber
)
Array

Defined in api/src/grid/column-manager.js:597

Return array of column keys for a header row, 0 is first row

Parameters:

Returns:

Array: columns

getGroupFor

(
  • column
)
grid.Column | Undefined

Defined in api/src/grid/column-manager.js:239

Returns parent group object for a column

Parameters:

Returns:

grid.Column | Undefined: parent

getGroupIdOf

(
  • column
)
String

Defined in api/src/grid/column-manager.js:229

Returns id of parent group

Parameters:

Returns:

String: group id

getVisibleColumns

() Object

Defined in api/src/grid/column-manager.js:141

Returns object of visible columns, example:

Returns:

Object: visible columns

Example:

    {
        country : {
            heading : 'Country'
        },
        population: {
            heading : 'Population'
        }
    }

insertColumnAfter

(
  • column
  • after
)

Defined in api/src/grid/column-manager.js:405

Insert a column after given column

Parameters:

insertColumnBefore

(
  • column
  • before
)

Defined in api/src/grid/column-manager.js:396

Insert a column before given column

Parameters:

insertIntoSameGroupAs

(
  • column
  • as
)
private

Defined in api/src/grid/column-manager.js:472

Parameters:

isInAGroup

(
  • column
)
Boolean

Defined in api/src/grid/column-manager.js:219

Returns true if column with given id is in a group.

Parameters:

Returns:

Boolean: is in a group

isResizable

(
  • column
)
Boolean

Defined in api/src/grid/column-manager.js:286

Returns true if column with given id is resizable

Parameters:

Returns:

Boolean:

removeFromGroup

(
  • column
)
Boolean

Defined in api/src/grid/column-manager.js:496

Remove column from a group

Parameters:

Returns:

Boolean: success

Properties

columnLookup

Object private

Defined in api\src\grid\column-manager.js:62

Internal column lookup. Flat version of this.columns

Attributes

columns

Object

Defined in api\src\grid\column-manager.js:51

Configuration of columns

Default: {}

fill

Boolean

Defined in api\src\grid\column-manager.js:42

Always fill view, i.e. dynamically increase with of last visible column when total width of visible columns is less than width of the Grid.

Default: true

Events

hidecolumn

Defined in api\src\grid\column-manager.js:516

Fired when a column is hidden

movecolumn

Defined in api\src\grid\column-manager.js:453

Fired when a column has been moved

showcolumn

Defined in api\src\grid\column-manager.js:540

Fired when a column is shown