| Package | com.esri.bacore |
| Class | public class SummarizationInfo |
| Inheritance | SummarizationInfo  Object |
See also
| Property | Defined By | ||
|---|---|---|---|
| alias : String [read-only]
Summarization variable alias name. | SummarizationInfo | ||
| avgBase : String [read-only]
Field name for the denominator that is used to help calculate the average value of this variable
for the total value. | SummarizationInfo | ||
| category : String [read-only]
Summarization variable category. | SummarizationInfo | ||
| decimals : Number [read-only]
The number of decimal places after the decimal point for this variable. | SummarizationInfo | ||
| groups : SummarizationTags [read-only]
Collection of groups this variable belongs to. | SummarizationInfo | ||
| indexBase : Number [read-only]
Value of this variable for the whole country for the year. | SummarizationInfo | ||
| keywords : SummarizationTags [read-only]
Keywords collections associated with this variable. | SummarizationInfo | ||
| longDescription : String [read-only]
User-friendly summarization name. | SummarizationInfo | ||
| name : String [read-only]
Summarization variable name. | SummarizationInfo | ||
| percentage : String [read-only]
Field name for the denominator that is used to help calculate the percentage for this variable. | SummarizationInfo | ||
| valueType : BAValueType [read-only]
Type of value of this variable. | SummarizationInfo | ||
| vintage : String [read-only]
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:String [read-only] Summarization variable alias name.
public function get alias():String| avgBase | property |
avgBase:String [read-only]
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| category | property |
category:String [read-only] Summarization variable category.
public function get category():String| decimals | property |
decimals:Number [read-only] The 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| groups | property |
groups:SummarizationTags [read-only] | Since : | Community Analyst API for Flex 2.2. |
Collection of groups this variable belongs to.
public function get groups():SummarizationTags| indexBase | property |
indexBase:Number [read-only] Value 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| keywords | property |
keywords:SummarizationTags [read-only] | Since : | Community Analyst API for Flex 2.2. |
Keywords collections associated with this variable.
public function get keywords():SummarizationTags| longDescription | property |
longDescription:String [read-only] User-friendly summarization name.
public function get longDescription():String| name | property |
name:String [read-only] Summarization variable name.
public function get name():String| percentage | property |
percentage:String [read-only]
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| valueType | property |
valueType:BAValueType [read-only] Type of value of this variable.
public function get valueType():BAValueType| vintage | property |
vintage:String [read-only] | Since : | Community Analyst API for Flex 2.2. |
The year or the range of years the variable belongs to.
public function get vintage():String| 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) |