Angular Hierarchical Grid Cell Editing

Ignite UI for Angular Hierarchical Grid component provides a great data manipulation capabilities and powerful API for Angular CRUD operations. By default the Hierarchical Grid is using in cell editing and different editors will be shown based on the column data type, thanks to the default cell editing template. In addition, you can define your own custom templates for update-data actions and to override the default behavior for committing and discarding any changes.

Angular Hierarchical Grid cell editing and edit templates Example

Note

Ao usar igxCellEditor com qualquer tipo de componente do editor, o fluxo de navegação do teclado será interrompido. O mesmo se aplica à edição direta da célula personalizada que entra no modo de edição. Isso ocorre porque o focus permanecerá no cell element, não no componente do editor que adicionamos -igxSelect, igxCombo, etc. É por isso que devemos aproveitar a igxFocus diretiva, que moverá o foco diretamente no componente na célula e preservará a fluent editing flow a célula / linha.

Edição de células

Editing through UI

Você pode entrar no modo de edição para uma célula específica, quando uma célula editável estiver em foco de uma das seguintes maneiras:

no clique duplo;
em clique único - Um clique único entrará no modo de edição somente se a célula selecionada anteriormente estava no modo de edição e a célula selecionada atualmente for editável. Se a célula selecionada anteriormente não estava no modo de edição, um clique único selecionará a célula sem entrar no modo de edição;
ao pressionar a tecla Enter;
ao pressionar a tecla F2;

Você pode sair do modo de edição sem confirmar as alterações de uma das seguintes maneiras:

ao pressionar a tecla Escape;
quando você executa operações de classificação, filtragem, pesquisa e ocultação;

Você pode sair do modo de edição e confirmar as alterações de uma das seguintes maneiras:

ao pressionar a tecla Enter;
ao pressionar a tecla F2;
ao pressionar a tecla Tab;
on single click to another cell - when you click on another cell in the Hierarchical Grid, your changes will be submitted.
Operações como paginação, redimensionamento, fixar ou mover sairão do modo de edição e as alterações serão enviadas.

Note

The cell remains in edit mode when you scroll vertically or horizontally or click outside the Hierarchical Grid. This is valid for both cell editing and row editing.

Editing through API

You can also modify the cell value through the IgxHierarchicalGrid API but only if primary key is defined:

public updateCell() {
    this.hierarchicalGrid.updateCell(newValue, rowID, 'Age');
}

Outra maneira de atualizar a célula é diretamente através update do método de IgxGridCell:

public updateCell() {
    const cell = this.hierarchicalGrid.getCellByColumn(rowIndex, 'ReorderLevel');
    // You can also get cell by rowID if primary key is defined
    // cell = this.hierarchicalGrid.getCellByKey(rowID, 'ReorderLevel');
    cell.update(70);
}

Cell Editing Templates

Você pode ver e aprender mais sobre modelos de edição de células padrão no tópico de edição geral.

Se você quiser fornecer um modelo personalizado que será aplicado quando uma célula estiver no modo de edição, você pode usar a igxCellEditor diretiva. Para fazer isso, você precisa passar por uma ng-template marcação com a igxCellEditor diretiva e vincular corretamente seu controle personalizado ao cell.editValue:

<igx-column field="class" header="Class" [editable]="true">
    <ng-template igxCellEditor let-cell="cell" let-value>
        <igx-select class="cell-select" [(ngModel)]="cell.editValue" [igxFocus]="true">
            <igx-select-item *ngFor="let class of classes" [value]="class">
                {{ class }}
            </igx-select-item>
        </igx-select>
    </ng-template>
</igx-column>

Esse código é usado no exemplo abaixo, que implementa um IgxSelectComponent nas células das colunas and Race Class Alignment.

Note

Quaisquer alterações feitas na célula editValue no modo de edição acionarão o evento de edição apropriado na saída e se aplicarão ao estado da transação (se as transações estiverem habilitadas).

Note

O modelo de igxCell célula controla como as células de uma coluna são mostradas quando fora do modo de edição. A diretiva igxCellEditor de modelo de edição de célula manipula como as células de uma coluna no modo de edição são exibidas e controla o valor de edição da célula editada.

Note

Para obter mais informações sobre como configurar colunas e seus modelos, você pode ver a documentação para Configuração de colunas de grade.

CRUD operations

Note

Lembre-se de que, quando você executa alguma operação CRUD, todos os pipes aplicados, como filtragem, classificação e agrupamento, serão reaplicados e sua visualização será atualizada automaticamente.

The IgxHierarchicalGridComponent provides a straightforward API for basic CRUD operations.

Adding a new record

The Hierarchical Grid component exposes the addRow method which will add the provided data to the data source itself.

public addRow() {
    // Adding a new record
    // Assuming we have a `getNewRecord` method returning the new row data
    const record = this.getNewRecord();
    this.hierarchicalGrid.addRow(record, 1);
}

