Angular Tree Grid Cell Editing

Ignite UI for Angular componente Tree Grid fornece ótimos recursos de manipulação de dados e API poderosa para operações CRUD Angular. Por padrão, a Grade de Árvore está sendo usada na edição de células e diferentes editores serão mostrados com base no tipo de dados da coluna, graças ao modelo de edição de célula padrão. Além disso, você pode definir seus próprios modelos personalizados para ações de atualização de dados e substituir o comportamento padrão para confirmar e descartar quaisquer alterações.

Angular Tree 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;
em um único clique para outra célula - quando você clica em outra célula na grade da árvore, suas alterações serão enviadas.
Operações como paginação, redimensionamento, fixar ou mover sairão do modo de edição e as alterações serão enviadas.

Note

A célula permanece no modo de edição quando você rola verticalmente ou horizontalmente ou clica fora da grade da árvore. Isso é válido para edição de células e edição de linha.

Editing through API

Você também pode modificar o valor da célula por meio da API IgxTreeGrid, mas somente se a chave primária estiver definida:

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

Outra forma de atualizar a célula é diretamente atravésupdate do método de:IgxGridCell

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

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.

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

Adding a new record

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

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

Updating data in the Tree Grid

Updating data in the Tree 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.treeGrid.updateRow(newData, this.selectedCell.cellID.rowID);

// Just a particular cell through the Tree Grid API
this.treeGrid.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.treeGrid.getRowByKey(rowID);
row.update(newData);

Deleting data from the Tree 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 Tree Grid API
this.treeGrid.deleteRow(this.selectedCell.cellID.rowID);
// Delete row through row object
const row = this.treeGrid.getRowByIndex(rowIndex);
row.delete();

Eles podem ser conectados às interações do usuário, não necessariamente relacionadas à igx-tree-grid; Por exemplo, um clique de botão:

<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-tree-grid (cellEdit)="handleCellEdit($event)"
...>
...
</igx-tree-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 MyTreeGridEventsComponent {
    public handleCellEdit(event: IGridEditEventArgs): void {
        const column = event.column;
        if (column.field === 'Age') {
            if (event.newValue < 18) {
                event.cancel = true;
                this.toast.message = 'Employees must be at least 18 years old!';
                this.toast.open();
            }
        } else if (column.field === 'HireDate') {
            if (event.newValue > new Date().getTime()) {
                event.cancel = true;
                this.toast.message = 'The employee hire date must be in the past!';
                this.toast.open();
            }
        }
    }
}

Aqui, estamos validando duas colunas. Se o usuário tentar definir um valor inválido para a Idade de um funcionário (abaixo de 18) ou sua Data de Contratação (uma data futura), a edição será cancelada (o valor não será enviado) e uma notificação do sistema com uma mensagem de erro será exibida.

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

Estilização

The IgxTreeGrid 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 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

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 IgxTreeGrid:

$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.

API References

Additional Resources

Procurando

Angular Tree Grid Cell Editing