(Adobe® Flex™ Charting components only)
Packagemx.charts.events
Classpublic class ChartItemEvent
InheritanceChartItemEvent Inheritance MouseEvent Inheritance Event Inheritance Object

The ChartItemEvent class represents events that are specific to the chart components, such as when a chart item is clicked.

See also

Handling user interactions with charts
Using the HitData object

Public Properties
 PropertyDefined by
 InheritedaltKey : Boolean
Reserved for future use.
MouseEvent
 Inheritedbubbles : Boolean
Indicates whether an event is a bubbling event.
Event
 InheritedbuttonDown : Boolean
Indicates whether the primary mouse button is pressed (true) or not (false).
MouseEvent
 Inheritedcancelable : Boolean
Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedctrlKey : Boolean
Indicates whether the Control key is active (true) or inactive (false).
MouseEvent
 InheritedcurrentTarget : Object
The object that is actively processing the Event object with an event listener.
Event
 Inheriteddelta : int
Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel.
MouseEvent
 InheritedeventPhase : uint
The current phase in the event flow.
Event
  hitData : HitData
[read-only] The first item in the hitSet array.
ChartItemEvent
  hitSet : Array
A set of HitData structures describing the chart items that triggered the event.
ChartItemEvent
 InheritedlocalX : Number
The horizontal coordinate at which the event occurred relative to the containing sprite.
MouseEvent
 InheritedlocalY : Number
The vertical coordinate at which the event occurred relative to the containing sprite.
MouseEvent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrelatedObject : InteractiveObject
A reference to a display list object that is related to the event.
MouseEvent
 InheritedshiftKey : Boolean
Indicates whether the Shift key is active (true) or inactive (false).
MouseEvent
 InheritedstageX : Number
The horizontal coordinate at which the event occurred in global Stage coordinates.
MouseEvent
 InheritedstageY : Number
The vertical coordinate at which the event occurred in global Stage coordinates.
MouseEvent
 Inheritedtarget : Object
The event target.
Event
 Inheritedtype : String
The type of event.
Event
Public Methods
 MethodDefined by
  
ChartItemEvent(type:String, hitSet:Array, triggerEvent:MouseEvent, target:ChartBase)
Constructor.
ChartItemEvent
 Inherited
clone():Event
Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.
MouseEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in your custom Event class.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether preventDefault() has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toString():String
Returns a string that contains all the properties of the MouseEvent object.
MouseEvent
 Inherited
updateAfterEvent():void
Instructs Flash Player to render after processing of this event completes, if the display list has been modified.
MouseEvent
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change event object.
Event
 InheritedCLICK : String = "click"
[static] Defines the value of the type property of a click event object.
MouseEvent
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
 InheritedDOUBLE_CLICK : String = "doubleClick"
[static] Defines the value of the type property of a doubleClick event object.
MouseEvent
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
  ITEM_CLICK : String = "itemClick"
[static] Event type constant; indicates that the user clicked the mouse button over a chart item representing data in the chart.
ChartItemEvent
  ITEM_DOUBLE_CLICK : String = "itemDoubleClick"
[static] Event type constant; indicates that the user double-clicked the mouse button over a chart item representing data in the chart.
ChartItemEvent
  ITEM_MOUSE_DOWN : String = "itemMouseDown"
[static] Event type constant; indicates that the user pressed the mouse button over a chart item representing data in the chart.
ChartItemEvent
  ITEM_MOUSE_MOVE : String = "itemMouseMove"
[static] Event type constant; indicates that the user moved the mouse pointer while hovering over a chart item representing data in the chart.
ChartItemEvent
  ITEM_MOUSE_UP : String = "itemMouseUp"
[static] Event type constant; indicates that the user released the mouse button while over a chart item representing data in the chart.
ChartItemEvent
  ITEM_ROLL_OUT : String = "itemRollOut"
[static] Event type constant; indicates that the user rolled the mouse pointer away from a chart item representing data in the chart.
ChartItemEvent
  ITEM_ROLL_OVER : String = "itemRollOver"
[static] Event type constant; indicates that the user rolled the mouse pointer over a chart item representing data in the chart.
ChartItemEvent
 InheritedMOUSE_DOWN : String = "mouseDown"
[static] Defines the value of the type property of a mouseDown event object.
MouseEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedMOUSE_MOVE : String = "mouseMove"
[static] Defines the value of the type property of a mouseMove event object.
MouseEvent
 InheritedMOUSE_OUT : String = "mouseOut"
[static] Defines the value of the type property of a mouseOut event object.
MouseEvent
 InheritedMOUSE_OVER : String = "mouseOver"
[static] Defines the value of the type property of a mouseOver event object.
MouseEvent
 InheritedMOUSE_UP : String = "mouseUp"
[static] Defines the value of the type property of a mouseUp event object.
MouseEvent
 InheritedMOUSE_WHEEL : String = "mouseWheel"
[static] Defines the value of the type property of a mouseWheel event object.
MouseEvent
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedROLL_OUT : String = "rollOut"
[static] Defines the value of the type property of a rollOut event object.
MouseEvent
 InheritedROLL_OVER : String = "rollOver"
[static] Defines the value of the type property of a rollOver event object.
MouseEvent
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property detail
hitDataproperty
hitData:HitData  [read-only]

The first item in the hitSet array. This is a convenience function for developers who don't care about events corresponding to multiple items.

Implementation
    public function get hitData():HitData
hitSetproperty 
public var hitSet:Array

A set of HitData structures describing the chart items that triggered the event. This array is in depth order; the first item in the array is the top-most item, and the last is the deepest.

Constructor detail
ChartItemEvent()constructor
public function ChartItemEvent(type:String, hitSet:Array, triggerEvent:MouseEvent, target:ChartBase)

Constructor.

Parameters
type:String — The type of the event.
 
hitSet:Array — An array of HitData structures describing the ChartItems that triggered the event.
 
triggerEvent:MouseEvent — The MouseEvent that triggered this ChartItemEvent.
 
target:ChartBase — The chart on which the event was triggered.
Constant detail
ITEM_CLICKconstant
public static const ITEM_CLICK:String = "itemClick"

Event type constant; indicates that the user clicked the mouse button over a chart item representing data in the chart.

ITEM_DOUBLE_CLICKconstant 
public static const ITEM_DOUBLE_CLICK:String = "itemDoubleClick"

Event type constant; indicates that the user double-clicked the mouse button over a chart item representing data in the chart.

ITEM_MOUSE_DOWNconstant 
public static const ITEM_MOUSE_DOWN:String = "itemMouseDown"

Event type constant; indicates that the user pressed the mouse button over a chart item representing data in the chart.

ITEM_MOUSE_MOVEconstant 
public static const ITEM_MOUSE_MOVE:String = "itemMouseMove"

Event type constant; indicates that the user moved the mouse pointer while hovering over a chart item representing data in the chart.

ITEM_MOUSE_UPconstant 
public static const ITEM_MOUSE_UP:String = "itemMouseUp"

Event type constant; indicates that the user released the mouse button while over a chart item representing data in the chart.

ITEM_ROLL_OUTconstant 
public static const ITEM_ROLL_OUT:String = "itemRollOut"

Event type constant; indicates that the user rolled the mouse pointer away from a chart item representing data in the chart.

ITEM_ROLL_OVERconstant 
public static const ITEM_ROLL_OVER:String = "itemRollOver"

Event type constant; indicates that the user rolled the mouse pointer over a chart item representing data in the chart.




© 2004-2006 Adobe Systems Incorporated. All rights reserved.
Thu Jun 22 2006, 10:21 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/2/langref/mx/charts/events/ChartItemEvent.html