Updating data in the Hierarchical Grid

Updating data in the Hierarchical Grid is achieved through updateRow and updateCell methods but only if primary key for the grid is defined. You can also directly update a cell and/or a row value through their respective update methods.

// Updating the whole row
this.hierarchicalGrid.updateRow(newData, this.selectedCell.cellID.rowID);

// Just a particular cell through the Grid API
this.hierarchicalGrid.updateCell(newData, this.selectedCell.cellID.rowID, this.selectedCell.column.field);

// Directly using the cell `update` method
this.selectedCell.update(newData);

// Directly using the row `update` method
const row = this.hierarchicalGrid.getRowByKey(rowID);
row.update(newData);

Deleting data from the Hierarchical Grid

Lembre-se de que deleteRow() o método removerá a linha especificada somente se a chave primária for definida.

// Delete row through Grid API
this.hierarchicalGrid.deleteRow(this.selectedCell.cellID.rowID);
// Delete row through row object
const row = this.hierarchicalGrid.getRowByIndex(rowIndex);
row.delete();

These can be wired to user interactions, not necessarily related to the igx-hierarchical-grid; for example, a button click:

<button igxButton igxRipple (click)="deleteRow($event)">Delete Row</button>

Cell validation on edit event

Usando os eventos de edição da grade, podemos alterar a forma como o usuário interage com a grade. Neste exemplo, validaremos uma célula com base nos dados inseridos nela vinculando-se ao cellEdit evento. Se o novo valor da célula não atender aos nossos critérios predefinidos, impediremos que ele chegue à fonte de dados cancelando o evento (event.cancel = true). Também exibiremos uma mensagem de erro personalizada usando IgxToast.

A primeira coisa que precisamos é vincular ao evento da grade:

<igx-hierarchical-grid (cellEdit)="handleCellEdit($event)"
...>
...
</igx-hierarchical-grid>

O cellEdit emite sempre que o valor de qualquer célula está prestes a ser confirmado. Em nossa handleCellEdit definição, precisamos ter certeza de que verificamos nossa coluna específica antes de tomar qualquer ação:

export class MyHGridEventsComponent {
    public handleCellEdit(event: IGridEditEventArgs) {
        const today = new Date();
        const column = event.column;
        if (column.field === 'Debut') {
            if (event.newValue > today.getFullYear()) {
                this.toast.message = 'The debut date must be in the past!';
                this.toast.open();
                event.cancel = true;
            }
        } else if (column.field === 'LaunchDate') {
            if (event.newValue > new Date()) {
                this.toast.message = 'The launch date must be in the past!';
                this.toast.open();
                event.cancel = true;
            }
        }
    }
}

Aqui, estamos validando duas colunas. Se o usuário tentar alterar o ano de estreia de um artista ou a data de lançamento de um álbum, a grade não permitirá datas maiores que hoje.

The result of the above validation being applied to our igx-hierarchical-grid can be seen in the below demo:

Estilização

The IgxHierarchicalGrid allows for its cells to be styled through the Ignite UI for Angular Theme Library. The grid's grid-theme exposes a wide range of properties, which allow users to style many different aspects of the grid.

Nas etapas abaixo, veremos como você pode estilizar a célula da grade no modo de edição e como você pode definir o escopo desses estilos.

Para usar o Ignite UI Theming Library, devemos primeiro importar o arquivo de tema index em nossos estilos globais:

Importing style library

@use "igniteui-angular/theming" as *;

// IMPORTANT: Prior to Ignite UI for Angular version 13 use:
// @import '~igniteui-angular/lib/core/styles/themes/index';

Agora podemos fazer uso de todas as funções expostas pelo mecanismo de tema Ignite UI for Angular.

Defining a palette

Depois de importarmos corretamente o arquivo de índice, criamos uma paleta personalizada que podemos usar. Vamos definir três cores que gostamos e usá-las para construir uma paleta com palette:

$white: #fff;
$blue: #4567bb;
$gray: #efefef;

$color-palette: palette(
  $primary: $white, 
  $secondary: $blue, 
  $surface: $gray
);

Defining themes

We can now define the theme using our palette. The cells are styled by the grid-theme, so we can use that to generate a theme for our IgxHierarchicalGrid:

$custom-grid-theme: grid-theme(
  $cell-editing-background: $blue,
  $cell-edited-value-color: $white,
  $cell-active-border-color: $white,
  $edit-mode-color: color($color-palette, "secondary", 200)
);

Applying the theme

A maneira mais fácil de aplicar nosso tema é com uma sass @include instrução no arquivo de estilos globais:

@include grid($custom-grid-theme);

Demo

Além das etapas acima, também podemos estilizar os controles usados para os modelos de edição das células: input-group, datepicker & checkbox

Note

A amostra não será afetada Change Theme pelo tema global selecionado.

Angular Hierarchical Grid Cell Editing