YUI AS Component Documentation | All Packages | All Classes | Index | Frames No Frames |
Class ColumnChart

Package | com.yahoo.astra.fl.charts
Class | public class ColumnChart
Inheritance | ColumnChart CartesianChart Chart fl.core.UIComponent

A chart that displays its data points with vertical columns.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | axisLayer : Sprite 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 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

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined by
--- | --- | ---
|  | ColumnChart() Constructor. | ColumnChart
|  | 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

Protected Methods
Hide Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined by
--- | --- | ---
|  | refreshSeries():void Analyzes the input data and smartly converts it to the correct ISeries type required for drawing. | Chart

Styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined by
--- | --- | --- | ---
|  | animationEnabled | Type: Boolean Determines if data changes should be displayed with animation. | Chart
|  | backgroundSkin | Type: Class Name of the class to use as the skin for the background and border of the component. | Chart
|  | contentPadding | Type: Number The padding that separates the border of the component from its contents, in pixels. | Chart
|  | dataTipBackgroundSkin | Type: Class Name of the class to use as the skin for the background and border of the chart's data tip. | Chart
|  | dataTipContentPadding | Type: Number If the datatip's content padding is customizable, it will use this value. | Chart
|  | dataTipTextFormat | Type: TextFormat The TextFormat object to use to render data tips. | Chart
|  | 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. | 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. | CartesianChart
|  | horizontalAxisGridFillColors | Type: Array An Array of `uint` color values that is used to draw alternating fills between the horizontal axis' grid lines. | CartesianChart
|  | horizontalAxisGridLineColor | Type: uint The line color for the grid lines on the horizontal axis. | CartesianChart
|  | horizontalAxisGridLinesRenderer | Type: Class The class used to instantiate the horizontal axis grid lines. | CartesianChart
|  | horizontalAxisGridLinesStyles | Type: Object An object containing style values to be passed to the horizontal axis grid lines renderer. | CartesianChart
|  | horizontalAxisGridLineWeight | Type: int The line weight, in pixels, for the grid lines on the horizontal axis. | CartesianChart
|  | horizontalAxisHideOverlappingLabels | Type: Boolean If true, labels that overlap previously drawn labels on the axis will be hidden. | CartesianChart
|  | horizontalAxisLabelDistance | Type: Number The distance, in pixels, between a label and the horizontal axis. | CartesianChart
|  | horizontalAxisLabelRotation | Type: Number The angle, in degrees, of the labels on the horizontal axis. | CartesianChart
|  | horizontalAxisMinorGridLineColor | Type: uint The line color for the minor grid lines on the horizontal axis. | CartesianChart
|  | horizontalAxisMinorGridLineWeight | Type: int The line weight, in pixels, for the minor grid lines on the horizontal axis. | CartesianChart
|  | horizontalAxisMinorTickColor | Type: uint The line color for the minor ticks on the horizontal axis. | CartesianChart
|  | horizontalAxisMinorTickLength | Type: Number The length of the minor ticks on the horizontal axis. | CartesianChart
|  | horizontalAxisMinorTickPosition | Type: String The position of the minor ticks on the horizontal axis. | CartesianChart
|  | horizontalAxisMinorTickWeight | Type: int The line weight, in pixels, for the minor ticks on the horizontal axis. | CartesianChart
|  | horizontalAxisRenderer | Type: Class The class used to instantiate the visual representation of the horizontal axis. | CartesianChart
|  | horizontalAxisStyles | Type: Object An object containing style values to be passed to the horizontal axis renderer. | CartesianChart
|  | horizontalAxisTextFormat | Type: TextFormat Defines the TextFormat used by labels on the horizontal axis. | CartesianChart
|  | horizontalAxisTickColor | Type: uint The line color for the ticks on the horizontal axis. | CartesianChart
|  | horizontalAxisTickLength | Type: Number The length, in pixels, of the ticks on the horizontal axis. | CartesianChart
|  | horizontalAxisTickPosition | Type: String The position of the ticks on the horizontal axis. | CartesianChart
|  | horizontalAxisTickWeight | Type: int The line weight, in pixels, for the ticks on the horizontal axis. | CartesianChart
|  | horizontalAxisTitleTextFormat | Type: TextFormat The TextFormat object to use to render the horizontal axis title label. | CartesianChart
|  | horizontalAxisWeight | Type: int The line weight, in pixels, for the horizontal axis. | CartesianChart
|  | seriesBorderAlphas | Type: Array The border alpha of the markers in a series. | CartesianChart
|  | seriesBorderColors | Type: Array The border color of the markers in a series. | CartesianChart
|  | seriesColors | Type: Array The default colors for each series. | Chart
|  | seriesFillAlphas | Type: Array The fill alpha of the markers in a series. | CartesianChart
|  | seriesFillColors | Type: Array The fill color of the markers in a series. | CartesianChart
|  | seriesItemSpacing | Type: Number The amount of space between items within a series The default value is `0`. | ColumnChart
|  | seriesMarkerSizes | Type: Array The default size of the markers in pixels. | Chart
|  | 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. | CartesianChart
|  | showHorizontalAxisGridLines | Type: Boolean If true, grid lines will be displayed on the horizontal axis. | CartesianChart
|  | showHorizontalAxisLabels | Type: Boolean If true, labels will be displayed on the horizontal axis. | CartesianChart
|  | showHorizontalAxisMinorGridLines | Type: Boolean If true, minor grid lines will be displayed on the horizontal axis. | CartesianChart
|  | showHorizontalAxisMinorTicks | Type: Boolean If true, ticks will be displayed on the horizontal axis at minor positions. | CartesianChart
|  | showHorizontalAxisTicks | Type: Boolean If true, ticks will be displayed on the horizontal axis. | CartesianChart
|  | showHorizontalAxisTitle | Type: Boolean If true, the horizontal axis title will be displayed. | CartesianChart
|  | showVerticalAxis | Type: Boolean If false, the vertical axis is not drawn. | CartesianChart
|  | showVerticalAxisGridLines | Type: Boolean If true, grid lines will be displayed on the vertical axis. | CartesianChart
|  | showVerticalAxisLabels | Type: Boolean If true, labels will be displayed on the vertical axis. | CartesianChart
|  | showVerticalAxisMinorGridLines | Type: Boolean If true, minor grid lines will be displayed on the vertical axis. | CartesianChart
|  | showVerticalAxisMinorTicks | Type: Boolean If true, ticks will be displayed on the vertical axis at minor positions. | CartesianChart
|  | showVerticalAxisTicks | Type: Boolean If true, ticks will be displayed on the vertical axis. | CartesianChart
|  | showVerticalAxisTitle | Type: Boolean If true, the vertical axis title will be displayed. | CartesianChart
|  | verticalAxisColor | Type: uint The line color for the vertical axis. | 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. | CartesianChart
|  | verticalAxisGridFillColors | Type: Array An Array of `uint` color values that is used to draw alternating fills between the vertical axis' grid lines. | CartesianChart
|  | verticalAxisGridLineColor | Type: uint The line color for the grid lines on the vertical axis. | CartesianChart
|  | verticalAxisGridLinesRenderer | Type: Class The class used to instantiate the vertical axis grid lines. | CartesianChart
|  | verticalAxisGridLinesStyles | Type: Object An object containing style values to be passed to the vertical axis grid lines renderer. | CartesianChart
|  | verticalAxisGridLineWeight | Type: int The line weight, in pixels, for the grid lines on the vertical axis. | CartesianChart
|  | verticalAxisHideOverlappingLabels | Type: Boolean If true, labels that overlap previously drawn labels on the axis will be hidden. | CartesianChart
|  | verticalAxisLabelDistance | Type: Number The distance, in pixels, between a label and the vertical axis. | CartesianChart
|  | verticalAxisLabelRotation | Type: Number The angle, in degrees, of the labels on the vertical axis. | CartesianChart
|  | verticalAxisMinorGridLineColor | Type: uint The line color for the minor grid lines on the vertical axis. | CartesianChart
|  | verticalAxisMinorGridLineWeight | Type: int The line weight, in pixels, for the minor grid lines on the vertical axis. | CartesianChart
|  | verticalAxisMinorTickColor | Type: uint The line color for the minor ticks on the vertical axis. | CartesianChart
|  | verticalAxisMinorTickLength | Type: Number The length of the minor ticks on the vertical axis. | CartesianChart
|  | verticalAxisMinorTickPosition | Type: String The position of the minor ticks on the vertical axis. | CartesianChart
|  | verticalAxisMinorTickWeight | Type: int The line weight, in pixels, for the minor ticks on the vertical axis. | CartesianChart
|  | verticalAxisRenderer | Type: Class The class used to instantiate the visual representation of the vertical axis. | CartesianChart
|  | verticalAxisStyles | Type: Object An object containing style values to be passed to the vertical axis renderer. | CartesianChart
|  | verticalAxisTextFormat | Type: TextFormat Defines the TextFormat used by labels on the vertical axis. | CartesianChart
|  | verticalAxisTickColor | Type: uint The line color for the ticks on the vertical axis. | CartesianChart
|  | verticalAxisTickLength | Type: Number The length, in pixels, of the ticks on the vertical axis. | CartesianChart
|  | verticalAxisTickPosition | Type: String The position of the ticks on the vertical axis. | CartesianChart
|  | verticalAxisTickWeight | Type: int The line weight, in pixels, for the ticks on the vertical axis. | CartesianChart
|  | verticalAxisTitleTextFormat | Type: TextFormat The TextFormat object to use to render the vertical axis title label. | CartesianChart
|  | verticalAxisWeight | Type: int The line weight, in pixels, for the vertical axis. | CartesianChart

Constructor detail

ColumnChart | () | constructor

`public function ColumnChart()`

Constructor.