Angular Cell Selection
The selection feature enables rich data select capabilities in the Material UI based Hierarchical Grid. Variety of events and single select actions are available thanks to the powerful API and easy to use methods. The Hierarchical Grid now supports three modes for cell selection, and you can easily switch between them by changing cellSelection
property. You can disable cell selection, you can select only one cell within the grid or to select multiple cells in the grid, which is provided as default option.
In the Hierarchical Grid you can specify the cell selection mode on grid level. So for example in the parent grid multi-cell selection can be enabled, but in child grids cell selection mode can be single or disabled. But let's dive deeper in each of these options.
Angular Cell Selection Example
The sample below demonstrates the three types of Hierarchical Grid's cell selection behavior. Use the buttons below to enable each of the available selection modes. A brief description will be provided on each button interaction through a snackbar message box.
Selection types
Hierarchical Grid Multiple-cell Selection
This is the default cell selection mode in both parent and child grids. Please keep in mind that you can make cell selection one grid at a time, you can not make cross grid range selection or to have a selected cells in multiple grids. Each key combination related to range selection and mouse drag functionality can be used only in the same grid.
How to select cells:
- By
Mouse drag
- Rectangular data selection of cells would be performed. - By
Ctrl key
press +Mouse drag
- Multiple range selections would be performed. Any other existing cell selection will be persisted. - Instant multi-cell selection by using Shift key. Select single cell and select another single cell by holding the Shift key. Cell range between the two cells will be selected. Keep in mind that if another second cell is selected while holding
Shift key
the cell selection range will be updated based on the first selected cell position (starting point). - Keyboard multi-cell selection by using the
Arrow keys
while holdingShift key
. Multi-cell selection range will be created based on the focused cell. - Keyboard multi-cell selection by using the
Ctrl + Arrow keys
andCtrl + Home/End
while holdingShift key
. Multi-cell selection range will be created based on the focused cell. - Clicking with the
Left Mouse key
while holdingCtrl key
will add single cell ranges into the selected cells collection. - Continuous multiple cell selection is available, by clicking with the mouse and dragging.
Hierarchical Grid Single Selection
When you set the [cellSelection]="'single'"
, this allows you to have only one selected cell in the grid at a time. Also the mode mouse drag
will not work and instead of selecting a cell, this will make default text selection.
Note
When single cell is selected selected
event is emitted, no matter if the selection mode
is single
or multiple
. In multi-cell selection mode when you select a range of cells rangeSelected
event is emitted.
Hierarchical Grid None selection
If you want to disable cell selection you can just set [cellSelection]="'none'"
property. In this mode when you click over the cell or try to navigate with keyboard, the cell is not selected, only the activation style
is applied and it is going to be lost when you scroll or click over other element on the page. The only way for you to define selection is by using the API methods that are described below.
Styling Guidelines
The theme engine exposes properties that allows us to style the range of selected cells
.
Import theme
To get started with styling the selection, we need to import the index
file, where all the theme functions and component mixins live:
@use "igniteui-angular/theming" as *;
// IMPORTANT: Prior to Ignite UI for Angular version 13 use:
// @import '~igniteui-angular/lib/core/styles/themes/index';
Define colors
Once done, we can make use of the igx-contrast-color
and igx-color
functions. With them, we define the colors we would like to use for our selection range:
$text-color:contrast-color($default-palette, 'primary', 900);
$background-color: color($default-palette, "primary", 900);
$border-yellow: #f2c43c;
Create custom theme
Next we create a new theme that extends the grid-theme
passing our text-color
, background-color
and border-yellow
variables as $cell-selected-text-color
, $cell-selected-background
and $cell-active-border-color
, respectively:
$custom-grid-theme: grid-theme(
$cell-selected-text-color: $text-color,
$cell-active-border-color: $border-yellow,
$cell-selected-background: $background-color
);
Apply theme
Afterwards, all we need to do is include the mixin in our component's style (could also be in the app styles), so that our igx-hierarchical-grid uses the newly created theme instead of the default one:
@include grid($custom-grid-theme);
Note
If the component is using an Emulated ViewEncapsulation
, it is necessary to penetrate this encapsulation using ::ng-deep
.
We scope the style under :host
selector so as not to affect any other grids we might have in our application.
:host {
::ng-deep {
@include grid($custom-grid-theme);
}
}
With the custom theme applied, the selected grid cells are highlighted with our selected colors:
Demo
Note
The sample will not be affected by the selected global theme from Change Theme
.
API References
Additional Resources
- Hierarchical Grid overview
- Selection
- Row selection
- Filtering
- Sorting
- Summaries
- Column Moving
- Column Pinning
- Column Resizing
- Virtualization and Performance