Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
IColumn

Package | mx.charts.chartClasses
Interface | public interface IColumn
Implementors | ColumnSeries, ColumnSet, HLOCSeriesBase

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

ChartElements that can be clustered along the vertical axis should implement this interface. Any element implementing this interface can be used as a child series of a ColumnSet element with its `type` property set to "clustered". The ColumnSeries, HLOCSeries, CandleStickSeries, and ColumnSet classes all implement this interface.

Public Properties

| Property | Defined By
--- | --- | ---
|  | columnWidthRatio : Number [write-only] Specifies the width of items relative to the category size. | IColumn
|  | maxColumnWidth : Number [write-only] Specifies how wide to draw the items, in pixels. | IColumn
|  | offset : Number [write-only] Specifies how far to offset the center of the items from the center of the available space, relative the category size. | IColumn

Property Detail

columnWidthRatio | property

`columnWidthRatio:Number` [write-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies the width of items relative to the category size. A value of `1` uses the entire space, while a value of `0.6` uses 60% of the item's available space. You typically do not set this property directly. A governing ColumSet or ColumnChart would implicitly assign this value. The actual item width used is the smaller of the `columnWidthRatio` and the `maxColumnWidth` properties.

Implementation
`public function set columnWidthRatio(value:Number):void`

maxColumnWidth | property |

`maxColumnWidth:Number` [write-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies how wide to draw the items, in pixels. The actual item width used is the smaller of this property and the `columnWidthRatio` property. You typically do not set this property directly. The ColumSet or ColumnChart object assigns this value. The actual item width used is the smaller of the `columnWidthRatio` and `maxColumnWidth` properties.

Implementation
`public function set maxColumnWidth(value:Number):void`

offset | property |

`offset:Number` [write-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies how far to offset the center of the items from the center of the available space, relative the category size. The range of values is a percentage in the range `-100` to `100`. Set to `0` to center the items in the space. Set to `-50` to center the item at the beginning of the available space. You typically do not set this property directly. The ColumSet or ColumnChart object assigns this value.

The default value is `0`.

Implementation
`public function set offset(value:Number):void`

Sun Mar 5 2017, 03:42 PM +11:00