| Package | com.esri.bacore |
| Class | public dynamic class SummarizationInfo |
| Inheritance | SummarizationInfo  Object |
Since Business Analyst API for Flex 3.0, all the properties of this class have been made read-write
except the name property. Additionally, this class has been made dynamic.
See also
| Property | Defined By | ||
|---|---|---|---|
| alias : String
Summarization variable alias name. | SummarizationInfo | ||
| avgBase : String
Field name for the denominator that is used to help calculate the average value of this variable
for the total value. | SummarizationInfo | ||
| category : String
Summarization variable category. | SummarizationInfo | ||
| decimals : Number
The number of decimal places after the decimal point for this variable. | SummarizationInfo | ||
| groups : SummarizationTags
Collection of groups this variable belongs to. | SummarizationInfo | ||
| indexBase : Number
Value of this variable for the whole country for the year. | SummarizationInfo | ||
| keywords : SummarizationTags
Keywords collections associated with this variable. | SummarizationInfo | ||
| longDescription : String
User-friendly summarization name. | SummarizationInfo | ||
| name : String [read-only]
Summarization variable name. | SummarizationInfo | ||
| percentage : String
Field name for the denominator that is used to help calculate the percentage for this variable. | SummarizationInfo | ||
| valueType : BAValueType
Type of value of this variable. | SummarizationInfo | ||
| vintage : String
The year or the range of years the variable belongs to. | SummarizationInfo | ||
| Method | Defined By | ||
|---|---|---|---|
SummarizationInfo(name:String, alias:String, category:String, longDescription:String, decimals:Number, percentage:String = null, avgBase:String = null, indexBase:Number, valueType:BAValueType = null, keywords:SummarizationTags = null, groups:SummarizationTags = null, vintage:String = null)
Creates a new instance of the SummarizationInfo class. | SummarizationInfo | ||
| alias | property |
alias:StringSummarization variable alias name.
public function get alias():String public function set alias(value:String):void| avgBase | property |
avgBase:String
Field name for the denominator that is used to help calculate the average value of this variable
for the total value.
The avgBase and percentage properties are mutually exclusive.
public function get avgBase():String public function set avgBase(value:String):void| category | property |
category:StringSummarization variable category.
public function get category():String public function set category(value:String):void| decimals | property |
decimals:NumberThe number of decimal places after the decimal point for this variable. The NaN value for this property means unknown number of decimal places.
public function get decimals():Number public function set decimals(value:Number):void| groups | property |
groups:SummarizationTags| Since : | Business Analyst API for Flex 2.2. |
Collection of groups this variable belongs to.
public function get groups():SummarizationTags public function set groups(value:SummarizationTags):void| indexBase | property |
indexBase:NumberValue of this variable for the whole country for the year. Zero or NaN value for this property means missing index base.
If the avgBase or percentage property specifies a denominator variable, the
indexBase specifies a ratio of this variable with respect to the
denominator variable for the whole country for the year.
public function get indexBase():Number public function set indexBase(value:Number):void| keywords | property |
keywords:SummarizationTags| Since : | Business Analyst API for Flex 2.2. |
Keywords collections associated with this variable.
public function get keywords():SummarizationTags public function set keywords(value:SummarizationTags):void| longDescription | property |
longDescription:StringUser-friendly summarization name.
public function get longDescription():String public function set longDescription(value:String):void| name | property |
name:String [read-only] Summarization variable name.
public function get name():String| percentage | property |
percentage:String
Field name for the denominator that is used to help calculate the percentage for this variable.
The avgBase and percentage properties are mutually exclusive.
public function get percentage():String public function set percentage(value:String):void| valueType | property |
valueType:BAValueTypeType of value of this variable.
public function get valueType():BAValueType public function set valueType(value:BAValueType):void| vintage | property |
vintage:String| Since : | Business Analyst API for Flex 2.2. |
The year or the range of years the variable belongs to.
public function get vintage():String public function set vintage(value:String):void| SummarizationInfo | () | Constructor |
public function SummarizationInfo(name:String, alias:String, category:String, longDescription:String, decimals:Number, percentage:String = null, avgBase:String = null, indexBase:Number, valueType:BAValueType = null, keywords:SummarizationTags = null, groups:SummarizationTags = null, vintage:String = null)Creates a new instance of the SummarizationInfo class.
Parametersname:String — Summarization variable name.
| |
alias:String — Summarization variable alias name. If this parameter is null or empty, the name parameter is assigned.
| |
category:String — Summarization variable category.
| |
longDescription:String — User-friendly summarization name. If this parameter is null or empty, the alias parameter is assigned.
| |
decimals:Number (default = NaN) | |
percentage:String (default = null) | |
avgBase:String (default = null) | |
indexBase:Number (default = NaN) | |
valueType:BAValueType (default = null) | |
keywords:SummarizationTags (default = null) | |
groups:SummarizationTags (default = null) | |
vintage:String (default = null) |