ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.charts.events 

ChartEvent  - AS3 Flex

Packagemx.charts.events
Classpublic class ChartEvent
InheritanceChartEvent Inheritance MouseEvent Inheritance Event Inheritance Object

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

The ChartEvent class represents events that are specific to the chart control, such as when a chart is clicked. This event is only triggered if there are no ChartItem objects underneath the mouse.

Learn more

Related API Elements



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
 InheritedclickCount : int
[read-only] Indicates whether or not the mouse down event is part of a multi-click sequence.
MouseEvent
 InheritedcommandKey : Boolean
Indicates whether the command key is activated (Mac only.) The value of property commandKey will have the same value as property ctrlKey on the Mac.
MouseEvent
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontrolKey : Boolean
Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
MouseEvent
 InheritedctrlKey : Boolean
On Windows or Linux, 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
 InheritedisRelatedObjectInaccessible : Boolean
If true, the relatedObject property is set to null for reasons related to security sandboxes.
MouseEvent
 InheritedlocalX : Number
When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite.
MouseEvent
 InheritedlocalY : Number
When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite.
MouseEvent
 InheritedmovementX : Number
When mouse locking is enabled, the change in mouse position in the X direction since the last mouse event.
MouseEvent
 InheritedmovementY : Number
When mouse locking is enabled, the change in mouse position in the Y direction since the last mouse event.
MouseEvent
 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
  
ChartEvent(type:String, triggerEvent:MouseEvent = null, target:ChartBase = null)
Constructor.
ChartEvent
 Inherited
[override] 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
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string that contains all the properties of the MouseEvent object.
MouseEvent
 Inherited
Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.
MouseEvent
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  CHART_CLICK : String = "chartClick"
[static] Indicates that the user clicked the mouse button over a chart control but not on a chart item.
ChartEvent
  CHART_DOUBLE_CLICK : String = "chartDoubleClick"
[static] Indicates that the user double-clicked the mouse button over a chart control but not on a chart item.
ChartEvent
Constructor Detail

ChartEvent

()Constructor
public function ChartEvent(type:String, triggerEvent:MouseEvent = null, target:ChartBase = null)

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

Constructor.

Parameters
type:String — The type of the event.
 
triggerEvent:MouseEvent (default = null) — The MouseEvent that triggered this ChartEvent.
 
target:ChartBase (default = null) — The chart on which the event was triggered.
Constant Detail

CHART_CLICK

Constant
public static const CHART_CLICK:String = "chartClick"

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

Indicates that the user clicked the mouse button over a chart control but not on a chart item.

CHART_DOUBLE_CLICK

Constant 
public static const CHART_DOUBLE_CLICK:String = "chartDoubleClick"

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

Indicates that the user double-clicked the mouse button over a chart control but not on a chart item.