Packagecom.yahoo.astra.fl.charts
Classpublic class CartesianChart
InheritanceCartesianChart Inheritance Chart Inheritance fl.core.UIComponent
ImplementsICategoryChart, IChart
SubclassesBarChart, ColumnChart, LineChart, StackedColumnChart

A chart based on the cartesian coordinate system (x, y).


Public Properties
 PropertyDefined by
  categoryNames : Array
The names of the categories displayed on the category axis.
CartesianChart
  contentBounds : Rectangle
[read-only] The rectangular bounds where the cartesian chart's data is drawn.
CartesianChart
 InheriteddataProvider : Object
Chart
 InheriteddataTipFunction : Function
If defined, the chart will call the input function to determine the text displayed in the chart's data tip.
Chart
 InheriteddefaultSeriesType : Object
When raw data (like an Array of Numbers) is encountered where an ISeries instance is expected, it will be converted to this default type.
Chart
  horizontalAxis : IAxis
The axis representing the horizontal range.
CartesianChart
  horizontalAxisTitle : String
The title text displayed on the horizontal axis.
CartesianChart
  horizontalField : String
If the items displayed on the chart are complex objects, the horizontalField string defines the property to access when determining the x value.
CartesianChart
 Inheritedlegend : ILegend
The component that will display a human-readable legend for the chart.
Chart
  overflowEnabled : Boolean
If false, which is the default, the axes will be resized to fit within the defined bounds of the plot area.
CartesianChart
  verticalAxis : IAxis
The axis representing the vertical range.
CartesianChart
  verticalAxisTitle : String
The title text displayed on the horizontal axis.
CartesianChart
  verticalField : String
If the items displayed on the chart are complex objects, the verticalField string defines the property to access when determining the y value.
CartesianChart
Public Methods
 MethodDefined by
  
CartesianChart()
Constructor.
CartesianChart
  
getStyleDefinition():Object
[static]
CartesianChart
 Inherited
indexToSeries(index:int):ISeries
Returns the ISeries object at the specified index.
Chart
  
itemToPosition(series:ISeries, itemIndex:int):Point
Calculates the position of a data point along the axis.
CartesianChart
 Inherited
seriesToIndex(series:ISeries):int
Returns the index within this plot area of the input ISeries object.
Chart
  
setHorizontalAxisGridLinesStyle(name:String, value:Object):void
Sets a style on the horizontal axis grid lines.
CartesianChart
  
setHorizontalAxisStyle(name:String, value:Object):void
Sets a style on the horizontal axis.
CartesianChart
  
setVerticalAxisGridLinesStyle(name:String, value:Object):void
Sets a style on the vertical axis grid lines.
CartesianChart
  
setVerticalAxisStyle(name:String, value:Object):void
Sets a style on the vertical axis.
CartesianChart
Protected Methods
 MethodDefined by
 Inherited
refreshSeries():void
Analyzes the input data and smartly converts it to the correct ISeries type required for drawing.
Chart
Styles
 StyleDescriptionDefined by
 Inherited
animationEnabled
Type: Boolean
Determines if data changes should be displayed with animation.		Chart
 Inherited
backgroundSkin
Type: Class
Name of the class to use as the skin for the background and border of the component.		Chart
 Inherited
contentPadding
Type: Number
The padding that separates the border of the component from its contents, in pixels.		Chart
 Inherited
dataTipBackgroundSkin
Type: Class
Name of the class to use as the skin for the background and border of the chart's data tip.		Chart
 Inherited
dataTipContentPadding
Type: Number
If the datatip's content padding is customizable, it will use this value.		Chart
 Inherited
dataTipTextFormat
Type: TextFormat
The TextFormat object to use to render data tips.		Chart
 Inherited
embedFonts
Type: Boolean
Indicates whether embedded font outlines are used to render the text field.		Chart
  
horizontalAxisColor
Type: uint
The line color for the horizontal axis. The default value is #888a85.		CartesianChart
  
horizontalAxisGridFillAlphas
Type: Array
An Array of alpha values (in the range of 0 to 1) that is used to draw alternating fills between the horizontal axis' grid lines. The default value is [].		CartesianChart
  
horizontalAxisGridFillColors
Type: Array
An Array of uint color values that is used to draw alternating fills between the horizontal axis' grid lines. The default value is [].		CartesianChart
  
horizontalAxisGridLineColor
Type: uint
The line color for the grid lines on the horizontal axis. The default value is #babdb6.		CartesianChart
  
horizontalAxisGridLinesRenderer
Type: Class
The class used to instantiate the horizontal axis grid lines. The default value is DefaultGridLinesRenderer.		CartesianChart
  
