| Package | com.esri.bacore.thematicmapping |
| Class | public class TMSummarizations |
| Inheritance | TMSummarizations  Object |
See also
| Property | Defined By | ||
|---|---|---|---|
| averageValueDecimals : int
The number of significant digits after the decimal point for average value. | TMSummarizations | ||
| count : uint [read-only]
Number of summarization variables. | TMSummarizations | ||
| indexValueDecimals : int
The number of significant digits after the decimal point for index value. | TMSummarizations | ||
| percentValueDecimals : int
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 given summarization fields. | TMSummarizations | ||
| valueFormatter : IValueFormatter
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):TMValueCalculator
Creates a new value calculator for the given summarization variable. | TMSummarizations | ||
getSummarizationByIndex(index:int):SummarizationInfo
Gets summarization variable metadata by variable index. | TMSummarizations | ||
getSummarizationByName(name:String):SummarizationInfo
Gets summarization variable metadata by variable name. | TMSummarizations | ||
| averageValueDecimals | property |
averageValueDecimals:intThe number of significant digits after the decimal point for average value.
The default value is 2.
public function get averageValueDecimals():int public function set averageValueDecimals(value:int):void| count | property |
count:uint [read-only] Number of summarization variables.
public function get count():uint| 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.
The default value is 4.
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 given summarization fields.
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. If the formatter doesn't specified, the default formatting will be provided using the class.
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):TMValueCalculatorCreates a new value calculator for the given summarization variable.
Parameters
name:String — Summarization variable name.
|
TMValueCalculator — Value calculator.
|
| getSummarizationByIndex | () | method |
public function getSummarizationByIndex(index:int):SummarizationInfoGets summarization variable metadata by variable index.
Parameters
index:int — Zero-based index of the variable.
|
SummarizationInfo — Summarization variable metadata.
|
| getSummarizationByName | () | method |
public function getSummarizationByName(name:String):SummarizationInfoGets summarization variable metadata by variable name.
Parameters
name:String — Summarization variable name.
|
SummarizationInfo — Summarization variable metadata or null if a summarization with the given
name is absent in the list of available summarizations.
|