Packagecom.anychartstock
Classpublic class AnyChartStock
InheritanceAnyChartStock Inheritance mx.core.UIComponent

The main class used for AnyChart Stock Flex integration.

The <anychartstock:AnyChartStock> tag inherits all of the tag attributes of its superclass UIComponent and adds the following tag attributes: 

  <anychartstock:AnyChartStock
   Properties
    config="null"
    xmlFile="null"
   Events
    chartMouseDown="No default"
    chartMouseMove="No default"
    chartMouseOut="No default"
    chartMouseOver="No default"
    chartMouseUp="No default"
    eventMarkerClick="No default"
    eventMarkerDeselect="No default"
    eventMarkerDoubleClick="No default"
    eventMarkerMouseOut="No default"
    eventMarkerMouseOver="No default"
    eventMarkerSelect="No default"
    mergedEventMarkerClick="No default"
    mergedEventMarkerDeselect="No default"
    mergedEventMarkerDoubleClick="No default"
    mergedEventMarkerMouseOut="No default"
    mergedEventMarkerMouseOver="No default"
    mergedEventMarkerSelect="No default"
    selectedRangeChange="No default"
    stockDataLoad="No default"
    stockDraw="No default"
    annotationDrawingStart="No default"
    annotationDrawingFinish="No default"
    annotationEditingStart="No default"
    annotationEditingFinish="No default"
    annotationSelect="No default"
    annotationDeselect="No default"
    annotationRemove="No default"
  >

MXML Syntaxexpanded Hide MXML Syntax

Public Properties
 PropertyDefined by
  config : XML
Gets passed inline XML configuration.
AnyChartStock
  xmlFile : String
Gets/sets XML configuration file location.
AnyChartStock
Public Methods
 MethodDefined by
  
AnyChartStock()
Creates an instance of AnyChartStock class.
AnyChartStock
  
addAnnotation(settings:XML = null):void
Adds an annotation with specified settings.
AnyChartStock
  
addEventMarker(groupId:String, eventMarker:XML):void
Adds new event marker to the specified group.
AnyChartStock
  
addEventMarkerGroup(chartId:String, seriesId:String, group:XML):void
Adds new event marker group to the specified series.
AnyChartStock
  
appendData(dataSetId:String, csvData:String, removeCount:uint = 0):void
Appends CSV data to the chart.
AnyChartStock
  
commitDataChanges():void
Commits data appends and data points removal made by appendData(), removeDataRow() and removeDataRange() method calls.
AnyChartStock
  
commitEventMarkersChanges():void
Commits all changes made to event markers by addEventMarker(), removeEventMarker(), addEventMarkerGroup(), removeEventMarkerGroup() method calls.
AnyChartStock
  
deselectAnnotaion():void
Deselects annotation.
AnyChartStock
  
deselectAnnotation():void
Deselects annotation.
AnyChartStock
  
exportAsJPG(settings:XML = null):void
Exports a chart screenshot as a JPG image.
AnyChartStock
  
exportAsPDF(settings:XML = null):void
Exports a chart screenshot as a PDF document.
AnyChartStock
  
exportAsPNG(settings:XML = null):void
Exports a chart screenshot as a PNG image.
AnyChartStock
  
getAnnotationAsXML(id:String):XML
Gets specified annotation settings as an XML.
AnyChartStock
  
getAnnotationListAsXML():XML
Returns all annotation configurations as an XML.
AnyChartStock
  
getCurrentDataGroupingInterval():DataGroupingIntervalInfo
Gets current data grouping information.
AnyChartStock
  
getCurrentYAxisInfo(chartId:String, axisId:String):YAxisInfo
Gets current Y axis scale information.
AnyChartStock
  
getDataSetCSV(dataSetID:String, columnsOrder:Array, timeStampFormat:String = "%yyyy-%MM-%dd %HH:%mm:%ss.%fff", colsSep:String = ",", rowsSep:String = " "):String
Gets data from a data as a CSV string.
AnyChartStock
  
getFirstDate():Date
Gets the first date of all used by visible series data sources.
AnyChartStock
  
getFirstVisibleDate():Date
Gets the first visible date.
AnyChartStock
  
getJPGImageBase64Encoded(settings:XML = null):String
Gets a chart screenshot as a base64 encoded JPG image.
AnyChartStock
  
getLastDate():Date
Gets the last date from all mapped and used by visible series data sources.
AnyChartStock
  
getLastVisibleDate():Date
Gets the last visible date.
AnyChartStock
  
getPDFBase64Encoded(settings:XML = null):String
Gets a chart screenshot as a base64 encoded PDF document.
AnyChartStock
  
getPNGImageBase64Encoded(settings:XML = null):String
Gets a chart screenshot as a base64 encoded PNG image.
AnyChartStock
  
getSelectedAnnotationId():String
Returns selected annotation identifier.
AnyChartStock
  
