Blazor Tree Grid Summaries

    La función Ignite UI for Blazor Summaries en Blazor Tree Grid funciona a nivel de columna como pie de grupo. Los resúmenes Blazor TreeGrid son una característica poderosa que permite al usuario ver la información de la columna en un contenedor separado con un conjunto predefinido de elementos de resumen predeterminados, según el tipo de datos dentro de la columna o mediante la implementación de una plantilla personalizada en IgbTreeGrid.

    Ejemplo de resumen de cuadrícula de árbol Blazor

    EXAMPLE
    DATA
    MODULES
    RAZOR
    JS
    CSS

    ¿Te gusta esta muestra? Obtenga acceso a nuestro kit de herramientas de Ignite UI for Blazor completo y comience a crear sus propias aplicaciones en minutos. Descárgalo gratis.

    El resumen de la columna es una función de todos los valores de la columna; a menos que se aplique un filtrado, el resumen de la columna será función de los valores de los resultados filtrados.

    Los resúmenes IgbTreeGrid también se pueden habilitar a nivel de columna en Ignite UI for Blazor, lo que significa que puede activarlos solo para las columnas que necesite. Los resúmenes IgbTreeGrid le brindan un conjunto predefinido de resúmenes predeterminados, según el tipo de datos en la columna, para que pueda ahorrar algo de tiempo:

    Para string y boolean ​ ​DataType, está disponible la siguiente función:

    • Contar

    Para los tipos de datos number, currency y percent, están disponibles las siguientes funciones:

    • Contar
    • mín.
    • máx.
    • Promedio
    • Suma

    Para el tipo de datos date, están disponibles las siguientes funciones:

    • Contar
    • Más temprano
    • El último

    Todos los tipos de datos de columna disponibles se pueden encontrar en el tema oficial Tipos de columna.

    IgbTreeGrid Los resúmenes se habilitan por columna configurando HasSummary propiedad a verdadero. También es importante tener en cuenta que los resúmenes de cada columna se resuelven según el tipo de datos de columna. En IgbTreeGrid El tipo de datos de columna predeterminado es string, así que si quieres number o date resúmenes específicos, debe especificar el DataType propiedad como number o date. Tenga en cuenta que los valores de resumen se mostrarán localizados, de acuerdo con la cuadrícula Locale y columna PipeArgs.

    <IgbTreeGrid>
            <IgbColumn Field="ID" Header="Order ID"></IgbColumn>
            <IgbColumn Field="Name" Header="Order Product" HasSummary="true"></IgbColumn>
            <IgbColumn Field="Units" Header="Units" HasSummary="true"></IgbColumn>
    </IgbTreeGrid>
    razor

    La otra forma de habilitar/deshabilitar resúmenes para una columna específica o una lista de columnas es usar el método EnableSummaries public / DisableSummaries de la IgbTreeGrid.

    <IgbTreeGrid AutoGenerate="false" Data="OrdersTreeData" Name="treeGrid" @ref="treeGridRef" Id="treeGrid" PrimaryKey="ID">
        <IgbColumn Field="ID" Header="Order ID"></IgbColumn>
        <IgbColumn Field="Name" Header="Order Product" HasSummary="true"></IgbColumn>
        <IgbColumn Field="Units" Header="Units" DataType="GridColumnDataType.Number" HasSummary="true"></IgbColumn>
    </IgbTreeGrid>
    
    @code {
        public async void DisableSummaries()
        {
            object[] disabledSummaries = { "Units" };
            await this.treeGrid.DisableSummariesAsync(disabledSummaries);
        }
    }
    razor

    Resúmenes de cuadrícula de árbol personalizados

    Si estas funciones no cumplen con sus requisitos, puede proporcionar un resumen personalizado para las columnas específicas.

    
    //In JavaScript
    class PtoSummary {
        operate(data, allData, fieldName) {
            const result = [];
            result.push({
                key: 'totalOnPTO',
                label: 'Employees On PTO',
                summaryResult: this.count(allData.filter((rec) => rec['OnPTO']).map(r => r[fieldName]))
            });
            result.push({
                key: 'devs',
                label: 'Developers',
                summaryResult: this.count(allData.filter((rec) => rec[fieldName].includes('Developer') && rec['OnPTO']).map(r => r[fieldName]))
            });
            result.push({
                key: 'tl',
                label: 'Team Leads',
                summaryResult: this.count(allData.filter((rec) => rec[fieldName].includes('Team Lead') && rec['OnPTO']).map(r => r[fieldName]))
            });
            result.push({
                key: 'managers',
                label: 'Managers/Directors',
                summaryResult: this.count(allData.filter((rec) => (rec[fieldName].includes('Manager') || rec[fieldName].includes('Director')) && rec['OnPTO']).map(r => r[fieldName]))
            });
            result.push({
                key: 'ceo',
                label: 'CEO/President',
                summaryResult: this.count(allData.filter((rec) => (rec[fieldName].includes('CEO') || rec[fieldName].includes('President')) && rec['OnPTO']).map(r => r[fieldName]))
            });
            return result;
        }
    }
    razor

    Como se ve en los ejemplos, las clases base exponen el método Operate, por lo que puede elegir obtener todos los resúmenes predeterminados y modificar el resultado, o calcular resultados resumidos completamente nuevos.

    El método devuelve una lista de IgbSummaryResult.

    y tomar parámetros opcionales para calcular los resúmenes. Consulte Resúmenes personalizados, que acceden a toda la sección de datos a continuación.

    Para calcular correctamente la altura de la fila de resumen, la cuadrícula de árbol necesita que el método Operate devuelva siempre una matriz de IgbSummaryResult con la longitud adecuada, incluso cuando los datos están vacíos.

    <IgbTreeGrid 
            AutoGenerate="true"
            Name="treeGrid"
            @ref="treeGrid"
            Data="EmployeesFlatData"
            PrimaryKey="ID"
            ColumnInitScript="WebTreeGridCustomSummary">
    </IgbTreeGrid>
    
    // In Javascript
    igRegisterScript("WebTreeGridCustomSummary", (event) => {
        if (event.detail.field === "Title") {
            event.detail.summaries = PtoSummary;
        }
    }, false);
    razor

    Resúmenes personalizados, que acceden a todos los datos

    Ahora puede acceder a todos los datos de la cuadrícula de árbol dentro del resumen de columna personalizado. Se introducen dos parámetros opcionales adicionales en el método SummaryOperand Operate. Como puede ver en el fragmento de código a continuación, el método operate tiene los siguientes tres parámetros:

    • columnData: le proporciona una matriz que contiene los valores solo para la columna actual
    • allGridData: le brinda toda la fuente de datos de la cuadrícula
    • fieldName - campo de columna actual
    class PtoSummary {
        operate(data, allData, fieldName) {
            const result = [];
            result.push({
                key: 'totalOnPTO',
                label: 'Employees On PTO',
                summaryResult: this.count(allData.filter((rec) => rec['OnPTO']).map(r => r[fieldName]))
            });
            return result;
        }
    }
    razor

    EXAMPLE
    DATA
    MODULES
    RAZOR
    JS
    CSS

    Plantilla de resumen

    Summary apunta al resumen de la columna proporcionando como contexto los resultados del resumen de la columna.

    <IgbColumn HasSummary="true" SummaryTemplateScript="SummaryTemplate">
    </IgbColumn>
    
    igRegisterScript("SummaryTemplate", (ctx) => {
        var html = window.igTemplating.html;
        return html`<div>
        <span> ${ctx.implicit[0].label} - ${ctx.implicit[0].summaryResult} </span>
    </div>`
    }, false);
    razor

    Cuando se define un resumen predeterminado, la altura del área de resumen se calcula por diseño en función de la columna con el mayor número de resúmenes y la--ig-size de la cuadrícula. Utilice la SummaryRowHeight propiedad input para invalidar el valor predeterminado. Como argumento, espera un valor numérico, y establecer un valor falso desencadenará el comportamiento de tamaño predeterminado del pie de página de la cuadrícula.

    EXAMPLE
    DATA
    MODULES
    RAZOR
    JS
    CSS

    Resúmenes infantiles

    Admite IgbTreeGrid resúmenes independientes para los nodos raíz y para cada nivel de nodo secundario anidado. Los resúmenes que se muestran se pueden configurar mediante la SummaryCalculationMode propiedad. Los resúmenes de nivel secundario se pueden mostrar antes o después de los nodos secundarios que utilizan la SummaryPosition propiedad. Junto con estas dos propiedades, la propiedad exposes y ShowSummaryOnCollapse que le permite determinar si la IgbTreeGrid fila de resumen permanece visible cuando se contrae el nodo primario al que se hace referencia.

    Los valores disponibles de la propiedad SummaryCalculationMode son:

    • RootLevelOnly- Los resúmenes se calculan solo para los nodos de nivel raíz.
    • ChildLevelsOnly: los resúmenes se calculan solo para los niveles secundarios.
    • RootAndChildLevels: los resúmenes se calculan tanto para el nivel raíz como para el nivel secundario. Este es el valor predeterminado.

    Los valores disponibles de la propiedad SummaryPosition son:

    • Top- La fila de resumen aparece antes de la lista de filas secundarias.
    • Bottom- La fila de resumen aparece después de la lista de filas secundarias. Este es el valor predeterminado.

    La ShowSummaryOnCollapse propiedad es booleana. Su valor predeterminado se establece en false, lo que significa que la fila de resumen se ocultará cuando se contraiga la fila principal. Si la propiedad se establece en true, la fila de resumen permanece visible cuando se contrae la fila principal.

    La propiedad SummaryPosition solo se aplica a los resúmenes de nivel secundario. Los resúmenes de nivel raíz aparecen siempre fijos en la parte inferior de IgbTreeGrid.

    EXAMPLE
    DATA
    MODULES
    RAZOR
    JS
    CSS

    Navegación por teclado

    Se puede navegar por las filas de resumen con las siguientes interacciones de teclado:

    • ARRIBA: navega una celda hacia arriba.
    • ABAJO: navega una celda hacia abajo.
    • IZQUIERDA: navega una celda hacia la izquierda.
    • DERECHA: navega una celda hacia la derecha.
    • CTRL + IZQUIERDA o INICIO: navega a la celda más a la izquierda.
    • CTRL + DERECHA o FINAL: navega a la celda más a la derecha.

    Estilo

    Además de los temas predefinidos, la cuadrícula se puede personalizar aún más configurando algunas de las propiedades CSS disponibles. En caso de que desee cambiar algunos de los colores, primero debe establecer una clase para la cuadrícula:

    <IgbTreeGrid class="grid"></IgbTreeGrid>
    razor

    Luego configure las propiedades CSS relacionadas para esa clase:

    .grid {
        --ig-grid-summary-background-color:#e0f3ff;
        --ig-grid-summary-focus-background-color: rgba( #94d1f7, .3 );
        --ig-grid-summary-label-color: rgb(228, 27, 117);
        --ig-grid-summary-result-color: black;
    }
    css

    Manifestación

    EXAMPLE
    DATA
    MODULES
    RAZOR
    JS
    CSS

    Referencias de API

    Recursos adicionales

    Nuestra comunidad es activa y siempre da la bienvenida a nuevas ideas.