horizontalAxisGridLinesStyles
Type: Object
An object containing style values to be passed to the horizontal axis grid lines renderer. The available styles are listed with the class that is used as the grid lines renderer. 		CartesianChart
  
horizontalAxisGridLineWeight
Type: int
The line weight, in pixels, for the grid lines on the horizontal axis. The default value is 1.		CartesianChart
  
horizontalAxisHideOverlappingLabels
Type: Boolean
If true, labels that overlap previously drawn labels on the axis will be hidden. The first and last labels on the axis will always be drawn. The default value is true.		CartesianChart
  
horizontalAxisLabelDistance
Type: Number
The distance, in pixels, between a label and the horizontal axis. The default value is 2.		CartesianChart
  
horizontalAxisLabelRotation
Type: Number
The angle, in degrees, of the labels on the horizontal axis. May be a value between -90 and 90. The font must be embedded in the SWF and the embedFonts style on the chart must be set to true before labels may be rotated. If these conditions aren't met, the labels will not be rotated. The default value is 0.		CartesianChart
  
horizontalAxisMinorGridLineColor
Type: uint
The line color for the minor grid lines on the horizontal axis. The default value is #eeeeec.		CartesianChart
  
horizontalAxisMinorGridLineWeight
Type: int
The line weight, in pixels, for the minor grid lines on the horizontal axis. The default value is 1.		CartesianChart
  
horizontalAxisMinorTickColor
Type: uint
The line color for the minor ticks on the horizontal axis. The default value is #888a85.		CartesianChart
  
horizontalAxisMinorTickLength
Type: Number
The length of the minor ticks on the horizontal axis. The default value is 3.		CartesianChart
  
horizontalAxisMinorTickPosition
Type: String
The position of the minor ticks on the horizontal axis. The default value is "outside".		CartesianChart
  
horizontalAxisMinorTickWeight
Type: int
The line weight, in pixels, for the minor ticks on the horizontal axis. The default value is 1.		CartesianChart
  
horizontalAxisRenderer
Type: Class
The class used to instantiate the visual representation of the horizontal axis. The default value is DefaultAxisRenderer.		CartesianChart
  
horizontalAxisStyles
Type: Object
An object containing style values to be passed to the horizontal axis renderer. The available styles are listed with the class that is used as the axis renderer. 		CartesianChart
  
horizontalAxisTextFormat
Type: TextFormat
Defines the TextFormat used by labels on the horizontal axis. If null, the textFormat style will be used. The default value is null.		CartesianChart
  
horizontalAxisTickColor
Type: uint
The line color for the ticks on the horizontal axis. The default value is #888a85.		CartesianChart
  
horizontalAxisTickLength
Type: Number
The length, in pixels, of the ticks on the horizontal axis. The default value is 4.		CartesianChart
  
horizontalAxisTickPosition
Type: String
The position of the ticks on the horizontal axis. The default value is "cross".		CartesianChart
  
horizontalAxisTickWeight
Type: int
The line weight, in pixels, for the ticks on the horizontal axis. The default value is 1.		CartesianChart
  
horizontalAxisTitleTextFormat
Type: TextFormat
The TextFormat object to use to render the horizontal axis title label. The default value is TextFormat("_sans", 11, 0x000000, false, false, false, '', '', TextFormatAlign.LEFT, 0, 0, 0, 0).		CartesianChart
  
horizontalAxisWeight
Type: int
The line weight, in pixels, for the horizontal axis. The default value is 1.		CartesianChart
 Inherited
seriesColors
Type: Array
The default colors for each series.		Chart
 Inherited
seriesMarkerSizes
Type: Array
The default size of the markers in pixels.		Chart
 Inherited
seriesMarkerSkins
Type: Array
An Array containing the default skin classes for each series.		Chart
  
showHorizontalAxis
Type: Boolean
If false, the horizontal axis is not drawn. Titles, labels, ticks, and grid lines may still be drawn, however, so you must specifically hide each item if nothing should be drawn. The default value is true.		CartesianChart
  
showHorizontalAxisGridLines
Type: Boolean
If true, grid lines will be displayed on the horizontal axis. The default value is false.		CartesianChart
  
showHorizontalAxisLabels
Type: Boolean
If true, labels will be displayed on the horizontal axis. The default value is true.		CartesianChart
  
showHorizontalAxisMinorGridLines
Type: Boolean
If true, minor grid lines will be displayed on the horizontal axis. The default value is false.		CartesianChart
  
