Blazor Resúmenes de cuadrícula

La función Ignite UI for Blazor Summaries en Blazor Grid funciona a nivel de columna como pie de página de grupo. Blazor Resumen de IgbGrid es una función 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, dependiendo del tipo de datos dentro de la columna o mediante la implementación de una plantilla personalizada en laIgbGrid.

Blazor Grid Summaries Overview Example

[!Note] The summary of the column is a function of all column values, unless filtering is applied, then the summary of the column will be function of the filtered result values

IgbGridLos resúmenes también pueden activarse a nivel de columna en Ignite UI for Blazor, lo que significa que solo puedes activarlo para las columnas que necesites.IgbGrid Resumen te ofrece un conjunto predefinido de resúmenes por defecto, dependiendo del tipo de datos en la columna, para que puedas ahorrar tiempo:

Parastring yboolean DataType está disponible la siguiente función:

• Contar

Paranumber ycurrency​percent tipos de datos, están disponibles las siguientes funciones:

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

Para eldate tipo de dato, 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.

IgbGridLos resúmenes se activan por columna estableciendoHasSummary la propiedad en True. También es importante tener en cuenta que los resúmenes de cada columna se resuelven según el tipo de dato de columna. En laIgbGrid columna predeterminada el tipo de dato esstring, así que si quieresnumber resúmenesdate específicos deberías especificar laDataType propiedad comonumber odate. Ten en cuenta que los valores resumen se mostrarán localizados, según la cuadrículaLocale y la columnaPipeArgs.

<IgbGrid>
        <IgbColumn Field="EmployeeID" DataType="GridColumnDataType.Number" HasSummary="true"></IgbColumn>
        <IgbColumn Field="FirstName" HasSummary="true"></IgbColumn>
        <IgbColumn Field="LastName" HasSummary="true"></IgbColumn>
        <IgbColumn Field="Title" HasSummary="true"></IgbColumn>
</IgbGrid>

La otra forma de activar/desactivar resúmenes para una columna específica o una lista de columnas es usar el métodoEnableSummaries público/DisableSummaries of.IgbGrid​

 <IgbGrid @ref=grid Id="grid" AutoGenerate="false">
        <IgbColumn Field="EmployeeID" DataType="GridColumnDataType.Number" HasSummary="true"></IgbColumn>
        <IgbColumn Field="FirstName" Sortable="true" HasSummary="true"></IgbColumn>
        <IgbColumn Field="LastName" Sortable="false" DisablePinning="true" DisableHiding="true" HasSummary="true"></IgbColumn>
        <IgbColumn Field="Title" Sortable="true" DisablePinning="false" DisableHiding="true"></IgbColumn>
</IgbGrid>

@code {
    public async void DisableSummaries()
    {
        object[] disabledSummaries = { "EmployeeID" };
        await this.grid.DisableSummariesAsync(disabledSummaries);
    }
}

Custom Grid Summaries

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

//In JavaScript
class WebGridDiscontinuedSummary {
    operate(data, allData, fieldName) {
        const discontinuedData = allData.filter((rec) => rec['Discontinued']).map(r => r[fieldName]);
        const result = [];
        result.push({
            key: 'products',
            label: 'Products',
            summaryResult: data.length
        });
        result.push({
            key: 'total',
            label: 'Total Items',
            summaryResult: data.length ? data.reduce((a, b) => +a + +b) : 0
        });
        result.push({
            key: 'discontinued',
            label: 'Discontinued Products',
            summaryResult: allData.map(r => r['Discontinued']).filter((rec) => rec).length
        });
        result.push({
            key: 'totalDiscontinued',
            label: 'Total Discontinued Items',
            summaryResult: discontinuedData.length ? discontinuedData.reduce((a, b) => +a + +b) : 0
        });
        return result;
    }
}

Como se ve en los ejemplos, las clases base exponen elOperate método, así que puedes elegir obtener todos los resúmenes por defecto y modificar el resultado, o calcular resultados de resumen completamente nuevos.

El método devuelve una lista deIgbSummaryResult.

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.

[!Note] In order to calculate the summary row height properly, the Grid needs the Operate method to always return an array of IgbSummaryResult with the proper length even when the data is empty.

<IgbGrid
        AutoGenerate="true"
        Name="grid"
        @ref="grid"
        Data="NwindData"
        PrimaryKey="ProductID"
        ColumnInitScript="WebGridCustomSummary">
</IgbGrid>

// In Javascript
igRegisterScript("WebGridCustomSummary", (event) => {
    if (event.detail.field === "UnitsInStock") {
        event.detail.summaries = WebGridDiscontinuedSummary;
    }
}, false);

Custom summaries, which access all data

