ardisia.charts.sparklines.SparklineBar

Package	ardisia.charts.sparklines
Class	public class SparklineBar
Inheritance	SparklineBar SparklineBase spark.components.Group

Sparkline chart that uses bars (columns) to present the data.

View the technical documentation on the Ardisia Labs website for more information.

Default MXML PropertydataProvider

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		autoAxis : Boolean True to automatically set the axis value to the mean of the calculated maximum and minimum y values.	SparklineBase
		autoNormalRange : Boolean If true, the normal range height and y position will be automatically calculated and displayed in the center of the control.	SparklineBase
		autoNormalRangePercent : Number If "autoNormalRange" is true, this is the percentage of the height of the chart covered by the normal range.	SparklineBase
		autoRange : Boolean If true, the minY and maxY values will be automatically calculated from the data provider.	SparklineBase
		axisValue : Number The data value at which to display the axis.	SparklineBase
		dataProvider : IList The data used to populate the spark line.	SparklineBase
		dataTipDefaultPrecision : Number = 2 Default numerical precision for the number formatter if a dataTipFormatFunction or dataTipField is not provided.	SparklineBase
		dataTipField : String Field name on the data to pull the node's data tip string.	SparklineBase
		dataTipFormatFunction : Function User provided function that gets the string to display with the data tip.	SparklineBase
		dataTipHideDelay : Number = 250 Delay before the data tip is hidden.	SparklineBase
		gap : Number The gap between bars in pixels.	SparklineBar
		maxY : Number The maximum displayed y value.	SparklineBase
		minY : Number The minimum displayed y value.	SparklineBase
		normalRangeMaxY : Number If "autoNormalRange" is false, this is the maximum value contained within the normal range.	SparklineBase
		normalRangeMinY : Number If "autoNormalRange" is false, this is the minimum value contained within the normal range.	SparklineBase
		showAxis : Boolean True to display the axis.	SparklineBase
		showDataTip : Boolean = true True to display a data tip on hover.	SparklineBase
		showNormalRange : Boolean True to display a rectangular region used to represent the "normal value range".	SparklineBase
		yField : String Specifies the field on the objects in the dataProvider that contains the y value, or the data value to visually represent.	SparklineBase

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		hideDataTip():void Hide the data tip.	SparklineBase

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		collectionChangeHandler(event:CollectionEvent):void Handles the collection events on the dataProvider.	SparklineBase
		drawAxis(xOffset:Number, yOffset:Number, width:Number, height:Number):void Draws the axis line.	SparklineBase
		drawBackground(width:Number, height:Number):void Draws the background and the border.	SparklineBase
		drawNormalRange(xOffset:Number = 0, yOffset:Number = 0, width:Number = 0, height:Number = 0):void Draws the normal range.	SparklineBase
		eventHandler(event:Event):void Handles events on the component.	SparklineBase
		getDataTipContent(item:Object):Object Returns the contents for the data tip.	SparklineBase
		getYValue(value:Object):Number Returns the y value for display.	SparklineBase
		mouseHandler(event:Event):void Handles the mouse events used to display the data tip.	SparklineBase
		processDataProvider():void Processes the data provider and gets the required values necessary for display.	SparklineBase
		setupDataTip(data:Object):void Setup the data tip.	SparklineBase

Styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
axisAlpha	Type: Number CSS Inheritance: no The alpha of the axis stroke.	SparklineBase
axisColor	Type: uint Format: Color CSS Inheritance: no The color of the axis stroke.	SparklineBase
axisThickness	Type: Number CSS Inheritance: no The thickness of the axis stroke.	SparklineBase
backgroundAlpha	Type: Number CSS Inheritance: no The alpha of the background.	SparklineBase
backgroundColor	Type: uint Format: Color CSS Inheritance: no The color of the background.	SparklineBase
belowAxisBarColor	Type: uint Format: Color CSS Inheritance: no The color of the bars that are drawn below the axis. The default value is `#BBBBBB`.	SparklineBar
defaultBarColor	Type: uint Format: Color CSS Inheritance: no The color of the bars. The default value is `#767676`.	SparklineBar
firstLastColor	Type: uint Format: Color CSS Inheritance: no The displayed color for the first and last data points.	SparklineBase
minMaxColor	Type: uint Format: Color CSS Inheritance: no The displayed color for the maximum and minimum value data points.	SparklineBase
normalRangeAlpha	Type: Number CSS Inheritance: no The alpha of the normal range.	SparklineBase
normalRangeColor	Type: uint Format: Color CSS Inheritance: no The color of the normal range.	SparklineBase

Property Detail

gap

property

gap:Number

The gap between bars in pixels.

The default value is 1.

Implementation
public function get gap():Number
public function set gap(value:Number):void

Mon Sep 15 2014, 01:55 AM -06:00

Ardisia Component Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
SparklineBar	Properties \| Methods \| Styles