showHorizontalAxisMinorTicks
Type: Boolean
If true, ticks will be displayed on the horizontal axis at minor positions. The default value is true.		CartesianChart
  
showHorizontalAxisTicks
Type: Boolean
If true, ticks will be displayed on the horizontal axis. The default value is true.		CartesianChart
  
showHorizontalAxisTitle
Type: Boolean
If true, the horizontal axis title will be displayed. The default value is 2.		CartesianChart
  
showVerticalAxis
Type: Boolean
If false, the vertical axis is not drawn. Titles, labels, ticks, and grid lines may still be drawn, however, so you must specifically hide each item if nothing should be drawn. The default value is true.		CartesianChart
  
showVerticalAxisGridLines
Type: Boolean
If true, grid lines will be displayed on the vertical axis. The default value is false.		CartesianChart
  
showVerticalAxisLabels
Type: Boolean
If true, labels will be displayed on the vertical axis. The default value is true.		CartesianChart
  
showVerticalAxisMinorGridLines
Type: Boolean
If true, minor grid lines will be displayed on the vertical axis. The default value is false.		CartesianChart
  
showVerticalAxisMinorTicks
Type: Boolean
If true, ticks will be displayed on the vertical axis at minor positions. The default value is true.		CartesianChart
  
showVerticalAxisTicks
Type: Boolean
If true, ticks will be displayed on the vertical axis. The default value is true.		CartesianChart
  
showVerticalAxisTitle
Type: Boolean
If true, the vertical axis title will be displayed. The default value is 2.		CartesianChart
  
verticalAxisColor
Type: uint
The line color for the vertical axis. The default value is #888a85.		CartesianChart
  
verticalAxisGridFillAlphas
Type: Array
An Array of alpha values (in the range of 0 to 1) that is used to draw alternating fills between the vertical axis' grid lines. The default value is [].		CartesianChart
  
verticalAxisGridFillColors
Type: Array
An Array of uint color values that is used to draw alternating fills between the vertical axis' grid lines. The default value is [].		CartesianChart
  
verticalAxisGridLineColor
Type: uint
The line color for the grid lines on the vertical axis. The default value is #babdb6.		CartesianChart
  
verticalAxisGridLinesRenderer
Type: Class
The class used to instantiate the vertical axis grid lines. The default value is DefaultGridLinesRenderer.		CartesianChart
  
verticalAxisGridLinesStyles
Type: Object
An object containing style values to be passed to the vertical axis grid lines renderer. The available styles are listed with the class that is used as the grid lines renderer. 		CartesianChart
  
verticalAxisGridLineWeight
Type: int
The line weight, in pixels, for the grid lines on the vertical axis. The default value is 1.		CartesianChart
  
verticalAxisHideOverlappingLabels
Type: Boolean
If true, labels that overlap previously drawn labels on the axis will be hidden. The first and last labels on the axis will always be drawn. The default value is true.		CartesianChart
  
verticalAxisLabelDistance
Type: Number
The distance, in pixels, between a label and the vertical axis. The default value is 2.		CartesianChart
  
verticalAxisLabelRotation
Type: Number
The angle, in degrees, of the labels on the vertical axis. May be a value between -90 and 90. The font must be embedded in the SWF and the embedFonts style on the chart must be set to true before labels may be rotated. If these conditions aren't met, the labels will not be rotated. The default value is 0.		CartesianChart
  
verticalAxisMinorGridLineColor
Type: uint
The line color for the minor grid lines on the vertical axis. The default value is #eeeeec.		CartesianChart
  
verticalAxisMinorGridLineWeight
Type: int
The line weight, in pixels, for the minor grid lines on the vertical axis. The default value is 1.		CartesianChart
  
verticalAxisMinorTickColor
Type: uint
The line color for the minor ticks on the vertical axis. The default value is #888a85.		CartesianChart
  
verticalAxisMinorTickLength
Type: Number
The length of the minor ticks on the vertical axis. The default value is 3.		CartesianChart
  
verticalAxisMinorTickPosition
Type: String
The position of the minor ticks on the vertical axis. The default value is "outside".		CartesianChart
  
verticalAxisMinorTickWeight
Type: int
The line weight, in pixels, for the minor ticks on the vertical axis. The default value is 1.		CartesianChart
  
verticalAxisRenderer
Type: Class
The class used to instantiate the visual representation of the vertical axis. The default value is DefaultAxisRenderer.		CartesianChart
  
verticalAxisStyles
Type: Object
An object containing style values to be passed to the vertical axis renderer. The available styles are listed with the class that is used as the axis renderer. 		CartesianChart
  
