mx.collections

# SummaryField2 - AS3 Flex

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 Show MXML Syntax
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"
      />

More examples

Creating summary rows

Related API Elements

mx.controls.AdvancedDataGrid
mx.collections.GroupingField
mx.collections.SummaryRow

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | 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

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SummaryField2(dataField:String = null, summaryOperation:Object = SUM) Constructor. | SummaryField2
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Property Detail

### dataField

property

`public var dataField:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Data field for which the summary is computed.

### label

property

`public var label:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The property used inside the summary object, an instance of the SummaryObject class, to hold summary information.

For example, if you set the `label` property to "Summary", then the computed summary is placed in a property named "Summary" in the summary object. The property of the SummaryObject instance containing the summary data will appear as below:

    {Summary:1000}

Related API Elements

mx.collections.SummaryObject
mx.collections.SummaryRow.summaryObjectFunction
summaryFunction

### summaryOperation

property

`public var summaryOperation:Object = SUM`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The summary performed on the children. The value of this property can be one of the following:

- For numeric fields: `SUM`, `MIN`, `MAX`, `AVG`, or `COUNT`.
- An instance of a class that implements the custom ISummaryCalculator interface to calculate a custom summary.

The default value is `SUM.`

Related API Elements

mx.collections.ISummaryCalculator
Constructor Detail

### SummaryField2

()
Constructor

`public function SummaryField2(dataField:String = null, summaryOperation:Object = SUM)`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Constructor.

Parameters

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

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00