mx.collections.SummaryField2

Package	mx.collections
Class	public class SummaryField2
Inheritance	SummaryField2 Object

Language Version :

ActionScript 3.0

Product Version :

Flex 4

Runtime Versions :

Flash Player 10, AIR 1.5

The SummaryField2 class represents a single property in a SummaryRow instance. Each SummaryRow instance specifies one or more SummayField2 instances that are used to create a data summary.

Note: In the previous release of Flex, you used the SummaryField class to create summary data. The SummaryField2 class is new for Flex 4 and provides better performance than SummaryField.

Use the dataField property to specify the data field used to generate the summary, the label property to specify the name of the data field created to hold the summary data, and the summaryOperation property to specify how to create the summary for numeric fields. You can specify one of the following values: SUM, MIN, MAX, AVG, or COUNT.

Or you can specify an ISummaryCalculator implementation to calculate the summaries.

The following example creates summary rows based on two fields of the data provider of the AdvancedDataGrid control:

  <mx:AdvancedDataGrid id="myADG" 
    initialize="gc.refresh();"> 
    <mx:dataProvider>
      <mx:GroupingCollection id="gc" source="{dpFlat}">
        <mx:Grouping>
          <mx:GroupingField name="Region">
            <mx:summaries>
              <mx:SummaryRow summaryPlacement="group">
                <mx:fields>
                  <mx:SummaryField2 dataField="Actual" 
                    label="Min Actual" summaryOperation="MIN"/>
                  <mx:SummaryField2 dataField="Actual" 
                    label="Max Actual" summaryOperation="MAX"/>
                </mx:fields>
              </mx:SummaryRow>
            </mx:summaries>
          </mx:GroupingField>
          <mx:GroupingField name="Territory">
            <mx:summaries>
              <mx:SummaryRow summaryPlacement="group">
                <mx:fields>
                  <mx:SummaryField2 dataField="Actual" 
                    label="Min Actual" summaryOperation="MIN"/>
                  <mx:SummaryField2 dataField="Actual" 
                    label="Max Actual" summaryOperation="MAX"/>
                </mx:fields>
              </mx:SummaryRow>
            </mx:summaries>
          </mx:GroupingField>
        </mx:Grouping>
      </mx:GroupingCollection>
    </mx:dataProvider> 
 
    <mx:columns>
      <mx:AdvancedDataGridColumn dataField="Region"/>
      <mx:AdvancedDataGridColumn dataField="Territory_Rep"
        headerText="Territory Rep"/>
      <mx:AdvancedDataGridColumn dataField="Actual"/>
      <mx:AdvancedDataGridColumn dataField="Estimate"/>
      <mx:AdvancedDataGridColumn dataField="Min Actual"/>
      <mx:AdvancedDataGridColumn dataField="Max Actual"/>
    </mx:columns>
  </mx:AdvancedDataGrid>

MXML Syntax expanded

Hide MXML Syntax

The <mx.SummaryField2> inherits all the tag attributes of its superclass, and defines the following tag attributes:

  <mx:SummaryField2
  Properties 
    dataField="No default"
    label="No default"
    summaryOperation="SUM"
  />

Apache Flex 4.16.1 API Reference	All Packages \| All Classes \| Index \| Frames No Frames
SummaryField2	Properties \| Methods

	Property		Defined By
		dataField : String Data field for which the summary is computed.	SummaryField2
		label : String The property used inside the summary object, an instance of the SummaryObject class, to hold summary information.	SummaryField2
		summaryOperation : Object = SUM The summary performed on the children.	SummaryField2

	`dataField:String` (default = `null`) — Data field for which the summary is computed.

	`summaryOperation:Object` (default = `SUM`) — The function that should be performed on the children. You can specify one of the following values for numeric fields: `SUM`, `MIN`, `MAX`, `AVG`, or `COUNT`. Or you can specify an ISummaryCalculator implementation to calculate the summaries.