verticalAxisTextFormat
Type: TextFormat
Defines the TextFormat used by labels on the vertical axis. If null, the textFormat style will be used. The default value is null.		CartesianChart
  
verticalAxisTickColor
Type: uint
The line color for the ticks on the vertical axis. The default value is #888a85.		CartesianChart
  
verticalAxisTickLength
Type: Number
The length, in pixels, of the ticks on the vertical axis. The default value is 4.		CartesianChart
  
verticalAxisTickPosition
Type: String
The position of the ticks on the vertical axis. The default value is "cross".		CartesianChart
  
verticalAxisTickWeight
Type: int
The line weight, in pixels, for the ticks on the vertical axis. The default value is 1.		CartesianChart
  
verticalAxisTitleTextFormat
Type: TextFormat
The TextFormat object to use to render the vertical axis title label. The default value is TextFormat("_sans", 11, 0x000000, false, false, false, '', '', TextFormatAlign.LEFT, 0, 0, 0, 0).		CartesianChart
  
verticalAxisWeight
Type: int
The line weight, in pixels, for the vertical axis. The default value is 1.		CartesianChart
Property detail
categoryNamesproperty
categoryNames:Array  [read-write]

The names of the categories displayed on the category axis. If the chart does not have a category axis, this value will be ignored.

Implementation
    public function get categoryNames():Array
    public function set categoryNames(value:Array):void
contentBoundsproperty 
contentBounds:Rectangle  [read-only]

The rectangular bounds where the cartesian chart's data is drawn.

Implementation
    public function get contentBounds():Rectangle
horizontalAxisproperty 
horizontalAxis:IAxis  [read-write]

The axis representing the horizontal range.

Implementation
    public function get horizontalAxis():IAxis
    public function set horizontalAxis(value:IAxis):void
horizontalAxisTitleproperty 
horizontalAxisTitle:String  [read-write]

The title text displayed on the horizontal axis.

Implementation
    public function get horizontalAxisTitle():String
    public function set horizontalAxisTitle(value:String):void
horizontalFieldproperty 
horizontalField:String  [read-write]

If the items displayed on the chart are complex objects, the horizontalField string defines the property to access when determining the x value.

Implementation
    public function get horizontalField():String
    public function set horizontalField(value:String):void
overflowEnabledproperty 
overflowEnabled:Boolean  [read-write]

If false, which is the default, the axes will be resized to fit within the defined bounds of the plot area. However, if set to true, the axes themselves will grow to fit the plot area bounds and the labels and other items that normally cause the resize will be drawn outside.

Implementation
    public function get overflowEnabled():Boolean
    public function set overflowEnabled(value:Boolean):void
verticalAxisproperty 
verticalAxis:IAxis  [read-write]

The axis representing the vertical range.

Implementation
    public function get verticalAxis():IAxis
    public function set verticalAxis(value:IAxis):void
verticalAxisTitleproperty 
verticalAxisTitle:String  [read-write]

The title text displayed on the horizontal axis.

Implementation
    public function get verticalAxisTitle():String
    public function set verticalAxisTitle(value:String):void
verticalFieldproperty 
verticalField:String  [read-write]

If the items displayed on the chart are complex objects, the verticalField string defines the property to access when determining the y value.

Implementation
    public function get verticalField():String
    public function set verticalField(value:String):void
Constructor detail
CartesianChart()constructor
public function CartesianChart()

Constructor.

Method detail
getStyleDefinition()method
public static function getStyleDefinition():Object

Returns
Object
itemToPosition()method 
public function itemToPosition(series:ISeries, itemIndex:int):Point

Calculates the position of a data point along the axis.

Parameters
series:ISeries — The series in which the data appears.
 
itemIndex:int — The index of the item within the series.

Returns
Point — The display position in pixels on the axis
setHorizontalAxisGridLinesStyle()method 
public function setHorizontalAxisGridLinesStyle(name:String, value:Object):void

Sets a style on the horizontal axis grid lines.

Parameters
name:String
 
value:Object
setHorizontalAxisStyle()method 
public function setHorizontalAxisStyle(name:String, value:Object):void

Sets a style on the horizontal axis.

Parameters
name:String
 
value:Object
setVerticalAxisGridLinesStyle()method 
public function setVerticalAxisGridLinesStyle(name:String, value:Object):void

Sets a style on the vertical axis grid lines.

Parameters
name:String
 
value:Object
setVerticalAxisStyle()method 
public function setVerticalAxisStyle(name:String, value:Object):void

Sets a style on the vertical axis.

Parameters
name:String
 
value:Object