| Package | ardisia.charts.sparklines |
| Class | public class SparklineLine |
| Inheritance | SparklineLine  SparklineBase spark.components.Group |
View the technical documentation on the Ardisia Labs website for more information.
Default MXML PropertydataProvider
| 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 | |
| form : String
The type of line to draw. | SparklineLine | ||
| 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 | |
| showMarkers : Boolean
True to display markers (circles) at each data point along the line. | SparklineLine | ||
| showNormalRange : Boolean
True to display a rectangular region used to represent the "normal value
range". | SparklineBase | |
| xField : String
Specifies the field on the objects in the dataProvider that contains
the x value, or the position along the x-axis to display the data point. | SparklineLine | ||
| yField : String
Specifies the field on the objects in the dataProvider that contains
the y value, or the data value to visually represent. | SparklineBase | |
| 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 | |
getXValue(value:Object, index:int):Number
Returns the x value for display. | SparklineLine | ||
| 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 [override]
Processes the data provider and gets the required values necessary for
display. | SparklineLine | ||
| setupDataTip(data:Object):void
Setup the data tip. | SparklineBase | |
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: Number CSS Inheritance: no The alpha of the axis stroke. | SparklineBase | ||
| Type: uint Format: Color CSS Inheritance: no The color of the axis stroke. | SparklineBase | ||
| Type: Number CSS Inheritance: no The thickness of the axis stroke. | SparklineBase | ||
| Type: Number CSS Inheritance: no The alpha of the background. | SparklineBase | ||
| Type: uint Format: Color CSS Inheritance: no The color of the background. | SparklineBase | ||
| Type: uint Format: Color CSS Inheritance: no The displayed color for the first and last data points. | SparklineBase | ||
firstLastMarkerRadius | Type: Number CSS Inheritance: no The radius of the marker (circle) to draw at the first and last point on the line. Only relevant if the "showMarkers" property is true. The default value is 2. | SparklineLine | ||
markerColor | Type: uint Format: Color CSS Inheritance: no The color of the markers (circles) drawn at the data points. Only relevant if any markers are drawn. The default value is #DE3914. | SparklineLine | ||
markerRadius | Type: Number CSS Inheritance: no The default radius of the markers. Only relevant if the "showMarkers" property is true. The default value is 1. | SparklineLine | ||
| Type: uint Format: Color CSS Inheritance: no The displayed color for the maximum and minimum value data points. | SparklineBase | ||
minMaxMarkerRadius | Type: Number CSS Inheritance: no The radius of the marker (circle) to draw at the maximum and minimum valued data points on the line. Only relevant if the "showMarkers" property is true. The default value is 2. | SparklineLine | ||
| Type: Number CSS Inheritance: no The alpha of the normal range. | SparklineBase | ||
| Type: uint Format: Color CSS Inheritance: no The color of the normal range. | SparklineBase | ||
strokeColor | Type: uint Format: Color CSS Inheritance: no The color used when drawing the line. The default value is #32A6DD. | SparklineLine | ||
strokeThickness | Type: Number CSS Inheritance: no The thickness of the drawn line. The default value is 1. | SparklineLine | ||
| form | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesform:StringThe type of line to draw.
Possibilites are "segment,step,vertical,horizontal,reverseStep,curve". See the Flex charting classes for definitions of each.
The default value is "segment".
public function get form():String public function set form(value:String):void| showMarkers | property |
showMarkers:BooleanTrue to display markers (circles) at each data point along the line.
The default value is false.
public function get showMarkers():Boolean public function set showMarkers(value:Boolean):void| xField | property |
xField:StringSpecifies the field on the objects in the dataProvider that contains the x value, or the position along the x-axis to display the data point.
If not set, this class will assume the relative x value is determined by the data's index in the underlying dataProvider.
The default value is "".
public function get xField():String public function set xField(value:String):void| getXValue | () | method |
protected function getXValue(value:Object, index:int):NumberReturns the x value for display.
Parameters
value:Object — the Object
| |
index:int — the index of the data in the dataProvider
|
Number — Number
|
| processDataProvider | () | method |
override protected function processDataProvider():voidProcesses the data provider and gets the required values necessary for display.