Support for the selection of non-consecutive cells #4708

budnix · 2018-01-09T07:16:59Z

Description

This issue is about making support for the selection of non-consecutive cells. The first step to complete this new feature is to build a prototype which works visually without any glitches. The selection shouldn't break any previous functionality.

AMBudnik · 2018-01-09T08:01:42Z

related #2119

krzysztofspilka · 2018-01-09T10:32:17Z

Selection of non-consecutive cells/rows/columns

cell selection can work (#4708). To make this feature work necessary changes were introduced to the selection functionality. The logic responsible for selection was moved into separate files (without breaking change). Now, every file has its own responsibility: for keeping selection coordinates and for keeping properties necessary for visualizing the borders.

- Fixed all plugins to be compatible with the non-consecutive selection. Plugin which requires more time to be fixed was temporary disabled when that type selection is detected. - Added support for iterator protocol to array helpers (arrayReduce, arrayFilter, arrayMap, arrayEach). - Added new helpers to checking ctrl meta key codes. - Added new utility (keyStateObserver) designed for retrieving keyboard key states (is pressed or not). - Added missing documentation to the newly created classes.

- Add support to the Walkontable Selection for marking intersection with CSS class names in continuous manner ('area-1', 'area-2'...) - Optimize clearing CSS classes belongs to Selection - Add CSS classes to support multiple selections and normalized their colors - Adjust ContextMenu actions to make them work in multiple selections - Add support for enabling/disabling multiple selection via new property 'selectionMode' (posible values: 'single', 'contiguous', 'multiple') - Remove 'multiSelect' option. Move to "selectionMode: 'single'/'contiguous'" - Fix keyStateObserver which holds key states after window blur - Extend '.alter' method for supporting new arguments which allows removing rows and columns in batches Issue: #4708

Renamed `getSelectedRecently` method to `getSelectedLast` and `getSelectedRecentlyRange` to `getSelectedRangeLast` Issue: #4708

cell selection can work (#4708). To make this feature work necessary changes were introduced to the selection functionality. The logic responsible for selection was moved into separate files (without breaking change). Now, every file has its own responsibility: for keeping selection coordinates and for keeping properties necessary for visualizing the borders.

- Fixed all plugins to be compatible with the non-consecutive selection. Plugin which requires more time to be fixed was temporary disabled when that type selection is detected. - Added support for iterator protocol to array helpers (arrayReduce, arrayFilter, arrayMap, arrayEach). - Added new helpers to checking ctrl meta key codes. - Added new utility (keyStateObserver) designed for retrieving keyboard key states (is pressed or not). - Added missing documentation to the newly created classes.

- Add support to the Walkontable Selection for marking intersection with CSS class names in continuous manner ('area-1', 'area-2'...) - Optimize clearing CSS classes belongs to Selection - Add CSS classes to support multiple selections and normalized their colors - Adjust ContextMenu actions to make them work in multiple selections - Add support for enabling/disabling multiple selection via new property 'selectionMode' (posible values: 'single', 'contiguous', 'multiple') - Remove 'multiSelect' option. Move to "selectionMode: 'single'/'contiguous'" - Fix keyStateObserver which holds key states after window blur - Extend '.alter' method for supporting new arguments which allows removing rows and columns in batches Issue: #4708

Renamed `getSelectedRecently` method to `getSelectedLast` and `getSelectedRecentlyRange` to `getSelectedRangeLast` Issue: #4708

Issue: #4708

- Move 'beforeSetRangeStart' and 'beforeSetRangeStartOnly' hook before coordinates are cleared. This restores the previous behavior of this hook. - Add additionally argument ('ranges') check for ContextMenu 'checkSelectionConsistency' helper. Issue: #4708

Change all `hot.getSelected()` calls to `hot.getSelectedLast()` and `hot.getSelectedRange()` to `hot.getSelectedRangeLast()`. Related-issue: handsontable/handsontable#4708

budnix · 2018-02-13T10:57:48Z

New API

hot.getSelectedLast() Returns an array with coordinates of the last selected layer ([row, col, rowEnd, colEnd]). This method behaves as hot.getSelected() before the braking change.
hot.getSelectedRangeLast() Returns the last coordinates applied to the table as a CellRange object. This method behaves as hot.getSelectedRange() before the braking change.
hot.alter('remove_row', [[1, 4], [10, 1]]) Supports removing non-consecutive rows. Instead of passing row index we can pass an array of arrays where the first item is row index where the row will be removed from and at the second index is 'amount', count of rows to be removed;
hot.alter('remove_col', [[1, 4], [10, 1]]) Same as above but for columns. Only removing actions support that new feature.

Breaking Changes:

hot.getSelected() Returns an array of arrays with coordinates of the all layers ([[row, col, rowEnd, colEnd], [row, col, rowEnd, colEnd] ...]);
hot.getSelectedRange() Returns an array of CellRange objects with coordinates of the all layers ([{CellRange}, {CellRange} ...]);
Previously hot.selection.empty(), now hot.emptySelectedCells();
Changed selection colors:
- area borders, was #89aff9 -> has #4b89ff
- area background, was #b5d1ff -> has #005eff
- current selection border, was #5292f7 -> has #4b89ff
Removed multiSelect setting replaced with selectionMode: 'single';
Added new option selectionMode which can be set as 'single' (previously as multiSelect: false), 'range' (previously as multiSelect: true) and 'multiple' (new non-consecutive mode);

Compatible Changes:

afterSelection
- previously: afterSelection(row, column, rowEnd, columnEnd, preventScrolling)
- now: afterSelection(row, column, rowEnd, columnEnd, preventScrolling, selectionLayerLevel)
afterSelectionByProp
- previously: afterSelectionByProp(row, prop, rowEnd, propEnd, preventScrolling)
- now: afterSelectionByProp(row, prop, rowEnd, propEnd, preventScrolling, selectionLayerLevel)
afterSelectionEnd
- previously: afterSelectionEnd(row, column, rowEnd, columnEnd)
- now: afterSelectionEnd(row, column, rowEnd, columnEnd, selectionLayerLevel)
afterSelectionEndByProp
- previously: afterSelectionEndByProp(row, prop, rowEnd, propEnd)
- now: afterSelectionEndByProp(row, prop, rowEnd, propEnd, selectionLayerLevel)

For all listed hooks the new selectionLayerLevel argument was added. The selectionLayerLevel is a number which indicates what selection layer is currently modified. For the first selection, this value is 0, while the new layers are added this number increases.

After thinking about what necessary values are important to have in selection hooks I came to conclusion to revert arguments structure passed to the hooks. Now, the arguments types are the same as before the breaking change. As a compatible change, this commit adds new argument which is 'selectionLayerLevel' which indicates what selection layer is currently modified. Issue: #4708

- Add unit and e2e tests about changes introduced in previous commits - Fix and update TS types - Remove editor instance from public API (it was added by accident) Issue: #4708

@Util

To make documentation generate properly @Util tag was added to the newly created classes. Issue: #4708

Replace unary increments/decrements to num += 1 and num -= 1 and add missing new lines for better code readability. Issue: #4708

Feature non-consecutive selection To make this feature work necessary changes were introduced to the selection functionality. The logic responsible for selection was moved into separate files (without breaking change). Now, every file has its own responsibility: for keeping selection coordinates and for keeping properties necessary for visualizing the borders. Additionally, added changes: - Fix all plugins to be compatible with the non-consecutive selection. Plugin which requires more time to be fixed was temporary disabled when that type selection is detected. - Add support for iterator protocol to array helpers (arrayReduce, arrayFilter, arrayMap, arrayEach). - Add new helpers to checking ctrl meta key codes. - Add new utility (keyStateObserver) designed for retrieving keyboard key states (is pressed or not). - Add missing documentation to the newly created classes. - Add support to the Walkontable Selection for marking intersection with CSS class names in continuous manner ('area-1', 'area-2'...) - Optimize clearing CSS classes belongs to Selection - Add CSS classes to support multiple selections and normalized their colors - Adjust ContextMenu actions to make them work in multiple selections - Add support for enabling/disabling multiple selections via new property 'selectionMode' (posible values: 'single', 'range', 'multiple') - Remove 'multiSelect' option. Move to "selectionMode: 'single'/'range'" - Extend '.alter' method for supporting new arguments which allows removing rows and columns in batches - Fix ObserveChanges plugin which calls 'afterChange' hook with first an argument as an array where should be composed as an array of array - Add unit and e2e tests - Fix and update TS types Issue: #4708

Feature non-consecutive selection Change all `hot.getSelected()` calls to `hot.getSelectedLast()` and `hot.getSelectedRange()` to `hot.getSelectedRangeLast()`. Related-issue: handsontable/handsontable#4708

budnix added Type: Feature Priority: normal Core: Handsontable Plugin Core: Walkontable Plugin Status: In development Core: Callbacks Plugin labels Jan 9, 2018

budnix self-assigned this Jan 9, 2018

AMBudnik added Priority: normal and removed Priority: normal labels Jan 15, 2018

budnix added the Breaking change label Feb 7, 2018

budnix added a commit that referenced this issue Feb 12, 2018

Rename methods responsible for getting selection coordinates

e299469

Renamed `getSelectedRecently` method to `getSelectedLast` and `getSelectedRecentlyRange` to `getSelectedRangeLast` Issue: #4708

budnix added a commit that referenced this issue Feb 12, 2018

Rename methods responsible for getting selection coordinates

576261d

Renamed `getSelectedRecently` method to `getSelectedLast` and `getSelectedRecentlyRange` to `getSelectedRangeLast` Issue: #4708

budnix added a commit that referenced this issue Feb 13, 2018

Add changes which disappear after git rebase

9306279

Issue: #4708

This was referenced Feb 14, 2018

Non-consecutive selection #4803

Merged

Non-consecutive selection handsontable/handsontable-pro#35

Merged

budnix added a commit that referenced this issue Feb 15, 2018

Add missing docs tag to the classes

6df6ef0

To make documentation generate properly @Util tag was added to the newly created classes. Issue: #4708

budnix added a commit that referenced this issue Feb 15, 2018

Fix code style

6b6b3a2

Replace unary increments/decrements to num += 1 and num -= 1 and add missing new lines for better code readability. Issue: #4708

budnix added this to the Next release milestone Feb 15, 2018

budnix added Status: Merged (ready for release) and removed Status: In development labels Feb 15, 2018

krzysztofspilka added the Tested label Feb 16, 2018

AMBudnik added Status: Released and removed Status: Merged (ready for release) labels Feb 16, 2018

AMBudnik mentioned this issue Feb 16, 2018

Add support (CTRL left-click) Select Multiple Cells #39

Closed

AMBudnik closed this as completed Feb 16, 2018

AMBudnik added Feature Added and removed Type: Feature labels Mar 28, 2018

bigsweater mentioned this issue Oct 9, 2018

[1.16.0+] disableVisualSelection doesn't work via cells method #5082

Closed

wszymanski mentioned this issue Jan 19, 2021

Fixed a bug where there was no possibility to use disableVisualSelection for particular cell/column #7472

Merged

6 tasks

AMBudnik mentioned this issue May 5, 2021

Multirow (Discrete Rows) Select Option #2119

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for the selection of non-consecutive cells #4708

Support for the selection of non-consecutive cells #4708

budnix commented Jan 9, 2018

AMBudnik commented Jan 9, 2018

krzysztofspilka commented Jan 9, 2018

budnix commented Feb 13, 2018 •

edited

Support for the selection of non-consecutive cells #4708

Support for the selection of non-consecutive cells #4708

Comments

budnix commented Jan 9, 2018

Description

AMBudnik commented Jan 9, 2018

krzysztofspilka commented Jan 9, 2018

budnix commented Feb 13, 2018 • edited

New API

Breaking Changes:

Compatible Changes:

budnix commented Feb 13, 2018 •

edited