| Package | com.esri.bacore.thematicmapping |
| Class | public class TMAttributesProvider |
| Inheritance | TMAttributesProvider  Object |
| Property | Defined By | ||
|---|---|---|---|
| actualValueCalculator : ValueCalculator [read-only]
Value calculator actually used in calculation of thematic mapping values. | TMAttributesProvider | ||
| layer : TMLayer [read-only]
Owner layer of this provider. | TMAttributesProvider | ||
| Method | Defined By | ||
|---|---|---|---|
TMAttributesProvider(layer:TMLayer, actualCalculator:ValueCalculator, idField:String, nameField:String)
Creates a new instance of the TMAttributesProvider class. | TMAttributesProvider | ||
calculateTMValue(attributes:Object):Number
Calculates thematic mapping value using the actual value calculator. | TMAttributesProvider | ||
createDescription(attributes:Object, descriptionStyle:ValueDescriptionStyle):Object
Creates fields describing value calculation properties. | TMAttributesProvider | ||
createDescriptionFields(attributes:Object, descriptionStyle:ValueDescriptionStyle):Array
Creates a list of fields describing value calculation properties. | TMAttributesProvider | ||
createTMValueFormat(formatWithUnits:Boolean):ValueFormat
Creates a format for formatting the thematic value. | TMAttributesProvider | ||
getFeatureID(attributes:Object):String
Gets the feature ID. | TMAttributesProvider | ||
getFeatureName(attributes:Object):String
Gets the feature name. | TMAttributesProvider | ||
getNumber(attributes:Object, name:String):Number
Gets the given feature attribute as a number. | TMAttributesProvider | ||
getTMValue(attributes:Object):Number
Gets the thematic mapping value. | TMAttributesProvider | ||
getValue(attributes:Object, name:String, defaultValue:*, nullValue:* = null):*
Gets the given feature attribute. | TMAttributesProvider | ||
| actualValueCalculator | property |
actualValueCalculator:ValueCalculator [read-only] Value calculator actually used in calculation of thematic mapping values.
public function get actualValueCalculator():ValueCalculator| layer | property |
layer:TMLayer [read-only] Owner layer of this provider.
public function get layer():TMLayer| TMAttributesProvider | () | Constructor |
public function TMAttributesProvider(layer:TMLayer, actualCalculator:ValueCalculator, idField:String, nameField:String)Creates a new instance of the TMAttributesProvider class.
The nameField parameter is optional. If it is null or empty, the idField
parameter value is used as a name field.
layer:TMLayer — Owner layer of this provider.
| |
actualCalculator:ValueCalculator — Name of field representing a feature ID.
| |
idField:String — Name of field representing a feature name (optional, can be null).
| |
nameField:String |
| calculateTMValue | () | method |
public function calculateTMValue(attributes:Object):NumberCalculates thematic mapping value using the actual value calculator. If the value calculator is missing, NaN is returned.
Parameters
attributes:Object — Attributes of a graphic feature.
|
Number — Thematic mapping value.
|
| createDescription | () | method |
public function createDescription(attributes:Object, descriptionStyle:ValueDescriptionStyle):ObjectCreates fields describing value calculation properties.
Parameters
attributes:Object — A graphic to create description fields for.
| |
descriptionStyle:ValueDescriptionStyle — Value description style.
|
Object — A new object with description fields.
|
| createDescriptionFields | () | method |
public function createDescriptionFields(attributes:Object, descriptionStyle:ValueDescriptionStyle):ArrayCreates a list of fields describing value calculation properties.
Parameters
attributes:Object — Attributes of feature to get values from.
| |
descriptionStyle:ValueDescriptionStyle — Value description style.
|
Array — An array of feature description fields containing KeyValuePair items.
|
See also
| createTMValueFormat | () | method |
public function createTMValueFormat(formatWithUnits:Boolean):ValueFormatCreates a format for formatting the thematic value.
Parameters
formatWithUnits:Boolean — True value means formatting with units.
|
ValueFormat — A new value format.
|
| getFeatureID | () | method |
public function getFeatureID(attributes:Object):StringGets the feature ID.
Parameters
attributes:Object — Attributes of a graphic feature.
|
String — Feature ID or an empty string if the feature ID attribute is missing.
|
| getFeatureName | () | method |
public function getFeatureName(attributes:Object):StringGets the feature name.
Parameters
attributes:Object — Attributes of a graphic feature.
|
String — Feature name or an empty string if the feature name attribute is missing.
|
| getNumber | () | method |
public function getNumber(attributes:Object, name:String):NumberGets the given feature attribute as a number.
If the attribute value is missing, it is converted to zero or NaN depending on
the value of showMissingValuesAsZeroes property of an associated thematic layer.
If the attribute value is null (this is the special case of supressions in data),
the NaN value is returned.
Parameters
attributes:Object — Attributes of a graphic feature.
| |
name:String — Name of requested attribute field.
|
Number — Value of the attribute.
|
| getTMValue | () | method |
public function getTMValue(attributes:Object):NumberGets the thematic mapping value.
Parameters
attributes:Object — Attributes of a graphic feature.
|
Number — Thematic mapping value or NaN if thematic mapping value is missing.
|
| getValue | () | method |
public function getValue(attributes:Object, name:String, defaultValue:*, nullValue:* = null):*Gets the given feature attribute.
Parameters
attributes:Object — Attributes of a graphic feature.
| |
name:String — Name of requested attribute field.
| |
defaultValue:* — Default value to be returned if the attribute is missing.
| |
nullValue:* (default = null) |
* — Value of the attribute or the default value.
|