SummaryState Plugin Reference

A plugin that provides items for total, group, and tree summaries.

Import

Use the following statement to import the plugin:

import { SummaryState } from '@devexpress/dx-react-grid';

User Reference

Dependencies

none

Properties

Name Type Default Description
totalItems? Array<SummaryItem>   The total summary items.
groupItems? Array<SummaryItem>   The group summary items.
treeItems? Array<SummaryItem>   The tree summary items.

Interfaces

SummaryItem

Describes the sorting applied to a column.

Field Type Description
columnName string The name of a column associated with the current summary item.
type SummaryType A summary type.

SummaryType

Describes a filter operation. Accepts a built-in operation or custom string.

Type: string

Built-in operations: sum, max, min, avg, count.

Plugin Developer Reference

Imports

none

Exports

Name Plugin Type Description
totalSummaryItems Getter Array<SummaryItem> Total summary items.
groupSummaryItems Getter Array<SummaryItem> Group summary items.
treeSummaryItems Getter Array<SummaryItem> Summary items applied to rows that contain child rows.