Class: ManualColumnFreeze

ManualColumnFreeze

This plugin allows to manually "freeze" and "unfreeze" a column using an entry in the Context Menu.
You can turn it on by setting a manualColumnFreeze property to true.

handsontable/src/plugins/manualColumnFreeze/manualColumnFreeze.js, line 12

Methods

handsontable/src/plugins/manualColumnFreeze/manualColumnFreeze.js, line 159

addFixedColumn()

Increments the fixed columns count by one.

handsontable/src/plugins/manualColumnFreeze/manualColumnFreeze.js, line 234

changeColumnPositions(sourceColumn, destinationColumn)

Move the sourceColumn after the destinationColumn.

Parameters:
Name Type Description
sourceColumn Number

Index of the source column.

destinationColumn Number

Index of the destination column.

handsontable/src/plugins/manualColumnFreeze/manualColumnFreeze.js, line 33

enablePlugin()

Enable plugin for this Handsontable instance.

handsontable/src/plugins/manualColumnFreeze/manualColumnFreeze.js, line 122

freezeColumn(column)

Freeze the given column (add it to fixed columns).

Parameters:
Name Type Description
column Number

Column index.

handsontable/src/plugins/manualColumnFreeze/manualColumnFreeze.js, line 183

getBestColumnReturnPosition(column)

Estimates the most fitting return position for unfrozen column.

Parameters:
Name Type Description
column Number

Column index.

handsontable/src/plugins/manualColumnFreeze/manualColumnFreeze.js, line 224

getLogicalColumnIndex(column)

Get the logical column index by the provided visible column.

Parameters:
Name Type Description
column Number

Visible column index.

handsontable/src/plugins/manualColumnFreeze/manualColumnFreeze.js, line 56

getManualColumnMovePlugin(){Object}

Get the reference to the ManualColumnMove plugin.

Returns: {Object}
handsontable/src/plugins/manualColumnFreeze/manualColumnFreeze.js, line 215

getVisibleColumnIndex(column)

Get the visible column index by the provided logical column.

Parameters:
Name Type Description
column Number

Logical column index.

handsontable/src/plugins/manualColumnFreeze/manualColumnFreeze.js, line 45

init()

Init settings.

handsontable/src/plugins/manualColumnFreeze/manualColumnFreeze.js, line 26

isEnabled(){Boolean}

Check if the plugin is enabled in the Handsontable settings.

Returns: {Boolean}
handsontable/src/plugins/manualColumnFreeze/manualColumnFreeze.js, line 170

removeFixedColumn()

Decrements the fixed columns count by one

handsontable/src/plugins/manualColumnFreeze/manualColumnFreeze.js, line 143

unfreezeColumn(column)

Unfreeze the given column (remove it from fixed columns and bring to it's previous position).

Parameters:
Name Type Description
column Number

Column index.