mx.charts.chartClasses.DataDescription - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.charts.chartClasses
Class	public class DataDescription
Inheritance	DataDescription 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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		boundedValues : Array An Array of BoundedValue objects describing the data in the element.	DataDescription
		constructor : 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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DataDescription() Constructor.	DataDescription
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined 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.