Angular Edição de células de grade

    Ignite UI for Angular componente Grid fornece ótimos recursos de manipulação de dados e API poderosa para operações CRUD Angular. Por padrão, a Grade 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 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;
    • em um único clique para outra célula - quando você clica em outra célula na Grade, 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. 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 IgxGrid, mas somente se a chave primária estiver definida:

    public updateCell() {
    this.grid1.updateCell(newValue, rowID, 'ReorderLevel');
}

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

    public updateCell() {
    const cell = this.grid1.getCellByColumn(rowIndex, 'ReorderLevel');
    // You can also get cell by rowID if primary key is defined
    // cell = this.grid1.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

    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.

    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.

    Grid Excel Style Editing

    Usar a Edição de Estilo do Excel permite que o usuário navegue pelas células da mesma forma que faria usando o Excel e edite-as rapidamente.

    A implementação dessa funcionalidade personalizada pode ser feita utilizando os eventos da grade. Primeiro, conectamos aos eventos keydown da grade e, a partir daí, podemos implementar duas funcionalidades:

    • Modo de edição constante
    public keydownHandler(event) {
  const key = event.keyCode;
  const grid = this.grid;
  const activeElem = grid.navigation.activeNode;

  if(
    (key >= 48 && key <= 57) ||
    (key >= 65 && key <= 90) ||
    (key >= 97 && key <= 122)){
        // Number or Alphabet upper case or Alphabet lower case
        const columnName = grid.getColumnByVisibleIndex(activeElem.column).field;
        const cell = grid.getCellByColumn(activeElem.row, columnName);
        if (cell && !cell.editMode) {
            cell.editMode = true;
            cell.editValue = event.key;
            this.shouldAppendValue = true;
        } else if (cell && cell.editMode && this.shouldAppendValue) {
            event.preventDefault();
            cell.editValue = cell.editValue + event.key;
            this.shouldAppendValue = false;
        }
    }
}
    • Enter / Shift+Enter navegação
    if (key == 13) {
    let thisRow = activeElem.row;
    const column = activeElem.column;
    const rowInfo = grid.dataView;

    // to find the next eiligible cell, we will use a custom method that will check the next suitable index
    let nextRow = this.getNextEditableRowIndex(thisRow, rowInfo, event.shiftKey);

    // and then we will navigate to it using the grid's built in method navigateTo
    this.grid.navigateTo(nextRow, column, (obj) => {
        obj.target.activate();
        this.grid.clearCellSelection();
        this.cdr.detectChanges();
    });
}

    As principais partes para encontrar o próximo índice elegível seriam:

    //first we check if the currently selected cell is the first or the last
if (currentRowIndex < 0 || (currentRowIndex === 0 && previous) || (currentRowIndex >= dataView.length - 1 && !previous)) {
return currentRowIndex;
}
// in case using shift + enter combination, we look for the first suitable cell going up the field
if(previous){
return  dataView.findLastIndex((rec, index) => index < currentRowIndex && this.isEditableDataRecordAtIndex(index, dataView));
}
// or for the next one down the field
return dataView.findIndex((rec, index) => index > currentRowIndex && this.isEditableDataRecordAtIndex(index, dataView));

    Confira o exemplo completo para referência futura:

    Angular Grid Excel Style Editing Sample

    Os principais benefícios da abordagem acima incluem:

    • Modo de edição constante: digitar enquanto uma célula estiver selecionada entrará imediatamente no modo de edição com o valor digitado, substituindo o existente
    • Todas as linhas que não são de dados são ignoradas ao navegar com Enter / Shift+Enter. Isso permite que os usuários percorram rapidamente seus valores.

    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.

    O IgxGridComponent fornece uma API direta para operações CRUD básicas.

    Adding a new record

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

    // Adding a new record
// Assuming we have a `getNewRecord` method returning the new row data.
const record = this.getNewRecord();
this.grid.addRow(record);

    Updating data in the Grid

    A atualização de dados na grade é obtida por meio updateRow de métodos e updateCell, mas somente se a chave primária para a grade for definida. Você também pode atualizar diretamente um valor de célula e/ou linha por meio de seus respectivos update métodos.

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

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

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

    Eles podem ser conectados a interações do usuário, não necessariamente relacionadas à grade igx; 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, 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-grid (cellEdit)="handleCellEdit($event)"
...>
...
</igx-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 MyGridEventsComponent {
    public handleCellEdit(event: IGridEditEventArgs): void {
        const column = event.column;
        if (column.field === 'Ordered') {
            const rowData = event.rowData;
            if (!rowData) {
                return;
            }
            if (event.newValue > rowData.UnitsInStock) {
                event.cancel = true;
                this.toast.open();
            }
        }
    }
}

    Se o valor inserido em uma célula na coluna Pedido for maior que o valor disponível (o valor em Unidades em Estoque), a edição será cancelada e uma notificação do sistema com uma mensagem de erro será exibida.

    O resultado da validação acima sendo aplicada ao nosso igx-grid pode ser visto na demonstração abaixo:

    Estilização

    O IgxGrid permite que suas células sejam estilizadas através do Ignite UI for Angular Theme Library. A grade grid-theme expõe uma ampla gama de propriedades, que permitem 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 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

    Agora podemos definir o tema usando nossa paleta. As células são estilizadas por o, então podemos usar isso para gerar um tema para nosso grid-theme IgxGrid:

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

    API References

    Additional Resources