Packagecom.flexicious.components.tinycharts.valueobjects
Classpublic class HitData
InheritanceHitData Inheritance Object
Implements ILegendItem, flash.events.IEventDispatcher

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

The HitData class represents information about the data item at a specific location on the screen. Flex returns the HitData structure for mouse events on chart data points. It describes what data points are under the current mouse position.


Public Properties
 PropertyDefined By
  chartItem : ChartItem
The chart item described by the hit data.
HitData
  distance : Number
Specifies the distance between the data item on the screen and the location of the mouse pointer, in pixels.
HitData
  id : Number
Specifies a unique identifier representing the data point.
HitData
  item : Object
Specifies the data item that the HitData structure describes.
HitData
  series : Series
[read-only] Specifies the series rendering this data item that generated the HitData structure.
HitData
  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
Public Methods
 MethodDefined By
  
HitData(id:Number, distance:Number, x:Number, y:Number, chartItem:ChartItem)
Constructor.
HitData
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
HitData
  
dispatchEvent(event:Event):Boolean
HitData
  
getFillForItem():*
Gets the fill associated with this item for this series.
HitData
  
getFillForLegend():IFill
Gets the fill associated with this item for this series.
HitData
  
getLabelForItem():String
Gets the label associated with this item for this series.
HitData
  
getLabelForLegend():String
Gets the label associated with this item for this series.
HitData
  
hasEventListener(type:String):Boolean
HitData
  
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
HitData
  
willTrigger(type:String):Boolean
HitData
Property Detail
chartItemproperty
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.

This property can be used as the source for data binding.


Implementation
    public function get chartItem():ChartItem
    public function set chartItem(value:ChartItem):void
distanceproperty 
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.

This property can be used as the source for data binding.


Implementation
    public function get distance():Number
    public function set distance(value:Number):void
idproperty 
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.

This property can be used as the source for data binding.


Implementation
    public function get id():Number
    public function set id(value:Number):void
itemproperty 
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.

This property can be used as the source for data binding.


Implementation
    public function get item():Object
    public function set item(value:Object):void
seriesproperty 
series:Series  [read-only]

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

Specifies the series rendering this data item that generated the HitData structure.


Implementation
    public function get series():Series
xproperty 
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.

This property can be used as the source for data binding.


Implementation
    public function get x():Number
    public function set x(value:Number):void
yproperty 
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.

This property can be used as the source for data binding.


Implementation
    public function get y():Number
    public function set y(value:Number):void
Constructor Detail
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.

Parameters
id: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.
Method Detail
addEventListener()method
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
 
weakRef:Boolean (default = false)

dispatchEvent()method 
public function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns
Boolean
getFillForItem()method 
public function getFillForItem():*

Gets the fill associated with this item for this series.

Returns
*
getFillForLegend()method 
public function getFillForLegend():IFill

Gets the fill associated with this item for this series.

Returns
IFill
getLabelForItem()method 
public function getLabelForItem():String

Gets the label associated with this item for this series.

Returns
String
getLabelForLegend()method 
public function getLabelForLegend():String

Gets the label associated with this item for this series.

Returns
String
hasEventListener()method 
public function hasEventListener(type:String):Boolean

Parameters

type:String

Returns
Boolean
removeEventListener()method 
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters

type:String
 
listener:Function
 
useCapture:Boolean (default = false)

willTrigger()method 
public function willTrigger(type:String):Boolean

Parameters

type:String

Returns
Boolean



Copyright 2012 Flexicious LLC. All rights reserved.

Mon Jun 24 2013, 11:00 PM -04:00