LegendMouseEvent

Package	mx.charts.events
Class	public class LegendMouseEvent
Inheritance	LegendMouseEvent MouseEvent Event Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The LegendMouseEvent class represents event objects that are specific to the chart legend components. such as when a legend item is clicked on.

Learn more

Using Legend controls
Handling user interactions with charts

Public Properties

	Property		Defined By
		altKey : Boolean Indicates whether the Alt key is active (true) or inactive (false).	MouseEvent
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		buttonDown : Boolean Indicates whether the primary mouse button is pressed (true) or not (false).	MouseEvent
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		clickCount : int [read-only] Indicates whether or not the mouse down event is part of a multi-click sequence.	MouseEvent
		commandKey : 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
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		controlKey : Boolean Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.	MouseEvent
		ctrlKey : Boolean On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).	MouseEvent
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		delta : int Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel.	MouseEvent
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		isRelatedObjectInaccessible : Boolean If true, the relatedObject property is set to null for reasons related to security sandboxes.	MouseEvent
		item : LegendItem The item in the Legend on which this event was triggered.	LegendMouseEvent
		localX : Number When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		localY : Number When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite.	MouseEvent
		movementX : Number When mouse locking is enabled, the change in mouse position in the X direction since the last mouse event.	MouseEvent
		movementY : Number When mouse locking is enabled, the change in mouse position in the Y direction since the last mouse event.	MouseEvent
		relatedObject : InteractiveObject A reference to a display list object that is related to the event.	MouseEvent
		shiftKey : Boolean Indicates whether the Shift key is active (true) or inactive (false).	MouseEvent
		stageX : Number [read-only] The horizontal coordinate at which the event occurred in global Stage coordinates.	MouseEvent
		stageY : Number [read-only] The vertical coordinate at which the event occurred in global Stage coordinates.	MouseEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		LegendMouseEvent(type:String, triggerEvent:MouseEvent = null, item:LegendItem = null) Constructor.	LegendMouseEvent
		clone():Event [override] Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.	MouseEvent
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		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
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string that contains all the properties of the MouseEvent object.	MouseEvent
		updateAfterEvent():void Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.	MouseEvent
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		ITEM_CLICK : String = "itemClick" [static] Event type constant; indicates that the user clicked the mouse button over a legend item.	LegendMouseEvent
		ITEM_MOUSE_DOWN : String = "itemMouseDown" [static] Event type constant; indicates that the user clicked the mouse button over a legend item.	LegendMouseEvent
		ITEM_MOUSE_OUT : String = "itemMouseOut" [static] Event type constant; indicates that the user rolled the mouse pointer away from a legend item.	LegendMouseEvent
		ITEM_MOUSE_OVER : String = "itemMouseOver" [static] Event type constant; indicates that the user rolled the mouse pointer over a legend item.	LegendMouseEvent
		ITEM_MOUSE_UP : String = "itemMouseUp" [static] Event type constant; indicates that the user released the mouse button while over a legend item.	LegendMouseEvent

Property Detail

item

property

public var item:LegendItem

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The item in the Legend on which this event was triggered.

Constructor Detail

LegendMouseEvent

()

Constructor

public function LegendMouseEvent(type:String, triggerEvent:MouseEvent = null, item:LegendItem = 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 Mouse event. If a mouse event type is given it would be converted into a LegendMouseEvent type.

	`triggerEvent:MouseEvent` (default = `null`) — The MouseEvent that triggered this LegentMouseEvent.

	`item:LegendItem` (default = `null`) — The item in the Legend on which this event was triggered.

Constant Detail

ITEM_CLICK

Constant

public static const ITEM_CLICK:String = "itemClick"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Event type constant; indicates that the user clicked the mouse button over a legend item.

ITEM_MOUSE_DOWN

Constant

public static const ITEM_MOUSE_DOWN:String = "itemMouseDown"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Event type constant; indicates that the user clicked the mouse button over a legend item.

ITEM_MOUSE_OUT

Constant

public static const ITEM_MOUSE_OUT:String = "itemMouseOut"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Event type constant; indicates that the user rolled the mouse pointer away from a legend item.

ITEM_MOUSE_OVER

Constant

public static const ITEM_MOUSE_OVER:String = "itemMouseOver"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Event type constant; indicates that the user rolled the mouse pointer over a legend item.

ITEM_MOUSE_UP

Constant

public static const ITEM_MOUSE_UP:String = "itemMouseUp"

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Event type constant; indicates that the user released the mouse button while over a legend item.

Legal Notices | Online Privacy Policy

LegendMouseEvent - AS3 Flex

Classes x

item

LegendMouseEvent

ITEM_CLICK

ITEM_MOUSE_DOWN

ITEM_MOUSE_OUT

ITEM_MOUSE_OVER

ITEM_MOUSE_UP