Blazor Hierarchical Grid Column Pinning

    The Ignite UI for Blazor Column Pinning feature in Blazor Hierarchical Grid enables developers to lock specific columns in a desired order, ensuring visibility all the time even when users scroll horizontally through the IgbGrid. There’s an integrated UI for Column Pinning, accessible via the Blazor Hierarchical Grid toolbar. Additionally, developers have the flexibility to build a custom user interface which changes the pin state of the columns.

    Blazor Hierarchical Grid Column Pinning Example

    This example demonstrates how you can pin a column or multiple columns to the left or right side of the IgbHierarchicalGrid.

    Column Pinning API

    Column pinning is controlled through the Pinned property of the IgbColumn. Pinned columns are rendered on the left side of the IgbHierarchicalGrid by default and stay fixed through horizontal scrolling of the unpinned columns in the IgbHierarchicalGrid body.

    You may also use the IgbHierarchicalGrid's PinColumn or UnpinColumn methods of the IgbHierarchicalGrid to pin or unpin columns by their field 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.

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

    <IgbHierarchicalGrid Data=data AutoGenerate=true ColumnPinScript="onColumnPin"/>


//In JavaScript
function onColumnPin(e) {
    if (e.detail.column.field == "Country") {
        e.detail.insertAtIndex = 0;
    }
}

igRegisterScript("onColumnPin", onColumnPin, false);

    Pinning Position

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

    <IgbHierarchicalGrid Data=data AutoGenerate=true Pinning="pinningConfig"></IgbHierarchicalGrid>

@code {
    private IgbPinningConfig pinningConfig = new() {
        Columns = ColumnPinningPosition.End
    };
}

    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.

    Demo

    Pinning Limitations

    • Setting column widths in percentage (%) explicitly makes the IgbHierarchicalGrid body and header content to be misaligned when there are pinned columns. For column pinning to function correctly the column widths should be in pixels (px) or auto-assigned by the IgbHierarchicalGrid.

    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:

    <IgbHierarchicalGrid Id="grid"></IgbHierarchicalGrid>

    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.