Version

Property Reference (igGrid)

igGrid Column Moving Properties

The following table explains some of the properties of the igGrid Column Moving feature and lists the default and recommended values. The properties are sorted alphabetically.

Property Type Description Default Value
addMovingDropdown bool When false, hides the column moving menu for all columns. true
columnSettings array If column moving is enabled, configures individual columns for which moving will be disabled. The columns are specified through the columnSettings.allowMoving and columnSettings.columnIndex /columnSettings.columnKey properties. null
columnSettings.allowMoving bool When false, disables column moving for a particular column in the grid. The configured column is specified by either columnSettings.columnIndex or columnSettings.columnKey . true
columnSettings.columnIndex number The index of the column that is being configured. Use the column index to specify the column when the grid columns do not have column keys defined (e.g. when autoGenerateColumns is set to true). null
columnSettings.columnKey string The column key of the column that is being configured. Use the column key to configure the column when the grid columns have column keys defined (e.g. when the grid columns are defined manually). null
mode string Sets the Column Moving mode. The valid values are:
  • “immediate” – sets Column Moving to Immediate mode
(As the user draggs the header, it is moved and the columns swap animatedly.)
  • “deferred” – sets Column Moving to Deferred mode
(Dragging does not move the column header but, instead, arrowheads appear to mark the position where the column would be dropped if the user releases the mouse button.) 		“immediate”
moveType string Sets the Column Moving type. The valid values are:
  • “dom” – sets the type to DOM Manipulation
(The column will be moved by detaching the column DOM and then re-attaching it back in the DOM tree.)
  • “render” – sets the type to Grid Re-rendering
(The grid will be re-rendered with the new column order.) 		“dom”
movingDialogAnimationDuration number Sets the timeDuration in milliseconds to of the animation showing or hiding the Move Columns dialog. 200
movingDialogHeight number Sets the height of the Move Columns dialog. By default, the height is not set, so that the dialog height stretches to show all the grid columns. N/A
movingDialogWidth number Sets the width of the Move Columns dialog. 400

Related Content

Topics

The following topics provide additional information related to this topic.

  • Column Moving Overview: This topic explains conceptually the Column Moving feature of the igGrid and the functionalities this feature provides.

  • Enabling Column Moving: This topic explains, with code examples, how to enable the Column Moving feature of the igGrid.

  • Configuring Column Moving: This topic explains, with code examples, how to configure the Column Moving feature of the igGrid.

  • Moving Columns Programmatically: This topic explains, with code examples, how to move columns using the column moving API.

View on GitHub