YUI AS Component Documentation |
Interface IOriginAxis

Package | com.yahoo.astra.fl.charts.axes
Interface | public interface IOriginAxis extends IAxis, flash.events.IEventDispatcher
Implementors | NumericAxis

An axis with an origin.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | chart : IChart The chart in which this axis appears. | IAxis
|  | dataProvider : Array Data used in determining the axis scale | IAxis
|  | height : Number Total height of axis | IAxis
|  | labelData : AxisLabelData Maximum dimensions of axis labels | IAxis
|  | labelFunction : Function A function may be set to determine the text value of the labels. | IAxis
|  | labelSpacing : Number The space, in pixels, between labels on an axis. | IAxis
|  | maxLabel : String Largest label value to appear on the axis. | IAxis
|  | maxLabelHeight : Number Gets or sets the maximum width of a label | IAxis
|  | maxLabelWidth : Number Gets or sets the maximum width of a label | IAxis
|  | origin : Object [read-only] Returns the value of the origin. | IOriginAxis
|  | position : String Position of axis in relation to the chart | IAxis
|  | renderer : IAxisRenderer The visual renderer associated with this axis. | IAxis
|  | reverse : Boolean Sets the direction of the labels and other visual objects along the axis. | IAxis
|  | title : String The text that will appear next to the axis to indicate information about the data that it displays. | IAxis
|  | width : Number Total width of axis | IAxis

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined by
--- | --- | ---
|  | getMaxLabel():String Returns the maximum string length of a label on the axis. | IAxis
|  | updateScale():void Determines the axis scale based on the input data set. | IAxis
|  | valueToLabel(value:Object):String Converts a value on the axis to formatted label text. | IAxis
|  | valueToLocal(value:Object):Number Calculates the position of a data point along the axis. | IAxis

Property detail

origin | property

`origin:Object` [read-only]

Returns the value of the origin. This is not the position of the origin. To get the origin's position, pass the origin value to valueToLocal(). Note: This value may not be the true origin value. It may be a minimum or maximum value if the actual origin is not visible.

Implementation
`public function get origin():Object`

See also

IAxis.valueToLocal()