Package | com.yahoo.astra.fl.charts |
Class | public class CartesianChart |
Inheritance | CartesianChart ![]() ![]() |
Implements | ICategoryChart, IPlotArea |
Subclasses | BarChart, ColumnChart, LineChart |
Property | Defined by | ||
---|---|---|---|
categoryNames : Array
The names of the categories displayed on the category axis.
| CartesianChart | ||
![]() | contentBounds : Rectangle
The
Rectangle representing the area where content should be
drawn within the plot area. | Chart | |
![]() | dataProvider : Object
The data the chart displays.
| 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 data is encountered where an ISeries 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 | |
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 |
Method | Defined by | ||
---|---|---|---|
Constructor.
| CartesianChart | ||
An interface for a chart with a drawing area.
| CartesianChart | ||
axisToField(axis:IAxis):String
An interface for a chart with a drawing area.
| CartesianChart | ||
Calculates the position of a data point along the axis.
| CartesianChart | ||
fieldToAxis(field:String):IAxis
An interface for a chart with a drawing area.
| CartesianChart | ||
getStyleDefinition():Object
[static]
| CartesianChart | ||
![]() |
indexToSeries(index:int):ISeries
Returns the ISeries object at the specified index.
| Chart | |
![]() |
seriesToIndex(series:ISeries):int
Returns the index within this plot area of the input ISeries object.
| Chart |
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 | ||
horizontalAxisColor
| Type: uint The line color for the horizontal axis. The default value is #888a85 . | CartesianChart | ||
horizontalAxisGridLineColor
| Type: uint The line color for the grid lines on the horizontal axis. The default value is #babdb6 . | CartesianChart | ||
horizontalAxisGridLineWeight
| Type: int The line weight, in pixels, for the grid lines on the horizontal axis. The default value is 1 . | CartesianChart | ||
horizontalAxisLabelDistance
| Type: Number The distance, in pixels, between a label and the horizontal axis. The default value is 2 . | 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 | ||
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 | ||
![]() | Type: Array The default colors for each series. | Chart | ||
![]() | Type: Array The default size of the markers in pixels. | Chart | ||
![]() | Type: Array An Array containing the default skin classes for each series. | Chart | ||
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 | ||
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 | ||
verticalAxisGridLineColor
| Type: uint The line color for the grid lines on the vertical axis. The default value is #babdb6 . | CartesianChart | ||
verticalAxisGridLineWeight
| Type: int The line weight, in pixels, for the grid lines on the vertical axis. The default value is 1 . | CartesianChart | ||
verticalAxisLabelDistance
| Type: Number The distance, in pixels, between a label and the vertical axis. The default value is 2 . | 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 | ||
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 |
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
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
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.
axisAndSeriesToField | () | method |
public function axisAndSeriesToField(axis:IAxis, series:ISeries):String
An interface for a chart with a drawing area.
Parametersaxis:IAxis |
|
series:ISeries |
String |
axisToField | () | method |
public function axisToField(axis:IAxis):String
An interface for a chart with a drawing area.
Parametersaxis:IAxis |
String |
dataToLocal | () | method |
public function dataToLocal(data:Object, series:ISeries):Point
Calculates the position of a data point along the axis.
Parametersdata:Object — The data used to determine the position
|
|
series:ISeries — The series in which the data appears.
|
Point — The display position in pixels on the axis
|
fieldToAxis | () | method |
public function fieldToAxis(field:String):IAxis
An interface for a chart with a drawing area.
Parametersfield:String |
IAxis |
getStyleDefinition | () | method |
public static function getStyleDefinition():Object
Returns
Object |