Packagemx.collections
Classpublic class SummaryRow
InheritanceSummaryRow Inheritance Object

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The SummaryRow class represents a summary row of the AdvancedDataGrid. You create summary data about your data groups by using the summaries property of the GroupingField or GroupingCollection class. You display the summary data in an existing row of the AdvancedDataGrid control, or display it in a separate row.

The summaries property of the GroupingField or GroupingCollection class takes an instance of the SummaryRow class. You then use the fields property of the SummaryRow class to specify an Array of one or more SummaryField/SummaryField2 instances that define the fields of the data used to create the summary. SummaryField2 needs to be used when using GroupingCollection2.

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>

MXML SyntaxexpandedHide MXML Syntax
The <mx.SummaryRow> tag defines the following tag attributes:

  <mx:SummaryRow
  Properties 
    fields="No default"
    summaryObjectFunction="No default"
    summaryPlacement="last"
  />

Default MXML Propertyfields

See also

mx.controls.AdvancedDataGrid
mx.collections.GroupingField
mx.collections.SummaryField
mx.collections.SummaryField2

Public Properties
 PropertyDefined By
  fields : Array
Array of SummaryField/SummaryField2 instances that define the characteristics of the data fields used to create the summary.
SummaryRow
  summaryObjectFunction : Function
Specifies a callback function that defines the summary object, which is an instance of the SummaryObject class.
SummaryRow
  summaryPlacement : String = last
Specifies where the summary row appears in the AdvancedDataGrid control.
SummaryRow
Public Methods
 MethodDefined By
  
SummaryRow()
Constructor.
SummaryRow
Property Detail
fieldsproperty
public var fields:Array

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Array of SummaryField/SummaryField2 instances that define the characteristics of the data fields used to create the summary.

See also

mx.collections.SummaryField
mx.collections.SummaryField2
summaryObjectFunctionproperty 
public var summaryObjectFunction:Function

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Specifies a callback function that defines the summary object, which is an instance of the SummaryObject class. The SummaryObject instance collects summary data for display in the AdvancedDataGrid control. The AdvancedDataGrid control adds the SummaryObject instance to the data provider to display the summary data in the control. Therefore, define within the SummaryObject instance the properties that you want to display.

You use this property with the SummaryField.summaryFunction property, which defines a callback function to perform the summary calculation.

The GroupingCollection class adds a property called children to the Object.

The callback function must have the following signature:

function mySumObjFunc():SummaryObject {}

See also

mx.collections.SummaryObject
mx.collections.SummaryField.summaryFunction
summaryPlacementproperty 
public var summaryPlacement:String = last

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Specifies where the summary row appears in the AdvancedDataGrid control. Possible values are:

You can specify multiple values, separated by a space. For example, a value of "last group" shows the same summary row at the group level and in the last row of the children.

Constructor Detail
SummaryRow()Constructor
public function SummaryRow()

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Constructor.




The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00