React Grid Cell Selection

    The Ignite UI for React Cell Selection in React Grid enables rich data select capabilities and offers powerful API in the IgrGrid component. The React Grid supports three selection modes:

    • Seleção de múltiplas células em grade
    • Seleção única de grade
    • Seleção de grade nenhuma

    Vamos nos aprofundar em cada uma dessas opções.

    React Grid Cell Selection Example

    The sample below demonstrates the three types of IgrGrid'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

    Grid Multiple-Cell Selection

    Como selecionar células:

    • Ao arrastar o mouse- A seleção retangular de dados das células seria realizada.
    • Ao pressionar a tecla Ctrl + arrastar do mouse- Seleções de múltiplos intervalos seriam realizadas. Qualquer outra seleção de célula existente será persistida.
    • Seleção instantânea de várias células usando a tecla Shift. Selecione uma única célula e selecione outra célula segurando a tecla Shift. O intervalo de células entre as duas células será selecionado. Tenha em mente que se outra segunda célula for selecionada enquanto segura a tecla Shift, o intervalo de seleção de células será atualizado com base na primeira posição da célula selecionada (ponto inicial).
    • Seleção de células múltiplas do teclado usando as teclas de seta enquanto segura a tecla Shift. O intervalo de seleção de células múltiplas será criado com base na célula focada.
    • Seleção de células múltiplas do teclado usando as teclas Ctrl + ↑ ↓ ← → e Ctrl + Home / End enquanto segura a tecla Shift. O intervalo de seleção de células múltiplas será criado com base na célula em foco.
    • Clicar com a tecla esquerda do mouse enquanto segura a tecla Ctrl adicionará intervalos de células individuais à coleção de células selecionadas.
    • A seleção contínua de múltiplas células está disponível clicando com o mouse e arrastando.

    Demo

    Seleção única de grade

    When you set the cellSelection to 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.

    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.

    Seleção de grade nenhuma

    If you want to disable cell selection you can just set cellSelection to none. 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.

    Keyboard Navigation Interactions

    While Shift Key is Pressed

    • Shift + ↑ para adicionar a célula acima à seleção atual.
    • Shift + ↓ para adicionar a célula abaixo à seleção atual.
    • Shift + ← para adicionar a célula esquerda à seleção atual.
    • Shift + → para adicionar a célula direita à seleção atual.

    While Ctrl + Shift Keys are Pressed

    • Ctrl + Shift + ↑ para selecionar todas as células acima da célula em foco na coluna.
    • Ctrl + Shift + ↓ para selecionar todas as células abaixo da célula em foco na coluna.
    • Ctrl + Shift + ← para selecionar todas as células até o início da linha.
    • Ctrl + Shift + → para selecionar todas as células até o final da linha.
    • Ctrl + Shift + Home para selecionar todas as células, desde a célula em foco até a primeira célula na grade
    • Ctrl + Shift + End para selecionar todas as células, desde a célula em foco até a última célula da grade

    [!Note] Continuous scroll is possible only within Grid's body.

    Api Usage

    Abaixo estão os métodos que você pode usar para selecionar intervalos, limpar a seleção ou obter dados de células selecionadas.

    Select range

    selectRange - Select a range of cells with the API. rowStart and rowEnd should use row indexes and columnStart and columnEnd could use column index or column data field value.

    const range = { rowStart: 2, rowEnd: 2, columnStart: 1, columnEnd: 1 };
gridRef.current.selectRange(range);

    Clear cell selection

    clearCellSelection will clear the current cell selection.

    gridRef.current.clearCellSelection();

    Get Selected Data

    getSelectedData will return array of the selected data in format depending on the selection. Examples below:

    • Se três células individuais diferentes forem selecionadas:
    expectedData = [
    { CompanyName: 'Infragistics' },
    { Name: 'Michael Langdon' },
    { ParentID: 147 }
];
    • Se três células de uma coluna forem selecionadas:
    expectedData = [
    { Address: 'Obere Str. 57'},
    { Address: 'Avda. de la Constitución 2222'},
    { Address: 'Mataderos 2312'}
];
    • Se três células forem selecionadas com o arrastar do mouse de uma linha e três colunas:
    expectedData = [
    { Address: 'Avda. de la Constitución 2222', City: 'México D.F.', ContactTitle: 'Owner' }
];
    • Se três células forem selecionadas com o mouse arrastando de duas linhas e três colunas:
    expectedData = [
    { ContactTitle: 'Sales Agent', Address: 'Cerrito 333', City: 'Buenos Aires'},
    { ContactTitle: 'Marketing Manager', Address: 'Sierras de Granada 9993', City: 'México D.F.'}
];
    • Se dois intervalos diferentes forem selecionados:
    expectedData = [
    { ContactName: 'Martín Sommer', ContactTitle: 'Owner'},
    { ContactName: 'Laurence Lebihan', ContactTitle: 'Owner'},
    { Address: '23 Tsawassen Blvd.', City: 'Tsawassen'},
    { Address: 'Fauntleroy Circus', City: 'London'}
];
    • Se dois intervalos sobrepostos forem selecionados, o formato será:
    expectedData = [
    { ContactName: 'Diego Roel', ContactTitle: 'Accounting Manager', Address: 'C/ Moralzarzal, 86'},
    { ContactName: 'Martine Rancé', ContactTitle: 'Assistant Sales Agent', Address: '184, chaussée de Tournai', City: 'Lille'},
    { ContactName: 'Maria Larsson', ContactTitle: 'Owner', Address: 'Åkergatan 24', City: 'Bräcke'},
    { ContactTitle: 'Marketing Manager', Address: 'Berliner Platz 43', City: 'München'}
];

    Features Integration

    A seleção de múltiplas células é baseada em índice (seleção de elementos DOM).

    • Sorting- Quando a classificação é realizada, a seleção não será apagada. Ela deixará as células selecionadas atualmente as mesmas ao classificar em ordem crescente ou decrescente.
    • Paging- Na paginação, as células selecionadas serão limpas. A seleção não será persistida entre as páginas.
    • Filtering- Quando a filtragem é realizada, a seleção não será apagada. Se a filtragem for apagada, ela retornará - as células selecionadas inicialmente.
    • Resizing- Ao redimensionar uma coluna, as células selecionadas não serão apagadas.
    • Hiding- Não limpará as células selecionadas. Se a coluna estiver oculta, as células da próxima coluna visível serão selecionadas.
    • pinning - Selected cell will not be cleared. Same as hiding
    • groupBy - On column grouping selected cells will not be cleared.

    Styling

    Além dos temas predefinidos, a grade pode ser ainda mais personalizada ao definir algumas das propriedades CSS disponíveis. Caso você queira alterar algumas das cores, precisa definir uma classe para a grade primeiro:

    <IgrGrid className="grid"></IgrGrid>

    Em seguida, defina as propriedades CSS relacionadas para essa classe:

    .grid {
    --ig-grid-cell-selected-text-color: #FFFFFF;
    --ig-grid-cell-active-border-color: #f2c43c;
    --ig-grid-cell-selected-background: #0062A3;
}

    Demo

    API References

    Additional Resources

    Nossa comunidade é ativa e sempre acolhedora para novas ideias.