| { "type": "class", | |
| "qname": "mx.collections.SummaryField", | |
| "baseClassname": "" | |
| , | |
| "description": "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. <p>Use the <code>dataField</code> property to specify the data field used to generate the summary, the <code>label</code> property to specify the name of the data field created to hold the summary data, and the <code>operation</code> property to specify how to create the summary for numeric fields. You can specify one of the following values: <code>SUM</code>, <code>MIN</code>, <code>MAX</code>, <code>AVG</code>, or <code>COUNT</code>.</p> <p>The following example creates summary rows based on two fields of the data provider of the AdvancedDataGrid control:</p> <pre>\\n <mx:AdvancedDataGrid id="myADG"\\n initialize="gc.refresh();">\\n <mx:dataProvider>\\n <mx:GroupingCollection id="gc" source="{dpFlat}">\\n <mx:Grouping>\\n <mx:GroupingField name="Region">\\n <mx:summaries>\\n <mx:SummaryRow summaryPlacement="group">\\n <mx:fields>\\n <mx:SummaryField dataField="Actual"\\n label="Min Actual" operation="MIN"/>\\n <mx:SummaryField dataField="Actual"\\n label="Max Actual" operation="MAX"/>\\n </mx:fields>\\n </mx:SummaryRow>\\n </mx:summaries>\\n </mx:GroupingField>\\n <mx:GroupingField name="Territory">\\n <mx:summaries>\\n <mx:SummaryRow summaryPlacement="group">\\n <mx:fields>\\n <mx:SummaryField dataField="Actual"\\n label="Min Actual" operation="MIN"/>\\n <mx:SummaryField dataField="Actual"\\n label="Max Actual" operation="MAX"/>\\n </mx:fields>\\n </mx:SummaryRow>\\n </mx:summaries>\\n </mx:GroupingField>\\n </mx:Grouping>\\n </mx:GroupingCollection>\\n </mx:dataProvider>\\n \\n <mx:columns>\\n <mx:AdvancedDataGridColumn dataField="Region"/>\\n <mx:AdvancedDataGridColumn dataField="Territory_Rep"\\n headerText="Territory Rep"/>\\n <mx:AdvancedDataGridColumn dataField="Actual"/>\\n <mx:AdvancedDataGridColumn dataField="Estimate"/>\\n <mx:AdvancedDataGridColumn dataField="Min Actual"/>\\n <mx:AdvancedDataGridColumn dataField="Max Actual"/>\\n </mx:columns>\\n </mx:AdvancedDataGrid>\\n </pre> <p>This Class has been deprecated and replaced by a new Class <code>SummaryField2</code>. Properties <code>operation</code> and <code>summaryFunction</code> are not present in the Class <code>SummaryField2</code>. A new property <code>summaryOperation</code> is introduced in <code>SummaryField2</code>.</p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["mx.controls.AdvancedDataGrid", "mx.collections.GroupingField", "mx.collections.SummaryRow"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]}, | |
| { "tagName": "royalesuppresspublicvarwarning", | |
| "values": []} ], | |
| "members": [ | |
| { "type": "method", | |
| "qname": "mx.collections.SummaryField", | |
| "namespace": "", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Constructor. You can specify one of the following values for numeric fields: <code>SUM</code>, <code>MIN</code>, <code>MAX</code>, <code>AVG</code>, or <code>COUNT</code>.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["dataField Data field for which the summary is computed.", "operation The function that should be performed on the children."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "", | |
| "params": [{ "name": "dataField", "type": "String"}, | |
| { "name": "operation", "type": "String"}]} | |
| , | |
| { "type": "field", | |
| "qname": "dataField", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Data field for which the summary is computed.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "label", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The property used inside the summary object, an instance of the SummaryObject class, to hold summary information. <p>For example, if you set the <code>label</code> 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:</p> <pre>{Summary:1000}</pre>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["mx.collections.SummaryObject", "mx.collections.SummaryRow#summaryObjectFunction", "#summaryFunction"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "operation", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The function that should be performed on the children. You can specify one of the following values for numeric fields: <code>SUM</code>, <code>MIN</code>, <code>MAX</code>, <code>AVG</code>, or <code>COUNT</code>.", | |
| "tags": [ | |
| { "tagName": "default", | |
| "values": ["SUM"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "field", | |
| "qname": "summaryFunction", | |
| "return": "Function", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Specifies a callback function to compute a custom data summary. <p>You use this property with the <code>SummaryRow.summaryObjectFunction</code> property, which defines an instance of the SummaryObject class used to collect summary data for display in the AdvancedDataGrid control.</p> <p>The function signature should be as follows:</p> <pre>\\n function mySummaryFunction(iterator:IViewCursor, dataField:String, operation:String):Object</pre> <p>The built-in summary functions for <code>SUM</code>, <code>MIN</code>, <code>MAX</code>, <code>AVG</code>, and <code>COUNT</code> all return a Number containing the summary data. </p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["mx.collections.SummaryObject", "mx.collections.SummaryRow#summaryObjectFunction"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}] | |
| } |