Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
IStackable

Package | mx.charts.chartClasses
Interface | public interface IStackable

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The IStackable interface is implemented by any series that can be stacked. Stacking sets (ColumnSet, BarSet, AreaSet) require that any sub-series assigned to it when stacking implement this interface.

Public Properties

| Property | Defined By
--- | --- | ---
|  | stacker : StackedSeries The StackedSeries associated with this series. | IStackable
|  | stackTotals : Dictionary [write-only] The stack totals for the series. | IStackable

Public Methods

| Method | Defined By
--- | --- | ---
|  | stack(stackedXValueDictionary:Dictionary, previousElement:IStackable):Number Stacks the series. | IStackable

Property Detail

stacker | property

`stacker:StackedSeries`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The StackedSeries associated with this series. The stacker manages the series's stacking behavior.

Implementation
`public function get stacker():StackedSeries`
`public function set stacker(value:StackedSeries):void`

stackTotals | property |

`stackTotals:Dictionary` [write-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The stack totals for the series.

Implementation
`public function set stackTotals(value:Dictionary):void`
Method Detail

stack | () | method

`public function stack(stackedXValueDictionary:Dictionary, previousElement:IStackable):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Stacks the series. Normally, a series implements the `updateData()` method to load its data out of the data provider. But a stacking series performs special operations because its values are not necessarily stored in its data provider. Its values are whatever is stored in its data provider, summed with the values that are loaded by the object it stacks on top of.

A custom stacking series should implement the `stack()` method by loading its data out of its data provider, adding it to the base values stored in the dictionary to get the real values it should render with, and replacing the values in the dictionary with its new, summed values.

Parameters

| `stackedXValueDictionary:Dictionary` — Contains the base values that the series should stack on top of. The keys in the dictionary are the y values, and the values are the x values.
| `previousElement:IStackable` — The previous element in the stack. If, for example, the element is of the same type, you can use access to this property to avoid duplicate effort when rendering.

Returns

| `Number` — The maximum value in the newly stacked series.

Wed Nov 15 2017, 09:50 AM +01:00