React Grid Summaries

The Ignite UI for React Summaries feature in React Grid functions on a per-column level as group footer. React IgrGrid summaries is powerful feature which enables the user to see column information in a separate container with a predefined set of default summary items, depending on the type of data within the column or by implementing a custom template in the IgrGrid.

React 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

IgrGrid summaries can also be enabled on a per-column level in Ignite UI for React, which means that you can activate it only for columns that you need. IgrGrid summaries gives you a predefined set of default summaries, depending on the type of data in the column, so that you can save some time:

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.

IgrGridLos 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 laIgrGrid 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.

<IgrGrid autoGenerate={false} height="800px" width="800px">
    <IgrColumn field="ProductID" header="Product ID" width="200px"  sortable={true}>
    </IgrColumn>
    <IgrColumn field="ProductName" header="Product Name" width="200px" sortable={true} hasSummary={true}>
    </IgrColumn>
    <IgrColumn field="ReorderLevel" width="200px" editable={true} dataType="number" hasSummary={true}>
    </IgrColumn>
</IgrGrid>

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.IgrGrid​

const enableSummary = () => {
    gridRef.current.enableSummaries([
        {fieldName: 'ReorderLevel'},
        {fieldName: 'ProductID'}
    ]);
}
const disableSummary = () => {
    gridRef.current.disableSummaries(['ProductID']);
}

<IgrGrid ref={gridRef} autoGenerate={false} height="800px" width="800px">
    <IgrColumn field="ProductID" header="Product ID" width="200px" sortable={true}>
    </IgrColumn>
    <IgrColumn field="ProductName" header="Product Name" width="200px" sortable={true} hasSummary={true}>
    </IgrColumn>
    <IgrColumn field="ReorderLevel" width="200px" editable={true} dataType="number" hasSummary={true}>
    </IgrColumn>
</IgrGrid>
<button onClick={enableSummary}>Enable Summary</button>
<button onClick={disableSummary}>Disable Summary </button>

Summary Template

summaryTemplateApunta al resumen de columnas proporcionando como contexto los resultados del resumen de columna.

const summaryTemplate = (ctx: IgrSummaryTemplateContext) => {
  return (
    <>
      <span>My custom summary template</span>
      <span>{ctx.implicit[0].label} - {ctx.implicit[0].summaryResult}</span>
    </>
  );
}

<IgrColumn hasSummary={true} summaryTemplate={summaryTemplate}></IgrColumn>

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

The disabledSummaries property provides precise per-column control over the React Grid summary feature. This property enables users to customize the summaries displayed for each column in the IgrGrid, ensuring that only the most relevant and meaningful data is shown. For example, you can exclude specific summary types, such as ['count', 'min', 'max'] by specifying their summary keys in an 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 IgrGrid a los cambios en los estados de la aplicación o a las acciones del usuario.

The following examples illustrate how to use the disabledSummaries property to manage summaries for different columns and exclude specific default and custom summary types in the React Grid:

<!-- Disable default summaries -->
<IgrColumn
    field="UnitPrice"
    header="Unit Price"
    dataType="number"
    hasSummary={true}
    disabledSummaries={['count', 'sum', 'average']}
/>

<!-- Disable custom summaries -->
<IgrColumn
    field="UnitsInStock"
    header="Units In Stock"
    dataType="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.

Formatting summaries

Por defecto, los resultados resumen, producidos por los operandos de resumen integrados, se localizan y formatean según la cuadrículalocale y la columnapipeArgs. Al usar operandos personalizados, loslocale ypipeArgs no se aplican. Si quieres cambiar la apariencia predeterminada de los resultados resumen, puedes formatearlos usando lasummaryFormatter propiedad.

const summaryFormatter = (summary: IgrSummaryResult, summaryOperand: IgrSummaryOperand): string => {
    const result = summary.summaryResult;
    if (summary.key !== "count" && result !== null && result !== undefined) {
      const format = new Intl.DateTimeFormat("en", { year: "numeric" });
      return format.format(new Date(result));
    }
    return result;
  }

<IgrColumn hasSummary={true} summaryFormatter={summaryFormatter}></IgrColumn>

Summaries with Group By

Cuando has agrupado por columnas, teIgrGrid permite cambiar la posición del resumen y el modo de cálculo usando lassummaryCalculationMode propiedades ysummaryPosition. Junto con estas dos propiedades, losIgrGrid 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 IgrGrid.

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:

<IgrGrid className="grid">
</IgrGrid>

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

• IgrSummaryOperand
• IgrNumberSummaryOperand
• IgrDateSummaryOperand
• columnGroup
• IgrColumn

Additional Resources

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

• Ignite UI for React Forums
• Ignite UI for React GitHub