YUI Flash Component Documentation | All Packages | All Classes | Index | Frames No Frames |
Interface IPlotArea

Package | com.yahoo.astra.fl.charts
Interface | public interface IPlotArea extends flash.events.IEventDispatcher
Implementors | CartesianChart

An interface for a chart with a drawing area.

Public Properties

| Property | Defined by
--- | --- | ---
|  | contentBounds : Rectangle [read-only] The `Rectangle` representing the area where content should be drawn within the plot area. | IPlotArea
|  | dataProvider : Object The data displayed in the plot area. | IPlotArea
|  | defaultSeriesType : Object When data is encountered where an ISeries is expected, it will be converted to this default type. | IPlotArea

Public Methods

| Method | Defined by
--- | --- | ---
|  | axisAndSeriesToField(axis:IAxis, series:ISeries):String Determines the field used to access data for the input axis and series. | IPlotArea
|  | axisToField(axis:IAxis):String Returns the property field corresponding to the input axis. | IPlotArea
|  | dataToLocal(data:Object, series:ISeries):Point Calculates the position of a data point along the axis. | IPlotArea
|  | fieldToAxis(field:String):IAxis Returns the axis corresponding to the input data field. | IPlotArea

Property detail

contentBounds | property

`contentBounds:Rectangle` [read-only]

The `Rectangle` representing the area where content should be drawn within the plot area.

Implementation
`public function get contentBounds():Rectangle`

dataProvider | property |

`dataProvider:Object` [read-write]

The data displayed in the plot area.

Implementation
`public function get dataProvider():Object`
`public function set dataProvider(value:Object):void`

defaultSeriesType | property |

`defaultSeriesType:Object` [read-write]

When data is encountered where an ISeries is expected, it will be converted to this default type.

Implementation
`public function get defaultSeriesType():Object`
`public function set defaultSeriesType(value:Object):void`
Method detail

axisAndSeriesToField | () | method

`public function axisAndSeriesToField(axis:IAxis, series:ISeries):String`

Determines the field used to access data for the input axis and series. The field may be the chart's default value, or the overridden value from the input series.

Parameters

| `axis:IAxis` — an IAxis object
| `series:ISeries` — an ISeries object that may have custom data fields

Returns

| `String` — the field associated with this axis for the input series

axisToField | () | method |

`public function axisToField(axis:IAxis):String`

Returns the property field corresponding to the input axis.

Parameters

| `axis:IAxis` — an IAxis object appearing in this plot area

Returns

| `String` — the property field to retrieve data for the input axis

dataToLocal | () | method |

`public function dataToLocal(data:Object, series:ISeries):Point`

Calculates the position of a data point along the axis.

Parameters

| `data:Object` — The data used to determine the position
| `series:ISeries` — The series in which the data appears.

Returns

| `Point` — The display position in pixels on the axis

fieldToAxis | () | method |

`public function fieldToAxis(field:String):IAxis`

Returns the axis corresponding to the input data field.

Parameters

| `field:String` — a data field corresponding to one of this plot area's axes.

Returns

| `IAxis` — the axis correpsonding to the input data field.