Events Handling

Overview

AnyChart Stock for Flex dispatches a lot of different events, that allow you to track what happens with the chart: user actions, selected range changes, event markers events, initialization phases and so on. This article tells you everything you need to know about events handling.

Events Handling

Creating event handlers for AnyChartStock events is similar to handlers of any other Flex component. You can set event listener using mxml or ActionScript.

For example, to assign listeners to stockDraw and stockDataLoad events using MXML you have to do that like this:


<?xml version="1.0" encoding="utf-8"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" layout="absolute" minWidth="955" minHeight="600" xmlns:anychartstock="com.anychartstock.*">
  <mx:Script>
    <![CDATA[
      import com.anychartstock.events.StockEngineEvent;
      
      private function onStockDraw(e:StockEngineEvent):void {
        trace ("onStockDraw", e);
      }
      
      private function onStockDataLoad(e:StockEngineEvent):void {
        trace ("onStockDataLoad", e);
      }
    ]]>
  </mx:Script>
  <anychartstock:AnyChartStock x="10" y="10" xmlFile="config.xml" stockDraw="this.onStockDraw(event)" stockDataLoad="this.onStockDataLoad(event)" />
  
</mx:Application>

Or do the same using ActionScript 3:


<?xml version="1.0" encoding="utf-8"?>
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" layout="absolute" xmlns:anychartstock="com.anychartstock.*" creationPolicy="all" creationComplete="creationCompleteHandler()">
  <mx:Script>
    <![CDATA[
      
      import com.anychartstock.events.StockEngineEvent;
      
      private function creationCompleteHandler():void {
        this.stockChart.addEventListener(StockEngineEvent.STOCK_DRAW, this.onStockDraw);
        this.stockChart.addEventListener(StockEngineEvent.STOCK_DATA_LOAD, this.onStockDataLoad);
      }
      
      private function onStockDraw(e:StockEngineEvent):void {
        trace ("onStockDraw", e);
      }
      
      private function onStockDataLoad(e:StockEngineEvent):void {
        trace ("onStockDataLoad", e);
      }
    ]]>
  </mx:Script>
  <anychartstock:AnyChartStock id="stockChart" x="10" y="10" xmlFile="config.xml" />
  
</mx:Application>

to top

Events List

Here is the complete list of supported events, click on names to proceed to corresponding articles in Flex API Reference:

Event Summary
chartMouseDown Dispatched when mouse button is pressed on the chart plotting area.
chartMouseMove Dispatched when mouse is moving over the chart plotting area.
chartMouseOut Dispatched when mouse leaves the chart plotting area.
chartMouseOver Dispatched when the chart plotting area is hovered by mouse.
chartMouseUp Dispatched when mouse button is released.
eventMarkerClick Dispatched when a user clicks an event marker.
eventMarkerDeselect Dispatched when an event marker is deselected.
eventMarkerDoubleClick Dispatched when a user double clicks an event marker.
eventMarkerMouseOut Dispatched when mouse leaves an event marker.
eventMarkerMouseOver Dispatched when an event marker is hovered by mouse.
eventMarkerSelect Dispatched when an event marker is selected.
mergedEventMarkerClick Dispatched when a user clicks an event marker group.
mergedEventMarkerDeselect Dispatched when a merged event marker group is deselected.
mergedEventMarkerDoubleClick Dispatched when a user double clicks a merged event marker group.
mergedEventMarkerMouseOut Dispatched when mouse leaves a merged event marker group.
mergedEventMarkerMouseOver Dispatched when a user hovers a merged event marker group.
mergedEventMarkerSelect Dispatched when a merged event marker group is selected.
selectedRangeChange Dispatched when the selected range of the chart is changed.
stockDataLoad Dispatched when CSV data is loaded.
stockDraw Dispatched when a chart is drawn.

Full list of events is also available in Flex API Reference:

to top

Event classes

AnyChartStock Flex library contains the following event classes:

Class Description
com.anychartstock.events.EventMarkerEvent EventMarkerEvent class represents an event object passed to event listeners for event markers events.
com.anychartstock.events.MergedEventMarkerEvent MergedEventMarkerEvent class represents an event object passed to event listeners for merged event markers events.
com.anychartstock.events.SelectedRangeChangeEvent SelectedRangeChangeEvent class represents an event object passed to event listeners for selectedRangeChange event.
com.anychartstock.events.StockChartMouseEvent StockChartMouseEvent object is dispatched into the event flow whenever mouse events occur in chart.
com.anychartstock.events.StockEngineEvent StockEngineEvent class represents an event object passed to event listeners of draw, dataLoad and other events like that.

All event classes are in com.anychartstock.events package. Full list is also available in Flex API reference:

to top