React Grid Summaries

La función Ignite UI for React Summaries en React Grid funciona a nivel de columna como pie de página de grupo. Los resúmenes React IgrGrid 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 implementando una plantilla personalizada en 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

Los resúmenes IgrGrid también se pueden habilitar a nivel de columna en Ignite UI for React, lo que significa que puede activarlos solo para las columnas que necesite. Los resúmenes IgrGrid 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.

Los resúmenes IgrGrid se habilitan por columna estableciendo la propiedad hasSummary en true. También es importante tener en cuenta que los resúmenes de cada columna se resuelven según el tipo de datos de la columna. En IgrGrid el tipo de datos de columna predeterminado es string, por lo que si desea resúmenes específicos number o date, debe especificar la propiedad dataType como number o date. Tenga en cuenta que los valores de resumen se mostrarán localizados, según la locale de la cuadrícula y la columna pipeArgs.

<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 habilitar/deshabilitar resúmenes para una columna específica o una lista de columnas es usar el método público enableSummaries / disableSummaries de IgrGrid.

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

<IgrGrid ref={gridRef} auto-generate="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="false">
    </IgrColumn>
</IgrGrid>
<button onClick={enableSummary}>Enable Summary</button>
<button onClick={disableSummary}>Disable Summary </button>

Summary Template

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

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

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

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.

Formatting summaries

De forma predeterminada, los resultados de resumen, producidos por los operandos de resumen integrados, se localizan y formatean de acuerdo con la locale de la cuadrícula y la columna pipeArgs. Cuando se utilizan operandos personalizados, la locale y pipeArgs no se aplican. Si desea cambiar la apariencia predeterminada de los resultados del resumen, puede formatearlos usando la propiedad summaryFormatter.

public 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={this.summaryFormatter}></IgrColumn>

Summaries with Group By

Cuando haya agrupado por columnas, IgrGrid le permite cambiar la posición del resumen y el modo de cálculo utilizando las propiedades summaryCalculationMode y summaryPosition. Junto con estas dos propiedades, IgrGrid expone la propiedad showSummaryOnCollapse que le permite determinar si la fila de resumen permanece visible cuando la fila del grupo al que hace referencia está colapsada.

Los valores disponibles de la propiedad summaryCalculationMode son:

RootLevelOnly: los resúmenes se calculan solo para el 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 del grupo por filas secundarias.
Bottom: la fila de resumen aparece después del grupo por fila secundaria. Este es el valor predeterminado.

La propiedad showSummaryOnCollapse es booleana. Su valor predeterminado está establecido en false, lo que significa que la fila de resumen se ocultará cuando se contraiga la fila del grupo. Si la propiedad se establece en verdadero, la fila de resumen permanece visible cuando se contrae 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

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

Additional Resources

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

React Grid Summaries