Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.charts.chartClasses 
DataDescription 
Packagemx.charts.chartClasses
Classpublic class DataDescription
InheritanceDataDescription Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The DataDescription structure is used by ChartElements to describe the characteristics of the data they represent to Axis objects that auto-generate values from the data represented in the chart. ChartElements displaying data should construct and return DataDescriptions from their describeData() method when invoked.



Public Properties
 PropertyDefined By
  boundedValues : Array
An Array of BoundedValue objects describing the data in the element.
DataDescription
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  max : Number
The maximum data value displayed by the element.
DataDescription
  min : Number
The minimum data value displayed by the element.
DataDescription
  minInterval : Number
The minimum interval, in data units, between any two values displayed by the element.
DataDescription
  padding : Number
The amount of padding, in data units, that the element requires beyond its min/max values to display its full values correctly .
DataDescription
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined By
  
Constructor.
DataDescription
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  REQUIRED_BOUNDED_VALUES : uint = 0x2
[static] A bitflag passed by the axis to an element's describeData() method.
DataDescription
  REQUIRED_MIN_INTERVAL : uint = 0x1
[static] A bitflag passed by the axis to an element's describeData() method.
DataDescription
  REQUIRED_MIN_MAX : uint = 0x4
[static] A bitflag passed by the axis to an element's describeData() method.
DataDescription
  REQUIRED_PADDING : uint = 0x8
[static] A bitflag passed by the axis to an element's describeData() method.
DataDescription
Property Detail

boundedValues

property
public var boundedValues:Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

An Array of BoundedValue objects describing the data in the element. BoundedValues are data points that have extra space reserved around the datapoint in the chart's data area. If requested, a chart element fills this property with whatever BoundedValues are necessary to ensure enough space is visible in the chart data area. For example, a ColumnSeries that needs 20 pixels above each column to display a data label.

max

property 
public var max:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The maximum data value displayed by the element.

min

property 
public var min:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The minimum data value displayed by the element.

minInterval

property 
public var minInterval:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The minimum interval, in data units, between any two values displayed by the element.

padding

property 
public var padding:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The amount of padding, in data units, that the element requires beyond its min/max values to display its full values correctly .

Constructor Detail

DataDescription

()Constructor
public function DataDescription()

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Constant Detail

REQUIRED_BOUNDED_VALUES

Constant
public static const REQUIRED_BOUNDED_VALUES:uint = 0x2

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

A bitflag passed by the axis to an element's describeData() method. If this flag is set, the element sets the boundedValues property.

REQUIRED_MIN_INTERVAL

Constant 
public static const REQUIRED_MIN_INTERVAL:uint = 0x1

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

A bitflag passed by the axis to an element's describeData() method. If this flag is set, the element sets the minInterval property.

REQUIRED_MIN_MAX

Constant 
public static const REQUIRED_MIN_MAX:uint = 0x4

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

A bitflag passed by the axis to an element's describeData() method. If this flag is set, the element sets the DescribeData.min and DescribeData.max properties.

REQUIRED_PADDING

Constant 
public static const REQUIRED_PADDING:uint = 0x8

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

A bitflag passed by the axis to an element's describeData() method. If this flag is set, the element sets the DescribeData.padding property.