| Package | com.yahoo.astra.fl.charts | 
| Class | public class CartesianChart | 
| Inheritance | CartesianChart  Chart  fl.core.UIComponent | 
| Implements | ICategoryChart, IChart | 
| Subclasses | BarChart, ColumnChart, LineChart, StackedColumnChart | 
| Property | Defined by | ||
|---|---|---|---|
| axisLayer : Sprite [read-only]
   Container for all axis elements of the chart. | CartesianChart | ||
| categoryNames : Array 
   The names of the categories displayed on the category axis. | CartesianChart | ||
| constrainViewport : Boolean 
   Determines whether a scrollRect is set on a series to constrain the viewport
    | CartesianChart | ||
| contentBounds : Rectangle [read-only]
   The rectangular bounds where the cartesian chart's data is drawn. | CartesianChart | ||
|  | dataProvider : Object 
   The data to be displayed by the chart. | Chart | |
|  | dataTipFunction : Function 
         If defined, the chart will call the input function to determine the
         text displayed in the chart's data tip. | Chart | |
|  | defaultSeriesType : 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 | ||
|  | legend : ILegend 
         The component that will display a human-readable legend for the chart. | Chart | |
|  | legendLabelFunction : Function 
         If defined, the chart will call the input function to determine the text displayed in 
         in the chart's legend. | 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 | ||
| recalculations : int 
   Number of times label width is recalculated for all axes
    | CartesianChart | ||
| secondaryHorizontalAxis : IAxis 
   The axis representing the horizontal range. | CartesianChart | ||
| secondaryVerticalAxis : IAxis 
   The axis representing the vertical range. | 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 | ||
| Method | Defined by | ||
|---|---|---|---|
| 
   Constructor. | CartesianChart | ||
| 
getAxisStyle(axisName:String, name:String):Object 
   Used to retrieve an axis style
    | CartesianChart | ||
|  | 
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 | ||
|  | 
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 | ||
| 
setVerticalAxisGridLinesStyle(name:String, value:Object):void 
   Sets a style on the vertical axis grid lines. | CartesianChart | ||
| Style | Description | Defined by | ||
|---|---|---|---|---|
|  | Type: Boolean Determines if data changes should be displayed with animation. | Chart | ||
|  | Type: Class Name of the class to use as the skin for the background and border of the component. | Chart | ||
|  | Type: Number The padding that separates the border of the component from its contents, in pixels. | Chart | ||
|  | Type: Class Name of the class to use as the skin for the background and border of the chart's data tip. | Chart | ||
|  | Type: Number If the datatip's content padding is customizable, it will use this value. | Chart | ||
|  | Type: TextFormat The TextFormat object to use to render data tips. | Chart | ||
|  | 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 uintcolor 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 -90and90. The font must be embedded
  in the SWF and theembedFontsstyle on the chart must be set
  totruebefore labels may be rotated. If these conditions
  aren't met, the labels will not be rotated.
  
   The default value is0. | 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 HorizontalAxisRenderer. | 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 textFormatstyle will be used.
  
   The default value isnull. | 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 | ||
| 
seriesBorderAlphas
 | Type: Array The border alpha of the markers in a series. The default value is [1]. | CartesianChart | ||
| 
seriesBorderColors
 | Type: Array The border color of the markers in a series. When not specified, the border color is determined by the color style. The default value is []. | CartesianChart | ||
|  | Type: Array The default colors for each series. | Chart | ||
| 
seriesFillAlphas
 | Type: Array The fill alpha of the markers in a series. The default value is [1]. | CartesianChart | ||
| 
seriesFillColors
 | Type: Array The fill color of the markers in a series. When not specified, the fill color is determined by the color style. The default value is []. | CartesianChart | ||
|  | Type: Array The default size of the markers in pixels. | Chart | ||
|  | 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 uintcolor 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 -90and90. The font must be embedded
  in the SWF and theembedFontsstyle on the chart must be set
  totruebefore labels may be rotated. If these conditions
  aren't met, the labels will not be rotated.
  
   The default value is0. | 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 VerticalAxisRenderer. | 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 textFormatstyle will be used.
  
   The default value isnull. | 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 | ||
| axisLayer | property | 
axisLayer:Sprite  [read-only]Container for all axis elements of the chart.
Implementation    public function get axisLayer():Sprite
| categoryNames | property | 
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
| constrainViewport | property | 
constrainViewport:Boolean  [read-write]Determines whether a scrollRect is set on a series to constrain the viewport
Implementation    public function get constrainViewport():Boolean
    public function set constrainViewport(value:Boolean):void
| contentBounds | property | 
contentBounds:Rectangle  [read-only]The rectangular bounds where the cartesian chart's data is drawn.
Implementation    public function get contentBounds():Rectangle
| horizontalAxis | property | 
horizontalAxis:IAxis  [read-write]The axis representing the horizontal range.
Implementation    public function get horizontalAxis():IAxis
    public function set horizontalAxis(value:IAxis):void
| horizontalAxisTitle | property | 
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
| horizontalField | property | 
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
| overflowEnabled | property | 
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
| recalculations | property | 
recalculations:int  [read-write]Number of times label width is recalculated for all axes
Implementation    public function get recalculations():int
    public function set recalculations(value:int):void
| secondaryHorizontalAxis | property | 
secondaryHorizontalAxis:IAxis  [read-write]The axis representing the horizontal range.
Implementation    public function get secondaryHorizontalAxis():IAxis
    public function set secondaryHorizontalAxis(value:IAxis):void
| secondaryVerticalAxis | property | 
secondaryVerticalAxis:IAxis  [read-write]The axis representing the vertical range.
Implementation    public function get secondaryVerticalAxis():IAxis
    public function set secondaryVerticalAxis(value:IAxis):void
| verticalAxis | property | 
verticalAxis:IAxis  [read-write]The axis representing the vertical range.
Implementation    public function get verticalAxis():IAxis
    public function set verticalAxis(value:IAxis):void
| verticalAxisTitle | property | 
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
| verticalField | property | 
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
| CartesianChart | () | constructor | 
public function CartesianChart()Constructor.
| getAxisStyle | () | method | 
public function getAxisStyle(axisName:String, name:String):ObjectUsed to retrieve an axis style
Parameters| axisName:String | |
| name:String | 
| Object | 
| itemToPosition | () | method | 
public function itemToPosition(series:ISeries, itemIndex:int):PointCalculates 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. | 
| Point—    The display position in pixels on the axis | 
| setHorizontalAxisGridLinesStyle | () | method | 
public function setHorizontalAxisGridLinesStyle(name:String, value:Object):voidSets a style on the horizontal axis grid lines.
Parameters| name:String | |
| value:Object | 
| setVerticalAxisGridLinesStyle | () | method | 
public function setVerticalAxisGridLinesStyle(name:String, value:Object):voidSets a style on the vertical axis grid lines.
Parameters| name:String | |
| value:Object |