React Tree Grid Column Pinning

    O recurso Ignite UI for React Column Pinning no React Tree Grid permite que os desenvolvedores bloqueiem colunas específicas na ordem desejada, garantindo visibilidade o tempo todo, mesmo quando os usuários rolam horizontalmente pelo IgrTreeGrid. Há uma interface do usuário integrada para fixação de colunas, acessível por meio da barra de ferramentas React Tree Grid. Além disso, os desenvolvedores têm a flexibilidade de criar uma interface de usuário personalizada que altera o estado do pino das colunas.

    React Tree Grid Column Pinning Example

    Este exemplo demonstra como você pode fixar uma coluna ou várias colunas no lado esquerdo ou direito do IgrTreeGrid.

    Column Pinning API

    A fixação de coluna é controlada por meio da pinned propriedade do IgrColumn. As colunas fixadas são renderizadas no lado esquerdo do IgrTreeGrid por padrão e permanecem fixas por meio da rolagem horizontal das colunas não fixadas no IgrTreeGrid corpo.

    <IgrTreeGrid data={nwindData} autoGenerate={false}>
    <IgrColumn field="Name" pinned={true}></IgrColumn>
    <IgrColumn field="Phone" pinned={true}></IgrColumn>
    <IgrColumn field="Title"></IgrColumn>
</IgrTreeGrid>

    Você também pode usar os IgrTreeGrid​ ​pinColumn métodos ou unpinColumn métodos do para fixar ou desafixar colunas pelo nome do IgrTreeGrid campo:

    gridRef.current.pinColumn('Title');
gridRef.current.unpinColumn('Name');

    Ambos os métodos retornam um valor booleano indicando se sua respectiva operação foi bem-sucedida ou não. Normalmente, o motivo pelo qual eles falham é que a coluna já está no estado desejado.

    Uma coluna é fixada à direita da coluna fixada mais à direita. Alterar a ordem das colunas fixadas pode ser feito assinando o evento ColumnPin e alterando a propriedade InsertAtIndex dos argumentos do evento para o índice de posição desejado.

    const columnPinning = (event: IgrPinColumnCancellableEventArgs) = {
    if (event.detail.column.field === 'Name') {
        event.detail.insertAtIndex = 0;
    }
}

    Pinning Position

    Você pode alterar a posição de fixação da coluna por meio da pinning opção de configuração. Ele permite que você defina a posição das colunas como Início ou Fim. Quando definido como Final, as colunas são renderizadas no final da grade, após as colunas desafixadas. As colunas não afixadas podem ser roladas horizontalmente, enquanto as colunas fixadas permanecem fixas à direita.

    const pinningConfig: IgrPinningConfig = { columns: ColumnPinningPosition.End };

    <IgrTreeGrid data={nwindData} autoGenerate={true} pinning={pinningConfig}></IgrTreeGrid>

    Demo

    Além disso, você pode especificar cada local de fixação de coluna separadamente, permitindo fixar colunas em ambos os lados da grade para maior conveniência e otimização mais fácil dos conjuntos de dados. Consulte a demonstração abaixo para obter mais referências. Para fixar uma coluna, selecione uma coluna clicando em um cabeçalho e use os botões de fixação adicionados à barra de ferramentas ou simplesmente arraste uma coluna para outra fixada.

    Demo

    Custom Column Pinning UI

    Você pode definir sua interface do usuário personalizada e alterar o estado do pino das colunas por meio da API relacionada.

    Digamos que, em vez de uma barra de ferramentas, você queira definir ícones de alfinetes nos cabeçalhos das colunas, nos quais o usuário final pode clicar para alterar o estado de alfinete de uma coluna específica.

    Isso pode ser feito criando um modelo de cabeçalho para as colunas com um ícone personalizado.

    <IgrTreeGrid autoGenerate={false} data={CustomersData} ref={grid}>
    <IgrColumn field="Name" pinned={true}></IgrColumn>

    <IgrColumn field="Title" header="Title" width="300px" pinned={true}
    headerTemplate={toggleColumnPin}></IgrColumn>

    <IgrColumn field="Phone" header="Phone" width="200px"
    headerTemplate={toggleColumnPin}> </IgrColumn>

    <IgrColumn field="Age" header="Age" width="200px"
    headerTemplate={toggleColumnPin}></IgrColumn>
</IgrTreeGrid>

    const toggleColumnPin = (ctx: IgrColumnTemplateContext) => {
  const togglePin = () => {
    const col = ctx.column;
    col.pinned = !col.pinned;
  }
  
  const col = ctx.column;

  return(
    <div>
      <span style={{ float: 'left' }}>{col.header}</span>
      <span style={{ float: 'right' }} onClick={() => togglePin()}>📌</span>
    </div>
  );
}

    Demo

    Pinning Limitations

    • Definir larguras de coluna em porcentagem (%) explicitamente faz com que o conteúdo do corpo e do IgrTreeGrid cabeçalho fique desalinhado quando houver colunas fixadas. Para que a fixação de colunas funcione corretamente, as larguras das colunas devem estar em pixels (px) ou atribuídas automaticamente pelo IgrTreeGrid.

    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 um ID para a grade primeiro:

    <IgrTreeGrid id="grid"></IgrTreeGrid>

    Em seguida, defina as propriedades CSS relacionadas a esta classe:

    #grid {
    --ig-grid-pinned-border-width: 5px;
    --ig-grid-pinned-border-color: #FFCD0F;
    --ig-grid-pinned-border-style: double;
    --ig-grid-cell-active-border-color: #FFCD0F;
}

    Demo

    API References

    Additional Resources

    Nossa comunidade é ativa e sempre acolhedora para novas ideias.