Package | com.esri.bacore |
Class | public final class SummarizationInfo |
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 total households.
| SummarizationInfo | ||
category : String
Summarization variable category.
| SummarizationInfo | ||
decimals : Number
The number of decimal places after the decimal point for this variable.
| SummarizationInfo | ||
indexBase : Number
Value of this variable for the whole US for the year.
| SummarizationInfo | ||
longDescription : String
User-friendly summarization name.
| SummarizationInfo | ||
name : String
Summarization variable name.
| SummarizationInfo | ||
percentage : String
Field name for the denominator that is used to help calculate the percentage for this variable.
| SummarizationInfo |
Method | Defined by | ||
---|---|---|---|
SummarizationInfo(name:String = null, alias:String = null, category:String = null, longDescription:String = null, decimals:Number = 0, percentage:String = null, avgBase:String = null, indexBase:Number = 0)
Creates a new instance of the SummarizationInfo object.
| SummarizationInfo |
alias | property |
alias:String
[read-write]Summarization variable alias name.
Implementation public function get alias():String
public function set alias(value:String):void
avgBase | property |
avgBase:String
[read-write]Field name for the denominator that is used to help calculate the average value of this variable for total households. This property is used in Business Analyst Online API.
Implementation public function get avgBase():String
public function set avgBase(value:String):void
category | property |
category:String
[read-write]Summarization variable category.
Implementation public function get category():String
public function set category(value:String):void
decimals | property |
decimals:Number
[read-write]The number of decimal places after the decimal point for this variable. This property is used in Business Analyst Online API.
Implementation public function get decimals():Number
public function set decimals(value:Number):void
indexBase | property |
indexBase:Number
[read-write]Value of this variable for the whole US for the year. This property is used in Business Analyst Online API.
Implementation public function get indexBase():Number
public function set indexBase(value:Number):void
longDescription | property |
longDescription:String
[read-write]User-friendly summarization name.
Implementation public function get longDescription():String
public function set longDescription(value:String):void
name | property |
name:String
[read-write]Summarization variable name.
Implementation public function get name():String
public function set name(value:String):void
percentage | property |
percentage:String
[read-write]Field name for the denominator that is used to help calculate the percentage for this variable. This property is used in Business Analyst Online API.
Implementation public function get percentage():String
public function set percentage(value:String):void
SummarizationInfo | () | constructor |
public function SummarizationInfo(name:String = null, alias:String = null, category:String = null, longDescription:String = null, decimals:Number = 0, percentage:String = null, avgBase:String = null, indexBase:Number = 0)
Creates a new instance of the SummarizationInfo object.
Parametersname:String (default = null ) — Summarization variable name.
|
|
alias:String (default = null ) — Summarization variable alias name.
|
|
category:String (default = null ) — Summarization variable category.
|
|
longDescription:String (default = null ) — User-friendly summarization name.
|
|
decimals:Number (default = 0 ) — The number of decimal places after the decimal point for this variable.
|
|
percentage:String (default = null ) — Field name for the denominator that is used to help calculate the percentage for this variable.
|
|
avgBase:String (default = null ) — Field name for the denominator that is used to help calculate the average value of this variable
for total households.
|
|
indexBase:Number (default = 0 ) — Value of this variable for the whole US for the year.
|