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 usarigxCellEditor 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 porque elesfocus permanecerão nocell element componente editor, não no editor que adicionamos -igxSelect,igxCombo, etc. Por isso, devemos aproveitar aigxFocus diretiva, que moverá o foco diretamente para o componente dentro da 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 pressionarEnter a tecla;
ao pressionarF2 a tecla;

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

ao pressionarEscape a tecla;
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 pressionarEnter a tecla;
ao pressionarF2 a tecla;
ao pressionarTab a tecla;
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 forma de atualizar a célula é diretamente atravésupdate 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 em modo de edição, pode usar aigxCellEditor diretiva. Para isso, você precisa passar por umang-template marca com aigxCellEditor diretiva e vincular corretamente seu controle personalizado aocell.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 umIgxSelectComponent nas células dasRace colunas the,Class andAlignment.

Note

Qualquer alteração feita nas célulaseditValue no modo de edição acionará o evento de edição apropriado ao sair e se aplicará ao estado da transação (se as transações estiverem ativadas).

Note

O templateigxCell de célula controla como as células de uma coluna são exibidas quando fora do modo de edição. A diretivaigxCellEditor de modelo de edição de célula lida com 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.

EleIgxHierarchicalGridComponent fornece uma API direta para operações básicas de CRUD.

Adding a new record

O componente Hierarchical Grid expõe oaddRow método que adicionará os dados fornecidos à própria fonte de dados.

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

A atualização dos dados na Grade Hierárquica é realizada porupdateRow meio de métodos,updateCell mas somente se a chave primária da grade for definida. Você também pode atualizar diretamente uma célula e/ou um valor de linha pelos respectivosupdate métodos deles.

// 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

Por favor, lembre-se de que essedeleteRow() método só remove a linha especificada se a chave primária estiver 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, vamos validar uma célula com base nos dados inseridos nela ao se vincular aocellEdit evento. Se o novo valor da célula não atender aos nossos critérios predefinidos, impediremos que ela alcance a fonte de dados cancelando o evento (event.cancel = true). Também exibiremos uma mensagem de erro personalizada usandoIgxToast.

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

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

ElecellEdit emite sempre que o valor de qualquer célula está prestes a ser comprometido. Em nossahandleCellEdit definição, precisamos garantir que verificamos nossa coluna específica antes de tomar qualquer atitude:

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.

O resultado da validação acima sendo aplicada a nossoigx-hierarchical-grid pode ser visto na demonstração abaixo:

Estilização

O IgxHierarchicalGrid permite que suas células sejam estilizadas através doIgnite UI for Angular Theme Library. A gradegrid-theme expõe uma ampla gama de propriedades, permitindo aos usuários estilizar muitos aspectos diferentes da grade.

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 oIgnite UI Theming Library, primeiro devemos importar o arquivo de temaindex 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 compalette:

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

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

Defining themes

Agora podemos definir o tema usando nossa paleta. As células são estilizadas por ogrid-theme, então podemos usar isso para gerar um tema para nosso 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 umasass @include instrução no arquivo de estilos globais:

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

Demo

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

Note

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

Angular Hierarchical Grid Cell Editing