blob: a8737db536b966ca7bda2d61864f396f79771c09 [file] [log] [blame]
{ "type": "class",
"qname": "mx.charts.series.ColumnSet",
"baseClassname": "mx.charts.chartClasses.StackedSeries"
,
"description": "ColumnSet is a grouping set that can be used to stack or cluster column series in any arbitrary chart. A ColumnSet encapsulates the same grouping behavior used in a ColumnChart, but can be used to assemble custom charts based on CartesianChart. ColumnSets can be used to cluster any chart element type that implements the IColumn interface. It can stack any chart element type that implements the IColumn and IStackable interfaces. Since ColumnSet itself implements the IColumn interface, you can use ColumnSets to cluster other ColumnSets to build more advanced custom charts.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "method",
"qname": "mx.charts.series.ColumnSet",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Constructor.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": []}
,
{ "type": "accessor",
"access": "read-only",
"return": "mx.core.UIComponent",
"qname": "labelContainer",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "private",
"values": []} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Array",
"qname": "series",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "An array of sub-series managed by this stacking set. These series are rendered according to the stacking behavior of this stacking set as defined by the value of the <code>type</code> property.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1", "Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3", "Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0", "3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "columnWidthRatio",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Specifies the width of columns relative to the category width. A value of <code>1</code> uses the entire space, while a value of <code>.6</code> uses 60% of the column's available space. You typically do not set this property directly. The actual column width used is the smaller of <code>columnWidthRatio</code> and the <code>maxColumnWidth</code> property",
"tags": [
{ "tagName": "default",
"values": ["0.65"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "maxColumnWidth",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Specifies the width of the columns, in pixels. The actual column width used is the smaller of this style and the <code>columnWidthRatio</code> property. Clustered columns divide this space proportionally among the columns in each cluster.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "offset",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Specifies how far to offset the center of the columns from the center of the available space, relative to the category width. At the value of default <code>0</code>, the columns are centered on the space. Set to <code>-50</code> to center the column at the beginning of the available space. You typically do not set this property directly. The ColumnChart control manages this value based on its <code>columnWidthRatio</code> property.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "String",
"qname": "type",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "The grouping behavior of this series. All stacking series support <code>&quot;overlaid&quot;</code>, <code>&quot;stacked&quot;</code>, and <code>&quot;100%&quot;</code>. When the <code>type</code> property is <code>&quot;overlaid&quot;</code>, all sub-series are rendererd normally, with no special behavior applied. When the <code>type</code> property is <code>&quot;stacked&quot;</code>, each sub-series is rendered as the sum of its data plus the values of all previous series. When the <code>type</code> property is <code>&quot;100%&quot;</code>, each sub-series is rendered as its portion of the total sum of all series.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1", "Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3", "Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0", "3.0"]} ]},
{ "type": "method",
"qname": "customizeSeries",
"namespace": "protected",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "glyph", "type": "mx.charts.chartClasses.IChartElement"},
{ "name": "i", "type": "uint"}]}
,
{ "type": "method",
"qname": "buildSubSeries",
"namespace": "protected",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "formatDataTip",
"namespace": "protected",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "String",
"params": [{ "name": "hd", "type": "mx.charts.HitData"}]}
,
{ "type": "method",
"qname": "describeData",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Array",
"params": [{ "name": "dimension", "type": "String"},
{ "name": "requiredFields", "type": "uint"}]}
]
}