getSeriesCloseValue(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo
Gets info about "close" field of the series.
AnyChartStock
  
getSeriesCustomValue(chartId:String, seriesId:String, field:String, searchForNotNaN:Boolean):SeriesValueInfo
Gets information about custom field of the series.
AnyChartStock
  
getSeriesHighValue(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo
Gets info about "high" field of the series.
AnyChartStock
  
getSeriesLowValue(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo
Gets info about "low" field of the series.
AnyChartStock
  
getSeriesOpenValue(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo
Gets info about "open" field of the series.
AnyChartStock
  
getSeriesPercentValueChange(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo
Gets info about a percent change of "value" (or "close" field, if "value" field is not specified) series field values.
AnyChartStock
  
getSeriesValue(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo
Gets info about "value" (or "close" field, if "value" field is not specified) series field.
AnyChartStock
  
getSeriesValueChange(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo
Gets info about a change of "value" (or "close" field, if "value" field is not specified) series field values.
AnyChartStock
  
getTechnicalIndicatorValue(chartId:String, technicalIndicatorId:String, searchForNotNaN:Boolean):ITechIndicatorInfo
Gets info about technical indicator value.
AnyChartStock
  
hideEventMarker(eventMarkerGroupId:String, eventMarkerId:String):void
Hides specified event marker.
AnyChartStock
  
hideEventMarkerGroup(eventMarkerGroupId:String):void
Hides specified event marker group.
AnyChartStock
  
printChart(settings:XML = null):void
Prints the chart
AnyChartStock
  
removeAllAnnotations():void
Removes all annotations including predefined in chart XML configuration.
AnyChartStock
  
removeAnnotation(id:String):void
Removes an annotation by its identifier.
AnyChartStock
  
removeDataRange(dataSetId:String, startDate:Date, endDate:Date):void
Removes data range from a data set by the range of dates.
AnyChartStock
  
removeDataRow(dataSetId:String, date:Date):void
Removes data row from a data set by its date.
AnyChartStock
  
removeEventMarker(groupId:String, eventMarkerId:String):void
Remove event marker from the specified group.
AnyChartStock
  
removeEventMarkerGroup(groupId:String):void
Remove event marker group by group id.
AnyChartStock
  
resetEventMarkerSelection(chartId:String):void
Resets event marker selection on the chart.
AnyChartStock
  
scrollTo(date:Date):void
Scrolls a chart to the given date.
AnyChartStock
  
selectAnnotation(id:String):void
Selects annotation by its identifier.
AnyChartStock
  
selectEventMarker(eventMarkerGroupId:String, eventMarkerId:String):void
Selects specified event marker.
AnyChartStock
  
selectRange(type:String, unit:String = null, count:Number = 1, anchor:String = "LastDate"):void
Selects the specified range of dates.
AnyChartStock
  
setAnnotationList(settings:XML = null):void
Replaces all present annotations with the given list.
AnyChartStock
  
setConfig(config:XML):void
Replace chart configuration with a new one.
AnyChartStock
  
setEventMarkers(eventMarkers:XML):void
Replaces current event markers settings with new ones.
AnyChartStock
  
setSettings(value:XML, preserveSelectedRange:Boolean = true):void
Replaces current chart visual settings with new ones.
AnyChartStock
  
showEventMarker(eventMarkerGroupId:String, eventMarkerId:String):void
Shows specified hidden event marker.
AnyChartStock
  
showEventMarkerGroup(eventMarkerGroupId:String):void
Shows specified hidden event marker group.
AnyChartStock
  
startDrawingAnnotation(type:String, settings:XML = null):void
Starts annotation drawing.
AnyChartStock
  
stopDrawingAnnotation():void
Stops annotation drawing.
AnyChartStock
  
updateAnnotation(id:String, settings:XML = null):void
Updates an annotation by the identifier with new settings.
AnyChartStock
  
updateEventMarker(groupId:String, eventMarkerId:String, newSettings:XML):void
Updates an event marker with new settings.
AnyChartStock
  
zoomTo(startDate:Date, endDate:Date):void
Zooms a chart to the custom range.
AnyChartStock
Events
 EventSummaryDefined by
  
annotationDeselect
Dispatched when an annotation is deselected.AnyChartStock
  
annotationDrawingFinish
Dispatched when user finishes drawing an annotation.AnyChartStock
  
annotationDrawingProgress
Dispatched repeatedly when an annotation drawing started by calling the startDrawingAnnotation() method progresses.AnyChartStock
  
annotationDrawingStart
Dispatched when an annotation drawing is started by calling the startDrawingAnnotation() method.AnyChartStock
  
annotationEditingFinish
Dispatched when user finishes editing an annotation.AnyChartStock
  
annotationEditingProgress
Dispatched when an annotation editing progresses.AnyChartStock
  
annotationEditingStart
Dispatched when an annotation editing is started.AnyChartStock
  
annotationRemove
Dispatched when user removes an annotation using DELETE key.AnyChartStock
  
annotationSelect
Dispatched when an annotation is selected.AnyChartStock
  
chartMouseDown
Dispatched when mouse button is pressed on chart plotting area.AnyChartStock
  
chartMouseMove
Dispatched when mouse moves over chart plotting area.AnyChartStock
  
chartMouseOut
Dispatched when mouse leaves chart plotting area.AnyChartStock
  
chartMouseOver
Dispatched when chart plotting area is hovered by mouse.AnyChartStock
  
chartMouseUp
Dispatched when mouse button is released.AnyChartStock
  
eventMarkerClick
Dispatched when user clicks an event marker.AnyChartStock
  
eventMarkerDeselect
Dispatched when an event marker is deselected.AnyChartStock
  
eventMarkerDoubleClick
Dispatched when user double clicks an event marker.AnyChartStock
  
eventMarkerMouseOut
Dispatched when mouse leaves an event marker.AnyChartStock
  
eventMarkerMouseOver
Dispatched when an event marker is hovered by mouse.AnyChartStock
  
eventMarkerSelect
Dispatched when an event marker is selected.AnyChartStock
  
mergedEventMarkerClick
Dispatched when user clicks an event marker group.AnyChartStock
  
mergedEventMarkerDeselect
Dispatched when a merged event marker group is deselected.AnyChartStock
  
mergedEventMarkerDoubleClick
Dispatched when user double clicks a merged event marker group.AnyChartStock
  
mergedEventMarkerMouseOut
Dispatched when mouse leaves a merged event marker group.AnyChartStock
  
mergedEventMarkerMouseOver
Dispatched when user hovers a merged event marker group.AnyChartStock
  
mergedEventMarkerSelect
Dispatched when a merged event marker group is selected.AnyChartStock
  
selectedRangeChange
Dispatched when the selected range of a chart is changed.AnyChartStock
  
stockDataLoad
Dispatched when CSV data is loaded.AnyChartStock
  
stockDraw
Dispatched when a chart is drawn.AnyChartStock
Public Constants
 ConstantDefined by
  VERSION : String = "1.7.0 Revision #${dist.revision}"
[static] Component version
AnyChartStock
Property detail
configproperty
config:XML  [read-write]

Gets passed inline XML configuration.

Chart configuration can be passed to a chart in two ways:

Implementation
    public function get config():XML
    public function set config(value:XML):void

See also

setConfig()
xmlFile
xmlFileproperty 
xmlFile:String  [read-write]

Gets/sets XML configuration file location.

Chart configuration can be set to a chart in two ways:

Implementation
    public function get xmlFile():String
    public function set xmlFile(value:String):void

See also

config
setConfig()
Constructor detail
AnyChartStock()constructor
public function AnyChartStock()

Creates an instance of AnyChartStock class.

Method detail
addAnnotation()method
public function addAnnotation(settings:XML = null):void

Adds an annotation with specified settings.

Parameters
settings:XML (default = null) — XML object with settings. Must correspond to <annotation> configuration.
addEventMarker()method 
public function addEventMarker(groupId:String, eventMarker:XML):void

Adds new event marker to the specified group.

Note: Changes are applied only on #commitEventMarkersChanges() call.

Parameters
groupId:String — Group id. See <group> node reference.
 
eventMarker:XML — Event marker configuration. See <event> node reference.

See also

removeEventMarker()
commitEventMarkersChanges()
addEventMarkerGroup()method 
public function addEventMarkerGroup(chartId:String, seriesId:String, group:XML):void

Adds new event marker group to the specified series.

Note: Changes are applied only on #commitEventMarkersChanges() call.

Parameters
chartId:String — Sets what chart this event marker group should be added to. See <chart> node reference.
 
seriesId:String — Sets what series on the chartId chart this event marker group should be added to. See <series> node reference.
 
group:XML — Event marker group configuration. See <group> node reference.

See also

removeEventMarkerGroup()
commitEventMarkersChanges()
appendData()method 
public function appendData(dataSetId:String, csvData:String, removeCount:uint = 0):void

Appends CSV data to the chart.

Note: First line in appended CSV data is never ignored.

Note: Changes are applied only on #commitDataChanges() method call.

Parameters
dataSetId:String — Data set id. See <data set> node reference.
 
csvData:String — String with CSV data. CSV structure and locale should correspond to a data set structure and locale it is appended to. See <CSV table within.>.
 
removeCount:uint (default = 0) — Sets the number of rows to be deleted from the start of the dataSet.

See also

removeDataRange()
removeDataRow()
Date
commitDataChanges()method 
public function commitDataChanges():void

Commits data appends and data points removal made by appendData(), removeDataRow() and removeDataRange() method calls.

Note: You can make data changes in different data sets and commit all these changes simultaneously.

See also

appendData()
remoteDataRange()
remoteDataRow()
commitEventMarkersChanges()method 
public function commitEventMarkersChanges():void

Commits all changes made to event markers by addEventMarker(), removeEventMarker(), addEventMarkerGroup(), removeEventMarkerGroup() method calls.

You can do multiple calls to these methods and apply all changes simultaneously.

See also

addEventMarker()
removeEventMarker()
addEventMarkerGroup()
removeEventMarkerGroup()
deselectAnnotaion()method 
public function deselectAnnotaion():void

Deselects annotation.

See also

deselectAnnotation()
deselectAnnotation()method 
public function deselectAnnotation():void

Deselects annotation.

exportAsJPG()method 
public function exportAsJPG(settings:XML = null):void

Exports a chart screenshot as a JPG image.

Note: Exporting mechanism sends a screenshot to the server and then gets it back due to Flash Security, so you have to set valid export script url. See Chart Exporting article for more info.

Parameters
settings:XML (default = null) — Custom JPG export settings. See <jpg_image> node reference.

See also

exportAsPDF()
exportAsPNG()
exportAsPDF()method 
public function exportAsPDF(settings:XML = null):void

Exports a chart screenshot as a PDF document.

Note: Exporting mechanism sends a screenshot to the server and then gets it back due to Flash Security, so you have to set valid export script url. See Chart Exporting article for more info.

Parameters
settings:XML (default = null) — Custom PDF export settings. See <pdf> node reference.

See also

exportAsPNG()
exportAsJPG()
exportAsPNG()method 
public function exportAsPNG(settings:XML = null):void

Exports a chart screenshot as a PNG image.

Note: Exporting mechanism sends a screenshot to the server and then gets it back due to Flash Security, so you have to set valid export script url. See Chart Exporting article for more info.

Parameters
settings:XML (default = null) — Custom PNG export settings. See <png_image> node reference.

See also

exportAsPDF()
exportAsJPG()
getAnnotationAsXML()method 
public function getAnnotationAsXML(id:String):XML

Gets specified annotation settings as an XML.

Parameters
id:String — String annotation identifier.

Returns
XML — XML object with annotation settings. Corresponds to <annotation> node.
getAnnotationListAsXML()method 
public function getAnnotationListAsXML():XML

Returns all annotation configurations as an XML.

Returns
XML — XML object with <annotation_list> structure.
getCurrentDataGroupingInterval()method 
public function getCurrentDataGroupingInterval():DataGroupingIntervalInfo

Gets current data grouping information.

Note: The return value may be null if the method is called while the component is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Returns
DataGroupingIntervalInfo — DataGroupingIntervalInfo DataGroupingIntervalInfo object, which contains information about current grouping interval.

See also

DataGroupingIntervalInfo
getCurrentYAxisInfo()method 
public function getCurrentYAxisInfo(chartId:String, axisId:String):YAxisInfo

Gets current Y axis scale information.

Note: The return value may be empty if the method is called while the component is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Parameters
chartId:String
 
axisId:String

Returns
YAxisInfo — YAxisInfo YAxisInfo object, which contains information about current axis scale values.

See also

YAxisInfo
getDataSetCSV()method 
public function getDataSetCSV(dataSetID:String, columnsOrder:Array, timeStampFormat:String = "%yyyy-%MM-%dd %HH:%mm:%ss.%fff", colsSep:String = ",", rowsSep:String = " "):String

Gets data from a data as a CSV string.

Note: to get a column from a dataset, this column should be referenced in any data provider in configuration file.

Parameters
dataSetID:String — - A string data set identifier.
 
columnsOrder:Array — - An array of column indexes to serialize. Data column should also be mentioned (usualy a 0 column).
 
timeStampFormat:String (default = "%yyyy-%MM-%dd %HH:%mm:%ss.%fff") — - A string of timestamps to serialize.
 
colsSep:String (default = ",") — - A columns separator.
 
rowsSep:String (default = " ") — - A rows separator.

Returns
String — String CSV data.
getFirstDate()method 
public function getFirstDate():Date

Gets the first date of all used by visible series data sources.

Note: "current" property of an output object is not NaN only if any point of the series is hovered.

Note: The return value may be null if the method is called while a chart is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Returns
Date — Data Object Date, which contains the specified date and time.

See also

getLastDate()
getFirstVisibleDate()
getLastVisibleDate()
Date
getFirstVisibleDate()method 
public function getFirstVisibleDate():Date

Gets the first visible date.

Note: "current" property of an output object is not NaN only if any point of the series is hovered.

Note: The return value may be null if the method is called while a chart is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Returns
Date — Data Object Date, which contains the specified date and time.

See also

getFirstDate()
getLastDate()
getLastVisibleDate()
Date
getJPGImageBase64Encoded()method 
public function getJPGImageBase64Encoded(settings:XML = null):String

Gets a chart screenshot as a base64 encoded JPG image.

Parameters
settings:XML (default = null) — Screenshot settings. See <jpg_image> node for export settings details.

Returns
String — String Base64 encoded JPG image
getLastDate()method 
public function getLastDate():Date

Gets the last date from all mapped and used by visible series data sources.

Note: "current" property of an output object is not NaN only if any point of the series is hovered.

Note: The return value may be null if the method is called while a chart is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Returns
Date — Data Object Date, which contains the specified date and time.

See also

getFirstDate()
getFirstVisibleDate()
getLastVisibleDate()
Date
getLastVisibleDate()method 
public function getLastVisibleDate():Date

Gets the last visible date.

Note: "current" property of an output object is not NaN only if any point of the series is hovered.

Note: The return value may be null if the method is called while a chart is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Returns
Date — Data Object Date, which contains the specified date and time.

See also

getFirstDate()
getLastDate()
getFirstVisibleDate()
Date
getPDFBase64Encoded()method 
public function getPDFBase64Encoded(settings:XML = null):String

Gets a chart screenshot as a base64 encoded PDF document.

Parameters
settings:XML (default = null) — Screenshot settings. See <pdf> node for export settings details.

Returns
String — String Base64 encoded PDF document
getPNGImageBase64Encoded()method 
public function getPNGImageBase64Encoded(settings:XML = null):String

Gets a chart screenshot as a base64 encoded PNG image.

Parameters
settings:XML (default = null) — Screenshot settings. See <png_image> node for export settings details.

Returns
String — String Base64 encoded PNG image
getSelectedAnnotationId()method 
public function getSelectedAnnotationId():String

Returns selected annotation identifier. If there is no annotation selected, returns null.

Returns
String — String annotation identifier.
getSeriesCloseValue()method 
public function getSeriesCloseValue(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo

Gets info about "close" field of the series.

Note: "current" property of an output object is not NaN only if any point of the series is hovered.

Note: The return value may be null if the method is called while a chart is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Parameters
chartId:String — Chart id. See <chart> node reference.
 
seriesId:String — Series id. See <series> node reference.
 
searchForNotNaN:Boolean

Returns
SeriesValueInfo — SeriesValueInfo Object SeriesValueInfo, which contains information about "value" series field.

See also

getSeriesValue()
getSeriesHighValue()
getSeriesOpenValue()
getSeriesLowValue()
getSeriesCustomValue()
getSeriesValueChange()
getSeriesPercentValueChange()
SeriesValueInfo()
getSeriesCustomValue()method 
public function getSeriesCustomValue(chartId:String, seriesId:String, field:String, searchForNotNaN:Boolean):SeriesValueInfo

Gets information about custom field of the series.

Note: "current" property of an output object is not NaN only if any point of the series is hovered.

Note: The return value may be null if the method is called while a chart is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Parameters
chartId:String — Chart id. See <chart> node reference.
 
seriesId:String — Series id. See <series> node reference.
 
field:String — Custom field name.
 
searchForNotNaN:Boolean

Returns
SeriesValueInfo — SeriesValueInfo - object SeriesValueInfo, which contains information about "value" series field.

See also

getSeriesValue()
getSeriesHighValue()
getSeriesOpenValue()
getSeriesLowValue()
getSeriesCloseValue()
getSeriesValueChange()
getSeriesPercentValueChange()
SeriesValueInfo()
getSeriesHighValue()method 
public function getSeriesHighValue(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo

Gets info about "high" field of the series.

Note: "current" property of an output object is not NaN only if any point of the series is hovered.

Note: The return value may be null if the method is called while a chart is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Parameters
chartId:String — Chart id. See <chart> node reference.
 
seriesId:String — Series id. See <series> node reference.
 
searchForNotNaN:Boolean

Returns
SeriesValueInfo — SeriesValueInfo Object SeriesValueInfo, which contains information about "value" series field.

See also

getSeriesValue()
getSeriesOpenValue()
getSeriesLowValue()
getSeriesCloseValue()
getSeriesCustomValue()
getSeriesValueChange()
getSeriesPercentValueChange()
SeriesValueInfo()
getSeriesLowValue()method 
public function getSeriesLowValue(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo

Gets info about "low" field of the series.

Note: "current" property of an output object is not NaN only if any point of the series is hovered.

Note: The return value may be null if the method is called while a chart is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Parameters
chartId:String — Chart id. See <chart> node reference.
 
seriesId:String — Series id. See <series> node reference.
 
searchForNotNaN:Boolean

Returns
SeriesValueInfo — SeriesValueInfo Object SeriesValueInfo, which contains information about "value" series field.

See also

getSeriesValue()
getSeriesOpenValue()
getSeriesHighValue()
getSeriesCloseValue()
getSeriesCustomValue()
getSeriesValueChange()
getSeriesPercentValueChange()
SeriesValueInfo()
getSeriesOpenValue()method 
public function getSeriesOpenValue(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo

Gets info about "open" field of the series.

Note: "current" property of an output object is not NaN only if any point of the series is hovered.

Note: The return value may be null if the method is called while a chart is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Parameters
chartId:String — Chart id. See <chart> node reference.
 
seriesId:String — Series id. See <series> node reference.
 
searchForNotNaN:Boolean

Returns
SeriesValueInfo — SeriesValueInfo Object SeriesValueInfo, which contains information about "value" series field.

See also

getSeriesValue()
getSeriesHighValue()
getSeriesLowValue()
getSeriesCloseValue()
getSeriesCustomValue()
getSeriesValueChange()
getSeriesPercentValueChange()
SeriesValueInfo()
getSeriesPercentValueChange()method 
public function getSeriesPercentValueChange(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo

Gets info about a percent change of "value" (or "close" field, if "value" field is not specified) series field values.

Note: "current" property of an output object is not NaN only if any point of the series is hovered.

Note: The return value may be null if the method is called while a chart is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Parameters
chartId:String — Chart id. See <chart> node reference.
 
seriesId:String — Series id. See <series> node reference.
 
searchForNotNaN:Boolean

Returns
SeriesValueInfo — SeriesValueInfo Object SeriesValueInfo, which contains information about "value" series field.

See also

getSeriesValue()
getSeriesHighValue()
getSeriesOpenValue()
getSeriesLowValue()
getSeriesCloseValue()
getSeriesValueChange()
SeriesValueInfo()
getSeriesValue()method 
public function getSeriesValue(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo

Gets info about "value" (or "close" field, if "value" field is not specified) series field.

Note: "current" property of an output object is not NaN only if any point of the series is hovered.

Note: The return value may be null if the method is called while a chart is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Parameters
chartId:String — Chart id. See <chart> node reference.
 
seriesId:String — Series id. See <series> node reference.
 
searchForNotNaN:Boolean

Returns
SeriesValueInfo — SeriesValueInfo Object SeriesValueInfo, which contains information about "value" series field.

See also

getSeriesOpenValue()
getSeriesHighValue()
getSeriesLowValue()
getSeriesCloseValue()
getSeriesCustomValue()
getSeriesValueChange()
getSeriesPercentValueChange()
SeriesValueInfo()
getSeriesValueChange()method 
public function getSeriesValueChange(chartId:String, seriesId:String, searchForNotNaN:Boolean):SeriesValueInfo

Gets info about a change of "value" (or "close" field, if "value" field is not specified) series field values.

Note: "current" property of an output object is not NaN only if any point of the series is hovered.

Note: The return value may be null if the method is called while chart is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Parameters
chartId:String — Chart id. See <chart> node reference.
 
seriesId:String — Series id. See <series> node reference.
 
searchForNotNaN:Boolean

Returns
SeriesValueInfo — SeriesValueInfo Object SeriesValueInfo, which contains information about "value" series field.

See also

getSeriesValue()
getSeriesHighValue()
getSeriesOpenValue()
getSeriesLowValue()
getSeriesCloseValue()
getSeriesValueChange()
getSeriesPercentValueChange()
SeriesValueInfo()
getTechnicalIndicatorValue()method 
public function getTechnicalIndicatorValue(chartId:String, technicalIndicatorId:String, searchForNotNaN:Boolean):ITechIndicatorInfo

Gets info about technical indicator value.

Note: "current" property of an output object is not NaN only if any point of the series is hovered.

Note: The return value may be null if the method is called while a chart is not drawn yet. To avoid this case you should call this method only after #onChartDraw event is raised.

Parameters
chartId:String — Chart id. See <chart> node reference.
 
technicalIndicatorId:String — Technical indicator id. See <technical_indicator> node reference.
 
searchForNotNaN:Boolean

Returns
ITechIndicatorInfo — ITechIndicatorInfo Object ITechIndicatorInfo, which contains information about technical indicator value.

See also

getSeriesValue()
ITechIndicatorInfo
hideEventMarker()method 
public function hideEventMarker(eventMarkerGroupId:String, eventMarkerId:String):void

Hides specified event marker.

A marker is referenced by its id and by the id of the group that contains the marker.

Parameters
eventMarkerGroupId:String — Event marker group identificator. See <group> node reference.
 
eventMarkerId:String — Event marker identificator. See <event> node reference.

See also

showEventMarker
hideEventMarkerGroup
showEventMarkerGroup
hideEventMarkerGroup()method 
public function hideEventMarkerGroup(eventMarkerGroupId:String):void

Hides specified event marker group.

A marker group is referenced by it's id

Parameters
eventMarkerGroupId:String — Event marker group identificator. See <group> node reference.

See also

showEventMarkerGroup
hideEventMarker
showEventMarker
printChart()method 
public function printChart(settings:XML = null):void

Prints the chart

Parameters
settings:XML (default = null) — Chart printing settings. See <printing> node description for available settings.
removeAllAnnotations()method 
public function removeAllAnnotations():void

Removes all annotations including predefined in chart XML configuration.

removeAnnotation()method 
public function removeAnnotation(id:String):void

Removes an annotation by its identifier.

Parameters
id:String — String annotation identifier.
removeDataRange()method 
public function removeDataRange(dataSetId:String, startDate:Date, endDate:Date):void

Removes data range from a data set by the range of dates.

Note: Changes are applied only on #commitDataChanges() method call.

Note: Consider to use UTC timestamps, because chart data parser interprets dates in CSV to be UTC by default.

Parameters
dataSetId:String — Data set id. See <data set> node reference.
 
startDate:Date — Sets the start of the range to be removed.
 
endDate:Date — Sets the end of the range to be removed.

See also

appendData()
removeDataRow()
Date
removeDataRow()method 
public function removeDataRow(dataSetId:String, date:Date):void

Removes data row from a data set by its date.

Note: Changes are applied only on #commitDataChanges() method call.

Note: Consider to use UTC timestamps, because chart data parser interprets dates in CSV to be UTC by default.

Parameters
dataSetId:String — Data set id. See <data set> node reference.
 
date:Date — The date to be removed from the data set.

See also

appendData()
removeDataRange()
Date
removeEventMarker()method 
public function removeEventMarker(groupId:String, eventMarkerId:String):void

Remove event marker from the specified group.

Changes are applied only on #commitEventMarkersChanges() method call.

Parameters
groupId:String — Group id. See <group> node reference.
 
eventMarkerId:String — Event marker id. See <event> node reference.

See also

addEventMarker()
commitEventMarkersChanges()
removeEventMarkerGroup()method 
public function removeEventMarkerGroup(groupId:String):void

Remove event marker group by group id.

Note: Changes are applied only on #commitEventMarkersChanges() call.

Parameters
groupId:String — Group id. See <group> node reference.

See also

addEventMarkerGroup()
commitEventMarkersChanges()
resetEventMarkerSelection()method 
public function resetEventMarkerSelection(chartId:String):void

Resets event marker selection on the chart.

Parameters
chartId:String — Chart identificator. See <chart> node reference.

See also

selectEventMarker
scrollTo()method 
public function scrollTo(date:Date):void

Scrolls a chart to the given date.

Parameters
date:Date — Start date

See also

zoomTo
selectRange
selectAnnotation()method 
public function selectAnnotation(id:String):void

Selects annotation by its identifier.

Parameters
id:String — String annotation identifier.
selectEventMarker()method 
public function selectEventMarker(eventMarkerGroupId:String, eventMarkerId:String):void

Selects specified event marker.

A marker is referenced by it's id and by an id of the group that contains the marker.

Parameters
eventMarkerGroupId:String — Event marker group identificator. See <group> node reference.
 
eventMarkerId:String — Event marker identificator. See <event> node reference.

See also

resetEventMarkerSelection
selectRange()method 
public function selectRange(type:String, unit:String = null, count:Number = 1, anchor:String = "LastDate"):void

Selects the specified range of dates.

Parameters
type:String — Unit type. Possible values: "YTD", "Max" or "Unit"
 
unit:String (default = null) — Unit type if type parameter is set to "Unit". Can be "Year", "Month", "Day", "Hour", "Minute", "Second", "Millisecond".
 
count:Number (default = 1) — Sets units count if type parameter is "Unit"
 
anchor:String (default = "LastDate") — Sets the date which the range is calculated from (only for "Unit" type). Available values: "LastDate", "FirstDate", "FirstVisibleDate", "LastVisibleDate", "Center".

See also

zoomTo
scrollTo
setAnnotationList()method 
public function setAnnotationList(settings:XML = null):void

Replaces all present annotations with the given list.

Parameters
settings:XML (default = null) — XML node with <annotation_list> structure.
setConfig()method 
public function setConfig(config:XML):void

Replace chart configuration with a new one.

Parameters
config:XML — Config. See <stock> node reference.

See also

config
setEventMarkers()method 
public function setEventMarkers(eventMarkers:XML):void

Replaces current event markers settings with new ones.

Parameters
eventMarkers:XML — New event markers settings. See <event_markers> node description in XML Reference for more information.

See also

setConfig
setSettings
setSettings()method 
public function setSettings(value:XML, preserveSelectedRange:Boolean = true):void

Replaces current chart visual settings with new ones.

Parameters
value:XML — New settings XML. See <settings> node description in XML Reference for more information.
 
preserveSelectedRange:Boolean (default = true) — Sets whether to preserve the selected range or not.

See also

setConfig
setEventMarkers
showEventMarker()method 
public function showEventMarker(eventMarkerGroupId:String, eventMarkerId:String):void

Shows specified hidden event marker.

A marker is referenced by its id and by the id of the group that contains the marker.

Parameters
eventMarkerGroupId:String — Event marker group identificator. See <group> node reference.
 
eventMarkerId:String — Event marker identificator. See <event> node reference.

See also

hideEventMarker
hideEventMarkerGroup
showEventMarkerGroup
showEventMarkerGroup()method 
public function showEventMarkerGroup(eventMarkerGroupId:String):void

Shows specified hidden event marker group.

A marker group is referenced by it's id

Parameters
eventMarkerGroupId:String — Event marker group identificator. See <group> node reference.

See also

hideEventMarkerGroup
hideEventMarker
showEventMarker
startDrawingAnnotation()method 
public function startDrawingAnnotation(type:String, settings:XML = null):void

Starts annotation drawing.

Parameters
type:String — String annotation type. Can be "Ray", "Line", "InfiniteLine", "VerticalLine", "HorizontalLine", "Rectangle", "Ellipse", "Triangle", "TrendChannel", "AndrewsPitchfork", "FibonacciFan", "FibonacciArc", "FibonacciRetracement", "FibonacciTimezones", "Arrow" or "Label".
 
settings:XML (default = null) — XML object with settings. Must correspond to <annotation> configuration.
stopDrawingAnnotation()method 
public function stopDrawingAnnotation():void

Stops annotation drawing.

updateAnnotation()method 
public function updateAnnotation(id:String, settings:XML = null):void

Updates an annotation by the identifier with new settings. It merges existing annotation settings with newly passed. It is recommended to specify only settings you want to change.

Parameters
id:String — String annotation identifier.
 
settings:XML (default = null) — XML object with settings. Must correspond to <annotation> configuration.
updateEventMarker()method 
public function updateEventMarker(groupId:String, eventMarkerId:String, newSettings:XML):void

Updates an event marker with new settings.

Note: changes are applied immediately, calling #commitEventMarkersChanges() is not necessary

Parameters
groupId:String — Group id. See <group> node reference.
 
eventMarkerId:String — Event marker id. See <event> node reference.
 
newSettings:XML — New settings XML. See <event> node reference.
zoomTo()method 
public function zoomTo(startDate:Date, endDate:Date):void

Zooms a chart to the custom range.

Parameters
startDate:Date — Start date
 
endDate:Date — End date

See also

selectRange
scrollTo
Event detail
annotationDeselectevent 
Event object type: com.anychartstock.events.AnnotationEvent

Dispatched when an annotation is deselected.

annotationDrawingFinishevent  
Event object type: com.anychartstock.events.AnnotationEvent

Dispatched when user finishes drawing an annotation.

annotationDrawingProgressevent  
Event object type: com.anychartstock.events.AnnotationDrawingProgressEvent

Dispatched repeatedly when an annotation drawing started by calling the startDrawingAnnotation() method progresses.

See also

startDrawingAnnotation()
annotationDrawingStartevent  
Event object type: com.anychartstock.events.AnnotationEvent

Dispatched when an annotation drawing is started by calling the startDrawingAnnotation() method.

See also

startDrawingAnnotation()
annotationEditingFinishevent  
Event object type: com.anychartstock.events.AnnotationEvent

Dispatched when user finishes editing an annotation.

annotationEditingProgressevent  
Event object type: com.anychartstock.events.AnnotationEvent

Dispatched when an annotation editing progresses.

annotationEditingStartevent  
Event object type: com.anychartstock.events.AnnotationEvent

Dispatched when an annotation editing is started.

annotationRemoveevent  
Event object type: com.anychartstock.events.AnnotationEvent

Dispatched when user removes an annotation using DELETE key.

annotationSelectevent  
Event object type: com.anychartstock.events.AnnotationEvent

Dispatched when an annotation is selected.

chartMouseDownevent  
Event object type: com.anychartstock.events.StockChartMouseEvent
StockChartMouseEvent.type property = com.anychartstock.events.StockChartMouseEvent.MOUSE_DOWN

Dispatched when mouse button is pressed on chart plotting area.

The StockChartMouseEvent.MOUSE_DOWN dispatched when mouse button is pressed on chart plotting area.

chartMouseMoveevent  
Event object type: com.anychartstock.events.StockChartMouseEvent
StockChartMouseEvent.type property = com.anychartstock.events.StockChartMouseEvent.MOUSE_MOVE

Dispatched when mouse moves over chart plotting area.

The StockChartMouseEvent.MOUSE_MOVE dispatched when mouse is moving over chart plotting area.

chartMouseOutevent  
Event object type: com.anychartstock.events.StockChartMouseEvent
StockChartMouseEvent.type property = com.anychartstock.events.StockChartMouseEvent.MOUSE_OUT

Dispatched when mouse leaves chart plotting area.

The StockChartMouseEvent.MOUSE_OUT dispatched when mouse leaves chart plotting area.

chartMouseOverevent  
Event object type: com.anychartstock.events.StockChartMouseEvent
StockChartMouseEvent.type property = com.anychartstock.events.StockChartMouseEvent.MOUSE_OVER

Dispatched when chart plotting area is hovered by mouse.

The StockChartMouseEvent.MOUSE_OVER dispatched when chart plotting area is hovered by mouse.

chartMouseUpevent  
Event object type: com.anychartstock.events.StockChartMouseEvent
StockChartMouseEvent.type property = com.anychartstock.events.StockChartMouseEvent.MOUSE_UP

Dispatched when mouse button is released.

The StockChartMouseEvent.MOUSE_UP dispatched when mouse button is released.

eventMarkerClickevent  
Event object type: com.anychartstock.events.EventMarkerEvent
EventMarkerEvent.type property = com.anychartstock.events.EventMarkerEvent.EVENT_MARKER_CLICK

Dispatched when user clicks an event marker.

The EventMarkerEvent.EVENT_MARKER_CLICK dispatched when a user clicks an event marker.

eventMarkerDeselectevent  
Event object type: com.anychartstock.events.EventMarkerEvent
EventMarkerEvent.type property = com.anychartstock.events.EventMarkerEvent.EVENT_MARKER_DESELECT

Dispatched when an event marker is deselected.

The EventMarkerEvent.EVENT_MARKER_DESELECT dispatched when an event marker is deselected.

eventMarkerDoubleClickevent  
Event object type: com.anychartstock.events.EventMarkerEvent
EventMarkerEvent.type property = com.anychartstock.events.EventMarkerEvent.EVENT_MARKER_DOUBLE_CLICK

Dispatched when user double clicks an event marker.

The EventMarkerEvent.EVENT_MARKER_DOUBLE_CLICK dispatched when a user double clicks an event marker.

eventMarkerMouseOutevent  
Event object type: com.anychartstock.events.EventMarkerEvent
EventMarkerEvent.type property = com.anychartstock.events.EventMarkerEvent.EVENT_MARKER_MOUSE_OUT

Dispatched when mouse leaves an event marker.

The EventMarkerEvent.EVENT_MARKER_MOUSE_OUT dispatched when mouse leaves an event marker.

eventMarkerMouseOverevent  
Event object type: com.anychartstock.events.EventMarkerEvent
EventMarkerEvent.type property = com.anychartstock.events.EventMarkerEvent.EVENT_MARKER_MOUSE_OVER

Dispatched when an event marker is hovered by mouse.

The EventMarkerEvent.EVENT_MARKER_MOUSE_OVER dispatched when an event marker is hovered by mouse.

eventMarkerSelectevent  
Event object type: com.anychartstock.events.EventMarkerEvent
EventMarkerEvent.type property = com.anychartstock.events.EventMarkerEvent.EVENT_MARKER_SELECT

Dispatched when an event marker is selected.

The EventMarkerEvent.EVENT_MARKER_SELECT dispatched when an event marker is selected.

mergedEventMarkerClickevent  
Event object type: com.anychartstock.events.MergedEventMarkerEvent
MergedEventMarkerEvent.type property = com.anychartstock.events.MergedEventMarkerEvent.MERGED_EVENT_MARKER_CLICK

Dispatched when user clicks an event marker group.

The MergedEventMarkerEvent.MERGED_EVENT_MARKER_CLICK dispatched when a user clicks an event marker group.

mergedEventMarkerDeselectevent  
Event object type: com.anychartstock.events.MergedEventMarkerEvent
MergedEventMarkerEvent.type property = com.anychartstock.events.MergedEventMarkerEvent.MERGED_EVENT_MARKER_DESELECT

Dispatched when a merged event marker group is deselected.

The MergedEventMarkerEvent.MERGED_EVENT_MARKER_DESELECT dispatched when a merged event marker group is deselected.

mergedEventMarkerDoubleClickevent  
Event object type: com.anychartstock.events.MergedEventMarkerEvent
MergedEventMarkerEvent.type property = com.anychartstock.events.MergedEventMarkerEvent.MERGED_EVENT_MARKER_DOUBLE_CLICK

Dispatched when user double clicks a merged event marker group.

The MergedEventMarkerEvent.MERGED_EVENT_MARKER_DOUBLE_CLICK dispatched when a user double clicks an event marker.

mergedEventMarkerMouseOutevent  
Event object type: com.anychartstock.events.MergedEventMarkerEvent
MergedEventMarkerEvent.type property = com.anychartstock.events.MergedEventMarkerEvent.MERGED_EVENT_MARKER_MOUSE_OUT

Dispatched when mouse leaves a merged event marker group.

The MergedEventMarkerEvent.MERGED_EVENT_MARKER_MOUSE_OUT dispatched when mouse leaves a merged event marker group.

mergedEventMarkerMouseOverevent  
Event object type: com.anychartstock.events.MergedEventMarkerEvent
MergedEventMarkerEvent.type property = com.anychartstock.events.MergedEventMarkerEvent.MERGED_EVENT_MARKER_MOUSE_OVER

Dispatched when user hovers a merged event marker group.

The MergedEventMarkerEvent.MERGED_EVENT_MARKER_MOUSE_OVER dispatched when a user hovers a merged event marker group.

mergedEventMarkerSelectevent  
Event object type: com.anychartstock.events.MergedEventMarkerEvent
MergedEventMarkerEvent.type property = com.anychartstock.events.MergedEventMarkerEvent.MERGED_EVENT_MARKER_SELECT

Dispatched when a merged event marker group is selected.

The MergedEventMarkerEvent.MERGED_EVENT_MARKER_SELECT dispatched when a merged event marker group is selected.

selectedRangeChangeevent  
Event object type: com.anychartstock.events.SelectedRangeChangeEvent
SelectedRangeChangeEvent.type property = com.anychartstock.events.SelectedRangeChangeEvent.SELECTED_RANGE_CHANGE

Dispatched when the selected range of a chart is changed.

The SelectedRangeChangeEvent.SELECTED_RANGE_CHANGE dispatched when the selected range of a chart is changed.

stockDataLoadevent  
Event object type: com.anychartstock.events.StockEngineEvent

Dispatched when CSV data is loaded.

stockDrawevent  
Event object type: com.anychartstock.events.StockEngineEvent

Dispatched when a chart is drawn.

Constant detail
VERSIONconstant
public static const VERSION:String = "1.7.0 Revision #${dist.revision}"

Component version