| Package | mx.charts |
| Class | public class HitData |
| Inheritance | HitData  Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
You can also get a HitData structure describing the data point
at a specific location in the chart using the chart control's
findDataPoints() method.
More examples
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| chartItem : ChartItem
The chart item described by the hit data. | HitData | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contextColor : uint = 0
An RGB value that can be used to associate an on-screen
representation of the associated chartItem. | HitData | ||
| dataTipFunction : Function
A function provided by the HitData creator
to generate a user-suitable String for display on screen
that describes the referenced item. | HitData | ||
| displayText : String [read-only]
A description of the associated item for display on screen. | HitData | ||
| distance : Number
Specifies the distance between the data item on the screen
and the location of the mouse pointer, in pixels. | HitData | ||
| element : IChartElement [read-only]
Specifies the chart element rendering this data item
that generated the HitData structure. | HitData | ||
| id : Number
Specifies a unique identifier representing the data point. | HitData | ||
| item : Object
Specifies the data item that the HitData structure describes. | HitData | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| x : Number
Specifies the X coordinate of the data item on the screen. | HitData | ||
| y : Number
Specifies the Y coordinate of the data item on the screen. | HitData | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | HitData | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
chartItem | property |
public var chartItem:ChartItem| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The chart item described by the hit data.
A chart item represents the data a series uses
to describe an individual item from its dataProvider.
contextColor | property |
public var contextColor:uint = 0| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An RGB value that can be used to associate an on-screen
representation of the associated chartItem.
DataTips use this field to help render their data.
dataTipFunction | property |
public var dataTipFunction:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A function provided by the HitData creator to generate a user-suitable String for display on screen that describes the referenced item.
displayText | property |
distance | property |
public var distance:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies the distance between the data item on the screen and the location of the mouse pointer, in pixels.
element | property |
element:IChartElement [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies the chart element rendering this data item that generated the HitData structure.
Implementation
public function get element():IChartElementid | property |
public var id:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies a unique identifier representing the data point.
You can use this identifier to test for equality
between two HitData objects.
If two different chart elements represent the same dataProvider entry,
they will have two different identifiers.
item | property |
public var item:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies the data item that the HitData structure describes.
x | property |
public var x:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies the X coordinate of the data item on the screen.
y | property |
public var y:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies the Y coordinate of the data item on the screen.
HitData | () | Constructor |
public function HitData(id:Number, distance:Number, x:Number, y:Number, chartItem:ChartItem)| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Parametersid:Number — Specifies a unique identifier representing the data point.
| |
distance:Number — Specifies the distance between the data item
on the screen and the location of the mouse pointer, in pixels.
| |
x:Number — Specifies the x coordinate of the data item on the screen.
| |
y:Number — Specifies the y coordinate of the data item on the screen.
| |
chartItem:ChartItem — The chart item described by the hit data.
|
Mon Nov 28 2011, 06:48 AM -08:00