org.axiis.charts.axis.HCategoryAxis

Public Properties

	Property		Defined By
		axisLabelFunction : Function A function used to determine the text of each label.	HCategoryAxis
		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
		categoryScale : CategoricalScale The scale used to plot out the labels.	HCategoryAxis
		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
		fontFamily : String font family of labels.	HCategoryAxis
		fontSize : Number font size of labels.	HCategoryAxis
		fontWeight : String font weight of labels.	HCategoryAxis
		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
		label : RasterText	HCategoryAxis
		labelField : Object The property within each item in the dataProvider that contains the field used to determine the label for the item.	AbstractLayout
		labelPadding : Number Minimum padding between labels.	HCategoryAxis
		labelRotation : Number rotation of text for labels - should keep between 0-90.	HCategoryAxis
		layouts : Array The layouts that should be displayed within this layout.	AbstractLayout
		line : Line	HCategoryAxis
		markerLength : Number The length in pixels of the label marker (line)	HCategoryAxis
		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
		states : Array An array of states that should be applied to this layout.	AbstractLayout
		stroke : IGraphicsStroke Stroke used for tick marks.	HCategoryAxis
		strokes : Array A placeholder for strokes used within this layout.	AbstractLayout
		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

	Property	Defined By
		sprite : AxiisSprite The sprite this layout is currently rendering to.	AbstractLayout

	Method	Defined By
		HCategoryAxis()	HCategoryAxis
		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

	Method	Defined By
		deselectChildren():void Marks all children as deselected.	AbstractLayout
		postIteration():void The callback method called by the referenceRepeater after it applies the PropertyModifiers on each iteration.	BaseLayout
		preIteration():void The callback method called by the referenceRepeater before it applies the PropertyModifiers on each iteration.	BaseLayout
		renderChildLayouts(child:AxiisSprite):void Calls the render method on all child layouts.	BaseLayout
		repeatComplete():void The callback method called by the referenceRepeater after it finishes its final iteration.	BaseLayout

Summary	Defined By
invalidateLayout	Dispatched when invalidate is called so the DataCanvas that owns this layout can being the process of redrawing the layout.	BaseLayout
itemClick	Dispatched when an AxiisSprite is clicked.	BaseLayout
itemDataTip	Dispatched when an AxiisSprite is mousedOver.	BaseLayout
itemDoubleClick	Dispatched when an AxiisSprite is double clicked.	BaseLayout
itemMouseMove	Dispatched when an AxiisSprite is mousedOver.	BaseLayout
itemMouseOut	Dispatched when an AxiisSprite is mousedOut.	BaseLayout
itemMouseOver	Dispatched when an AxiisSprite is mousedOver.	BaseLayout
itemPreDraw	Dispatched before each individual child is rendered.	BaseLayout
itemSelected	Dispatched when an AxiisSprite is selected	BaseLayout
itemUnSelected	Dispatched when an AxiisSprite is unselected	BaseLayout
preRender	Dispatched at the beginning of the render method.	BaseLayout
renderComplete	Dispatched when layout has completed its render cycle	BaseLayout

Property Detail

axisLabelFunction

property

public var axisLabelFunction:Function

A function used to determine the text of each label. The method should take one argument, a value from the dataProvider, and return a String to use as the label. The default method applies toString() to the argument.