Package | org.axiis.charts.axis |
Class | public class AxisBase |
Inheritance | AxisBase ![]() ![]() ![]() |
Subclasses | HAxis, VAxis |
Property | Defined By | ||
---|---|---|---|
![]() | bounds : Rectangle
A rectangle that acts as the bounding area for this layout
| AbstractLayout | |
![]() | buttonMode : Boolean = false
The value of the buttonMode flag to set for each child Sprite
| BaseLayout | |
![]() | childSprites : Array [read-only]
The AxiisSprites this layout has created to render each item in its dataProvider. | AbstractLayout | |
![]() | currentDatum : * [read-only]
The item in the dataProvider that the layout is currently rendering. | AbstractLayout | |
![]() | currentIndex : int [read-only]
The index of the item in the dataProvider that the layout is
currently rendering. | AbstractLayout | |
![]() | currentLabel : String [read-only]
The label of the item in the dataProvider that the layout is
currently rendering, as determine by taking currentDatum[labelField],
if a labelField is defined. | AbstractLayout | |
![]() | currentReference : Geometry [read-only]
The geometry that is being used to render the current data item as it
appears after the necessary iterations of the referenceRepeater have
been executed. | AbstractLayout | |
![]() | currentValue : * [read-only]
The value of the item in the dataProvider that the layout is
currently rendering, as determined by taking currentDatum[dataField],
if a dataField is defined. | AbstractLayout | |
![]() | dataField : Object
The property within each item in the dataProvider that contains the
field used to determine the value of the item. | AbstractLayout | |
![]() | dataFilterFunction : Function
This provides a way to further refine a layouts dataProvider by
providing access to a custom filter data filter function. | AbstractLayout | |
![]() | dataFilterIndex : Number [read-only] | AbstractLayout | |
![]() | dataItems : Array [read-only]
An array of objects extracted from the dataProvider. | AbstractLayout | |
![]() | dataProvider : Object
An Array, ArrayCollection, or Object containing the data this layout
should render. | AbstractLayout | |
![]() | dataTipAnchorPoint : Object
An Object with x and y values used to determine the location of anchored data tips. | AbstractLayout | |
![]() | dataTipContentClass : IFactory
A ClassFactory that creates the UIComponent that should be used in the data tip for this AxiisSprite. | AbstractLayout | |
![]() | dataTipContentComponent : UIComponent
A component that gets passed to any data tip. | AbstractLayout | |
![]() | dataTipLabelFunction : Function
A method used to determine the text that appears in the data tip for
an item rendered by this layout. | AbstractLayout | |
![]() | dataTipManager : IDataTipManager
The IDataTipManager responsible for laying out data tips for children of this layout. | AbstractLayout | |
![]() | drawingGeometries : Array
An array of geometries that should be drawn for each item in the data
provider. | AbstractLayout | |
![]() | fills : Array
A placeholder for fills used within this layout. | AbstractLayout | |
fontColor : Number
The color of the tick mark labels. | AxisBase | ||
fontFamily : String
The name of the font used to render the tick mark labels. | AxisBase | ||
fontSize : Number
The size of the font used to render the tick mark labels. | AxisBase | ||
fontWeight : String
The weight ("normal" or "bold") of the tick mark labels. | AxisBase | ||
gridFill : IGraphicsFill
The fill used to render the grid areas that occur at alternating
major tick marks. | AxisBase | ||
gridStroke : IGraphicsStroke
The stroke that should be used to render the grid lines
running across this axis. | AxisBase | ||
![]() | height : Number
The height of the layout. | AbstractLayout | |
![]() | inheritParentBounds : Boolean = true
Whether or not the drawingGeometries should should have their initial
bounds set to the currentReference of the parent layout. | BaseLayout | |
![]() | itemCount : int [read-only]
The number of items in the dataProvider. | AbstractLayout | |
![]() | labelField : Object
The property within each item in the dataProvider that contains the
field used to determine the label for the item. | AbstractLayout | |
labelFunction : Function
A function that is used to determine how each item in the
dataProvider should be labeled along the axis. | AxisBase | ||
![]() | layouts : Array
The layouts that should be displayed within this layout. | AbstractLayout | |
majorTickLength : Number
The length of each major tick mark in pixels. | AxisBase | ||
majorTickSpacing : Number
The space between successive major tick marks. | AxisBase | ||
minorTickLength : Number
The length of each minor tick mark in pixels. | AxisBase | ||
![]() | msPerRenderFrame : Number = 50
Determines how long (milliseconds) a layout will spend on a given frame to render X number of datums
| AbstractLayout | |
![]() | name : String
A string used to identify this layout. | AbstractLayout | |
![]() | palettes : Array
A placeholder for palettes used within this layout. | AbstractLayout | |
![]() | parentLayout : AbstractLayout
A reference to the layout that contains this layout. | AbstractLayout | |
![]() | referenceRepeater : GeometryRepeater
A GeometryRepeater that will be applied to the drawingGeometries once
for each item in the dataProvider. | AbstractLayout | |
![]() | rendering : Boolean [read-only]
Whether or not this layout is currently in a render cycle. | AbstractLayout | |
![]() | scaleFill : Boolean
Whether or not the fills in this geometry should be scaled within the
bounds rectangle. | BaseLayout | |
![]() | showDataTips : Boolean
A flag that indicates to DataCanvas that it should listen for mouse
events that signal the need to create a data tip. | AbstractLayout | |
showGridArea : Boolean
Whether or not grid cells are displayed. | AxisBase | ||
showGridLine : Boolean
Whether or not lines are drawn between grid cells. | AxisBase | ||
showLabels : Boolean
Whether or not the labels on this axis are shown. | AxisBase | ||
![]() | states : Array
An array of states that should be applied to this layout. | AbstractLayout | |
![]() | strokes : Array
A placeholder for strokes used within this layout. | AbstractLayout | |
tickGap : Number
The number of values between successive minor tick marks. | AxisBase | ||
tickStroke : SolidStroke
The stroke used to render each tick mark. | AxisBase | ||
![]() | useHandCursor : Boolean = false
The value of the useHandCursor flag to set each child Sprite
| BaseLayout | |
![]() | visible : Boolean
Whether or not this layout is visible. | AbstractLayout | |
![]() | width : Number
The width of the layout. | AbstractLayout | |
![]() | x : Number
The horizontal position of the top left corner of this layout within
its parent. | AbstractLayout | |
![]() | y : Number
The vertical position of the top left corner of this layout within
its parent. | AbstractLayout |
Method | Defined By | ||
---|---|---|---|
AxisBase()
Constructor. | AxisBase | ||
![]() | getProperty(obj:Object, propertyName:Object):*
Uses ObjectUtils.getProperty(this,obj,propertyName) to get a property on an object. | AbstractLayout | |
![]() | getSprite(owner:DataCanvas):Sprite
Returns the Sprite associated with this layout if owner is
in fact the owner of this layout. | AbstractLayout | |
![]() | invalidate():void
Notifies the DataCanvas that this layout needs to be rendered. | AbstractLayout | |
![]() | invalidateDataProvider():void
Iterates over the items in the dataProvider and stores them in
dataItems. | AbstractLayout | |
![]() | registerOwner(dataCanvas:DataCanvas):void
Registers a DisplayObject as the owner of this layout. | AbstractLayout | |
![]() | render(newSprite:AxiisSprite = null):void
Draws this layout to the specified AxiisSprite, tracking all changes
made by data binding or the referenceRepeater. | BaseLayout |
fontColor | property |
fontColor:Number
[read-write] The color of the tick mark labels.
This property can be used as the source for data binding.
public function get fontColor():Number
public function set fontColor(value:Number):void
fontFamily | property |
fontFamily:String
[read-write] The name of the font used to render the tick mark labels.
This property can be used as the source for data binding.
public function get fontFamily():String
public function set fontFamily(value:String):void
fontSize | property |
fontSize:Number
[read-write] The size of the font used to render the tick mark labels.
This property can be used as the source for data binding.
public function get fontSize():Number
public function set fontSize(value:Number):void
fontWeight | property |
fontWeight:String
[read-write] The weight ("normal" or "bold") of the tick mark labels.
This property can be used as the source for data binding.
public function get fontWeight():String
public function set fontWeight(value:String):void
gridFill | property |
gridFill:IGraphicsFill
[read-write] The fill used to render the grid areas that occur at alternating major tick marks.
This property can be used as the source for data binding.
public function get gridFill():IGraphicsFill
public function set gridFill(value:IGraphicsFill):void
gridStroke | property |
gridStroke:IGraphicsStroke
[read-write] The stroke that should be used to render the grid lines running across this axis.
This property can be used as the source for data binding.
public function get gridStroke():IGraphicsStroke
public function set gridStroke(value:IGraphicsStroke):void
labelFunction | property |
labelFunction:Function
[read-write] A function that is used to determine how each item in the dataProvider should be labeled along the axis.
The function takes a single parameter, the Object to be plotted, and should return the String that should be placed on the axis. The default implementation assumes that each Object in the dataProvider is numeric, rounds that number, and returns the that value as a String.
This property can be used as the source for data binding.
public function get labelFunction():Function
public function set labelFunction(value:Function):void
majorTickLength | property |
majorTickLength:Number
[read-write] The length of each major tick mark in pixels.
This property can be used as the source for data binding.
public function get majorTickLength():Number
public function set majorTickLength(value:Number):void
majorTickSpacing | property |
majorTickSpacing:Number
[read-write] The space between successive major tick marks.
This property can be used as the source for data binding.
public function get majorTickSpacing():Number
public function set majorTickSpacing(value:Number):void
minorTickLength | property |
minorTickLength:Number
[read-write] The length of each minor tick mark in pixels.
This property can be used as the source for data binding.
public function get minorTickLength():Number
public function set minorTickLength(value:Number):void
showGridArea | property |
showGridArea:Boolean
[read-write] Whether or not grid cells are displayed.
This property can be used as the source for data binding.
public function get showGridArea():Boolean
public function set showGridArea(value:Boolean):void
showGridLine | property |
showGridLine:Boolean
[read-write] Whether or not lines are drawn between grid cells.
This property can be used as the source for data binding.
public function get showGridLine():Boolean
public function set showGridLine(value:Boolean):void
showLabels | property |
showLabels:Boolean
[read-write] Whether or not the labels on this axis are shown.
This property can be used as the source for data binding.
public function get showLabels():Boolean
public function set showLabels(value:Boolean):void
tickGap | property |
tickGap:Number
[read-write] The number of values between successive minor tick marks.
This property can be used as the source for data binding.
public function get tickGap():Number
public function set tickGap(value:Number):void
tickStroke | property |
tickStroke:SolidStroke
[read-write] The stroke used to render each tick mark.
This property can be used as the source for data binding.
public function get tickStroke():SolidStroke
public function set tickStroke(value:SolidStroke):void
AxisBase | () | Constructor |
public function AxisBase()
Constructor.