(Flex Data Visualization 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.


Public Properties
 PropertyDefined By
 InheritedaltKey : Boolean
Indicates whether the Alt key is active (true) or inactive (false).
MouseEvent
 Inheritedbubbles : Boolean
[read-only] 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
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 InheritedAIR-only clickCount : int
[read-only] Indicates whether or not the mouse down event is part of a multi-click sequence.
MouseEvent
 InheritedAIR-only commandKey : Boolean
Indicates whether the command key is activated.
MouseEvent
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedAIR-only controlKey : Boolean
Indicates whether the Ctrl key is activated.
MouseEvent
 InheritedctrlKey : Boolean
On Windows, indicates whether the Ctrl key is active (true) or inactive (false).
MouseEvent
 InheritedcurrentTarget : Object
[read-only] 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
[read-only] 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
[read-only] The horizontal coordinate at which the event occurred in global Stage coordinates.
MouseEvent
 InheritedstageY : Number
[read-only] The vertical coordinate at which the event occurred in global Stage coordinates.
MouseEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
ChartItemEvent(type:String, hitSet:Array = null, triggerEvent:MouseEvent = null, target:ChartBase = null)
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 custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method 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 or Adobe AIR 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] The Event.ACTIVATE constant defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] The Event.ADDED constant defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] The Event.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.
Event
 InheritedCANCEL : String = "cancel"
[static] The Event.CANCEL constant defines the value of the type property of a cancel event object.
Event
  CHANGE : String = "change"
[static] Event type constant; indicates that the selection in the chart has changed.
ChartItemEvent
 InheritedCLICK : String = "click"
[static] Defines the value of the type property of a click event object.
MouseEvent
 InheritedCLOSE : String = "close"
[static] The Event.CLOSE constant defines the value of the type property of a close event object.
Event
 InheritedAIR-only CLOSING : String = "closing"
[static] The Event.CLOSING constant defines the value of the type property of a closing event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] The Event.COMPLETE constant defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] The Event.CONNECT constant defines the value of the type property of a connect event object.
Event
 InheritedAIR-only CONTEXT_MENU : String = "contextMenu"
[static] The InteractiveIconMouseEvent.CONTEXT_MENU constant defines the value of the type property of a contextMenu event object.
MouseEvent
 InheritedDEACTIVATE : String = "deactivate"
[static] The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object.
Event
 InheritedAIR-only DISPLAYING : String = "displaying"
[static] Defines the value of the type property of a displaying 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] The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.
Event
 InheritedAIR-only EXITING : String = "exiting"
[static] The Event.EXITING constant defines the value of the type property of an exiting event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.
Event
 InheritedAIR-only HTML_BOUNDS_CHANGE : String = "htmlBoundsChange"
[static] The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object.
Event
 InheritedAIR-only HTML_DOM_INITIALIZE : String = "htmlDOMInitialize"
[static] The Event.HTML_DOM_INITIALIZE constant defines the value of the type property of an htmlDOMInitialize event object.
Event
 InheritedAIR-only HTML_RENDER : String = "htmlRender"
[static] The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object.
Event
 InheritedID3 : String = "id3"
[static] The Event.ID3 constant defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] The Event.INIT constant 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
 InheritedAIR-only LOCATION_CHANGE : String = "locationChange"
[static] The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object.
Event
 InheritedAIR-only MIDDLE_CLICK : String = "middleClick"
[static] Defines the value of the type property of a middleClick event object.
MouseEvent
 InheritedAIR-only MIDDLE_MOUSE_DOWN : String = "middleMouseDown"
[static] Defines the value of the type property of a middleMouseDown event object.
MouseEvent
 InheritedAIR-only MIDDLE_MOUSE_UP : String = "middleMouseUp"
[static] Defines the value of the type property of a middleMouseUp event object.
MouseEvent
 InheritedMOUSE_DOWN : String = "mouseDown"
[static] Defines the value of the type property of a mouseDown event object.
MouseEvent
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] The Event.MOUSE_LEAVE constant 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
 InheritedAIR-only NETWORK_CHANGE : String = "networkChange"
[static] The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.
Event
 InheritedOPEN : String = "open"
[static] The Event.OPEN constant defines the value of the type property of an open event object.
Event
 InheritedREMOVED : String = "removed"
[static] The Event.REMOVED constant defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] The Event.REMOVED_FROM_STAGE constant defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] The Event.RENDER constant defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] The Event.RESIZE constant defines the value of the type property of a resize event object.
Event
 InheritedAIR-only RIGHT_CLICK : String = "rightClick"
[static] Defines the value of the type property of a rightClick event object.
MouseEvent
 InheritedAIR-only RIGHT_MOUSE_DOWN : String = "rightMouseDown"
[static] Defines the value of the type property of a rightMouseDown event object.
MouseEvent
 InheritedAIR-only RIGHT_MOUSE_UP : String = "rightMouseUp"
[static] Defines the value of the type property of a rightMouseUp event object.
MouseEvent
 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] The Event.SCROLL constant defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] The Event.SELECT constant defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] The Event.UNLOAD constant defines the value of the type property of an unload event object.
Event
 InheritedAIR-only USER_IDLE : String = "userIdle"
[static] The Event.USER_IDLE constant defines the value of the type property of a userIdle event object.
Event
 InheritedAIR-only USER_PRESENT : String = "userPresent"
[static] The Event.USER_PRESENT constant defines the value of the type property of a userPresent 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 = null, triggerEvent:MouseEvent = null, target:ChartBase = null)

Constructor.

Parameters
type:String — The type of the event.
 
hitSet:Array (default = null) — An array of HitData structures describing the ChartItems that triggered the event.
 
triggerEvent:MouseEvent (default = null) — The MouseEvent that triggered this ChartItemEvent.
 
target:ChartBase (default = null) — The chart on which the event was triggered.
Constant Detail
CHANGEConstant
public static const CHANGE:String = "change"

Event type constant; indicates that the selection in the chart has changed.

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-2007 Adobe Systems Incorporated. All rights reserved.
Fri Feb 15 2008, 2:47 AM GMT-08:00