Ahora puedes acceder a todos los datos de Grid dentro del resumen personalizado de columnas. Se introducen dos parámetros opcionales adicionales en el método SummaryOperandOperate. Como puedes ver en el fragmento de código de abajo, el método de operación 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 WebGridDiscontinuedSummary {
    operate(data, allData, fieldName) {
        const discontinuedData = allData.filter((rec) => rec['Discontinued']).map(r => r[fieldName]);
        result.push({
            key: 'totalDiscontinued',
            label: 'Total Discontinued Items',
            summaryResult: discontinuedData.length ? discontinuedData.reduce((a, b) => +a + +b) : 0
        });
        return result;
    }
}

Summary Template

SummaryTemplateApunta al resumen de columnas proporcionando como contexto los resultados del resumen de 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);

Cuando se define un resumen por defecto, la altura del área del resumen se calcula por diseño dependiendo de la columna con el mayor número de resúmenes y de la--ig-size cuadrícula. Usa laSummaryRowHeight propiedad de entrada para anular el valor por defecto. Como argumento, espera un valor numérico, y establecer un valor falso activará el comportamiento de dimensionamiento por defecto del pie de página de la cuadrícula.

Disabled Summaries

LaDisabledSummaries propiedad proporciona un control preciso por columna sobre la función resumen de Blazor Grid. Esta propiedad permite a los usuarios personalizar los resúmenes mostrados para cada columna en el IgbGrid, asegurando que solo se muestren los datos más relevantes y significativos. Por ejemplo, puedes excluir tipos específicos de resumen, como ['count', 'min', 'max'] especificando sus claves de resumen en un array.

Esta propiedad también se puede modificar dinámicamente en tiempo de ejecución a través del código, lo que proporciona flexibilidad para adaptar los resúmenes de IgbGrid a los cambios en los estados de la aplicación o a las acciones del usuario.

Los siguientes ejemplos ilustran cómo utilizar laDisabledSummaries propiedad para gestionar resúmenes de diferentes columnas y excluir tipos específicos de resúmenes predeterminados y personalizados en la Blazor Grid:

<!-- Disable default summaries -->
<IgbColumn
    Field="UnitPrice"
    Header="Unit Price"
    DataType="GridColumnDataType.Number"
    HasSummary="true"
    DisabledSummaries="['count', 'sum', 'average']" />

<!-- Disable custom summaries -->
<IgbColumn
    Field="UnitsInStock"
    Header="Units In Stock"
    DataType="GridColumnDataType.Number"
    HasSummary="true"
    Summaries="discontinuedSummary"
    DisabledSummaries="['discontinued', 'totalDiscontinued']" />

PorqueUnitPrice, los resúmenes por defecto comocount,sum, yaverage están deshabilitados, dejando a otros comomin ymax activos.

ParaUnitsInStock esto, los resúmenes personalizados comodiscontinued ytotalDiscontinued se excluyen usando laDisabledSummaries propiedad.

En tiempo de ejecución, los resúmenes también pueden desactivarse dinámicamente usando estaDisabledSummaries propiedad. Por ejemplo, puedes establecer o actualizar la propiedad en columnas específicas de forma programática para adaptar los resúmenes mostrados según acciones del usuario o cambios en el estado de la aplicación.

Summaries with Group By

Cuando has agrupado por columnas, teIgbGrid permite cambiar la posición del resumen y el modo de cálculo usando lasSummaryCalculationMode propiedades ySummaryPosition. Junto con estas dos propiedades, losIgbGrid exposes yShowSummaryOnCollapse la propiedad que te permiten determinar si la fila resumen permanece visible cuando la fila del grupo a la que se refiere está colapsada.

Los valores disponibles de laSummaryCalculationMode propiedad son:

• RootLevelOnly- Los resúmenes se calculan solo para el nivel raíz.
• ChildLevelsOnly- Los resúmenes se calculan solo para los niveles hijos.
• RootAndChildLevels- Los resúmenes se calculan tanto para el nivel raíz como para el hijo de la empresa. Este es el valor por defecto.

Los valores disponibles de laSummaryPosition propiedad son:

• Top- La fila resumen aparece antes del grupo por hijos de la fila.
• Bottom- La fila resumen aparece después del grupo por hijos de la fila. Este es el valor por defecto.

LaShowSummaryOnCollapse propiedad es booleana. Su valor por defecto está configurado como falso, lo que significa que la fila resumen quedaría oculta cuando la fila del grupo se colapsa. Si la propiedad está configurada como verdadera, la fila resumen permanece visible cuando se colapsa la fila del grupo.

[!Note] The SummaryPosition property applies only for the child level summaries. The root level summaries appear always fixed at the bottom of the IgbGrid.

Demo

Keyboard Navigation

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.

Styling

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:

<IgbGrid class="grid"></IgbGrid>

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;
}

Demo

API References

• SummaryOperand
• NumberSummaryOperand
• DateSummaryOperand
• IgbColumnGroup
• IgbColumn

Additional Resources

• Tipos de datos de columna
• Virtualización y rendimiento
• Paginación
• Filtración
• Clasificación
• Columna en movimiento
• Fijación de columnas
• Cambio de tamaño de columna
• Selección

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

• Ignite UI for Blazor Foros
• Ignite UI for Blazor GitHub