Packagecom.esri.bacore.thematicmapping
Classpublic class ValueInfo
InheritanceValueInfo Inheritance Object

The ValueInfo class encapsulates a numeric value and additional attributes required for formatting this value to a string.



Public Properties
 PropertyDefined By
  format : ValueFormat
[read-only] Value format.
ValueInfo
  value : Number
[read-only] A numeric value.
ValueInfo
Public Methods
 MethodDefined By
  
ValueInfo(value:Number, decimalsOrFormat:Object, valueType:BAValueType = null, formatter:IValueFormatter = null)
Creates a new instance of the ValueInfo class.
ValueInfo
  
toString():String
Converts the encapsulated value to a string representation with the required number of digits after the decimal point.
ValueInfo
Property Detail
formatproperty
format:ValueFormat  [read-only]

Value format.


Implementation
    public function get format():ValueFormat
valueproperty 
value:Number  [read-only]

A numeric value.


Implementation
    public function get value():Number
Constructor Detail
ValueInfo()Constructor
public function ValueInfo(value:Number, decimalsOrFormat:Object, valueType:BAValueType = null, formatter:IValueFormatter = null)

Creates a new instance of the ValueInfo class.

A new instance can be created in two ways: specifying 2 parameters (value and value format) or specifying 4 parameters (value, decimals, value type, and formatter). The full constructor creates a value format with formatWithUnits=true mode.

Parameters
value:Number — Numeric value.
 
decimalsOrFormat:Object — The number of significant digits after the decimal point (negative value means unknown number of digits) or an instance of the ValueFormat class.
 
valueType:BAValueType (default = null) — The type of value to be formatted. This parameter is used in the full constructor.
 
formatter:IValueFormatter (default = null) — Formatter to be used to format the value. This parameter is used in the full constructor.
Method Detail
toString()method
public function toString():String

Converts the encapsulated value to a string representation with the required number of digits after the decimal point.

Returns
String — String representation of the value.