React Tree Grid Summaries

The Ignite UI for React Summaries feature in React Tree Grid functions on a per-column level as group footer. React IgrTreeGrid 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 IgrTreeGrid.

React Tree 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

IgrTreeGrid 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. IgrTreeGrid 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:

때문에string 그리고boolean dataType, 다음과 같은 함수가 제공됩니다:

세다

데이터 유형에 대해서는numbercurrencypercent 다음과 같은 함수들이 제공됩니다:

세다
최소
맥스
평균
합집합

데이터 타입의 경우date, 다음과 같은 함수들이 제공됩니다:

세다
가장 빠른
최신

사용 가능한 모든 열 데이터 유형은 공식 열 유형 항목에서 찾을 수 있습니다.

IgrTreeGrid요약은 다음 다음 열별로 활성화됩니다hasSummary property를 참. 각 열의 요약은 열 데이터 유형에 따라 해석된다는 점도 기억하는 것이 중요합니다. 안에IgrTreeGrid 기본 열 데이터 타입은string, 그러니까 원한다면number 또는date 구체적인 요약은 다음과 같이 명시해야 합니다dataType 재산은number 또는date. 요약 값은 그리드에 따라 국지화되어 표시됩니다locale 그리고 기둥pipeArgs.

<IgrTreeGrid autoGenerate={false} height="800px" width="800px">
    <IgrColumn field="ID" header="Order ID">
    </IgrColumn>
    <IgrColumn field="Name" header="Order Product" hasSummary={true}>
    </IgrColumn>
    <IgrColumn field="Units" header="Units" editable={true} dataType="number" hasSummary={true}>
    </IgrColumn>
</IgrTreeGrid>

특정 열이나 열의 목록에 대한 요약을 활성화하거나 비활성화하는 또 다른 방법은 공개enableSummaries 메서드disableSummariesIgrTreeGrid를 사용하는 것입니다.

const enableSummary = () => {
    treeGridRef.current.enableSummaries([
        {fieldName: 'Name'},
        {fieldName: 'Units'}
    ]);
}
const disableSummary = () => {
    treeGridRef.current.disableSummaries(['Units']);
}

<IgrTreeGrid autoGenerate={false} data={ordersTreeData} ref={treeGridRef} primaryKey="ID">
    <IgrColumn field="ID" header="Order ID"></IgrColumn>
    <IgrColumn field="Name" header="Order Product" hasSummary={true}></IgrColumn>
    <IgrColumn field="Units" header="Units" editable={true} dataType="number" hasSummary={true}></IgrColumn>
</IgrTreeGrid>
<button onClick={enableSummary}>Enable Summary</button>
<button onClick={disableSummary}>Disable Summary </button>

Summary Template

summaryTemplate요약 열을 타겟팅하여 요약 열의 결과를 맥락으로 제공합니다.

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>

기본 요약이 정의되면, 요약 영역의 높이는 요약 개수가 가장 많은 열과--ig-size 격자의 위치에 따라 설계되어 계산됩니다. 입력 속성을 사용summaryRowHeight 해 기본값을 덮어쓰세요. 인수로서 숫자 값을 기대하며, 가짜 값을 설정하면 그리드 푸터의 기본 크기 동작이 촉발됩니다.

Disabled Summaries

The disabledSummaries property provides precise per-column control over the React Tree Grid summary feature. This property enables users to customize the summaries displayed for each column in the IgrTreeGrid, 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.

또한 이 속성은 코드를 통해 런타임에 동적으로 수정할 수 있으므로 IgrTreeGrid의 요약을 애플리케이션 상태 또는 사용자 작업 변경에 맞게 조정할 수 있는 유연성을 제공합니다.

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 Tree 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']}
/>

예를 들어UnitPrice, 기본 요약 같은count 것들은 비활성화되어 있고,sumaverage 다른 것들은 좋아min 요와max 활성화된 상태로 남아 있습니다.

For UnitsInStock, custom summaries such as discontinued and totalDiscontinued are excluded using the disabledSummaries property.

런타임에는 이 속성을 사용하여disabledSummaries 요약을 동적으로 비활성화할 수도 있습니다. 예를 들어, 특정 열의 속성을 프로그래밍적으로 설정하거나 업데이트하여 사용자 행동이나 애플리케이션 상태 변화에 따라 표시되는 요약을 조정할 수 있습니다.

Formatting summaries

기본적으로 내장된 요약 연산자에 의해 생성된 요약 결과는 그리드locale와 열pipeArgs에 따라 국지화되고 포맷이 조정됩니다. 커스텀 피연산자를 사용할 때는locale와pipeArgs가 적용되지 않습니다. 요약 결과의 기본 외관을 변경하고 싶다면, 속성summaryFormatter으로 포맷할 수 있습니다.

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>

Child Summaries

The IgrTreeGrid supports separate summaries for the root nodes and for each nested child node level. Which summaries are shown is configurable using the summaryCalculationMode property. The child level summaries can be shown before or after the child nodes using the summaryPosition property. Along with these two properties the IgrTreeGrid exposes and showSummaryOnCollapse property which allows you to determine whether the summary row stays visible when the parent node that refers to is collapsed.

The available values of the summaryCalculationMode property are:

RootLevelOnly - Summaries are calculated only for the root level nodes.
ChildLevelsOnly - Summaries are calculated only for the child levels.
RootAndChildLevels - Summaries are calculated for both root and child levels. This is the default value.

The available values of the summaryPosition property are:

Top - The summary row appears before the list of child rows.
Bottom - The summary row appears after the list of child rows. This is the default value.

The showSummaryOnCollapse property is boolean. Its default value is set to false, which means that the summary row would be hidden when the parent row is collapsed. If the property is set to true the summary row stays visible when parent row is collapsed.

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

요약 행은 다음 키보드 상호 작용을 통해 탐색할 수 있습니다.

UP- 한 셀 위로 이동합니다.
DOWN- 한 셀 아래로 이동합니다.
왼쪽- 한 셀 왼쪽으로 이동합니다.
RIGHT- 한 셀 오른쪽으로 이동합니다.
CTRL + LEFT 또는 HOME- 가장 왼쪽 셀로 이동합니다.
CTRL + RIGHT 또는 END- 가장 오른쪽 셀로 이동합니다.

Styling

사전 정의된 테마 외에도 사용 가능한 CSS 속성 중 일부를 설정하여 그리드를 추가로 사용자 정의할 수 있습니다. 일부 색상을 변경하려면 먼저 그리드에 대한 클래스를 설정해야 합니다.

<IgrTreeGrid className="grid">
</IgrTreeGrid>

그런 다음 해당 클래스에 대한 관련 CSS 속성을 설정합니다.

.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

우리 커뮤니티는 활동적이며 항상 새로운 아이디어를 환영합니다.

React Tree Grid Summaries