| Package | com.esri.bacore.thematicmapping |
| Class | public class TMSummarizations |
| Inheritance | TMSummarizations  Summarizations Object |
See also
| Property | Defined By | ||
|---|---|---|---|
| averageValueDecimals : int Deprecated Since Business Analyst API for Flex 3.0: Please Use formatting.averageValueDecimals
The number of significant digits after the decimal point for average value. | TMSummarizations | ||
 | count : uint [read-only]
Number of summarization variables. | Summarizations | |
| formatting : ThematicValueFormatting
Thematic value formatting properties. | TMSummarizations | ||
| indexValueDecimals : int Deprecated Since Business Analyst API for Flex 3.0: Please Use formatting.indexValueDecimals
The number of significant digits after the decimal point for index value. | TMSummarizations | ||
| percentValueDecimals : int Deprecated Since Business Analyst API for Flex 3.0: Please Use formatting.percentValueDecimals
The number of significant digits after the decimal point for percent value. | TMSummarizations | ||
| useGivenSummarizationsOnly : Boolean
True value means that available value calculation types for a value calculator
are restricted to the summarization variables of this collection. | TMSummarizations | ||
| valueFormatter : IValueFormatter Deprecated Since Business Analyst API for Flex 3.0: Please Use formatting.valueFormatter
Formatter to be used for formatting values. | TMSummarizations | ||
| Method | Defined By | ||
|---|---|---|---|
TMSummarizations(summarizations:Array)
Creates a new instance of the TMSummarizations class. | TMSummarizations | ||
createValueCalculator(name:String):ThematicValueCalculator
Creates a new value calculator for the given summarization variable. | TMSummarizations | ||
| getSummarizationByIndex(index:int):SummarizationInfo
Gets summarization variable metadata by variable index. | Summarizations | |
| getSummarizationByName(name:String):SummarizationInfo
Gets summarization variable metadata by variable name. | Summarizations | |
| averageValueDecimals | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesaverageValueDecimals:intThe number of significant digits after the decimal point for average value.
public function get averageValueDecimals():int public function set averageValueDecimals(value:int):void| formatting | property |
formatting:ThematicValueFormatting| Since : | Business Analyst API for Flex 3.0. |
Thematic value formatting properties.
public function get formatting():ThematicValueFormatting public function set formatting(value:ThematicValueFormatting):void| indexValueDecimals | property |
indexValueDecimals:intThe number of significant digits after the decimal point for index value.
The default value is 0.
public function get indexValueDecimals():int public function set indexValueDecimals(value:int):void| percentValueDecimals | property |
percentValueDecimals:intThe number of significant digits after the decimal point for percent value.
public function get percentValueDecimals():int public function set percentValueDecimals(value:int):void| useGivenSummarizationsOnly | property |
useGivenSummarizationsOnly:BooleanTrue value means that available value calculation types for a value calculator are restricted to the summarization variables of this collection.
The default value is false.
public function get useGivenSummarizationsOnly():Boolean public function set useGivenSummarizationsOnly(value:Boolean):void| valueFormatter | property |
valueFormatter:IValueFormatterFormatter to be used for formatting values.
public function get valueFormatter():IValueFormatter public function set valueFormatter(value:IValueFormatter):void| TMSummarizations | () | Constructor |
public function TMSummarizations(summarizations:Array)Creates a new instance of the TMSummarizations class.
Parameterssummarizations:Array — Array of SummarizationInfo items.
|
| createValueCalculator | () | method |
public function createValueCalculator(name:String):ThematicValueCalculatorCreates a new value calculator for the given summarization variable. In fact, this function creates an instance of the TMValueCalculator class.
Parameters
name:String — Summarization variable name.
|
ThematicValueCalculator — Value calculator.
|
See also