SummaryField  - AS3 Flex

Package	mx.collections
Class	public class SummaryField
Inheritance	SummaryField Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

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 operation 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.

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:SummaryField dataField="Actual" 
                    label="Min Actual" operation="MIN"/>
                  <mx:SummaryField dataField="Actual" 
                    label="Max Actual" operation="MAX"/>
                </mx:fields>
              </mx:SummaryRow>
            </mx:summaries>
          </mx:GroupingField>
          <mx:GroupingField name="Territory">
            <mx:summaries>
              <mx:SummaryRow summaryPlacement="group">
                <mx:fields>
                  <mx:SummaryField dataField="Actual" 
                    label="Min Actual" operation="MIN"/>
                  <mx:SummaryField dataField="Actual" 
                    label="Max Actual" operation="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>
  

This Class has been deprecated and replaced by a new Class SummaryField2. Properties operation and summaryFunction are not present in the Class SummaryField2. A new property summaryOperation is introduced in SummaryField2.

Related API Elements

---

{Summary:1000}

      function mySummaryFunction(iterator:IViewCursor, dataField:String, operation:String):Object