blob: 5b6e3fd7e70593ebf1045634d2b9903ebbdf71bc [file] [log] [blame]
{ "type": "class",
"qname": "mx.charts.chartClasses.CartesianChart",
"baseClassname": "mx.charts.chartClasses.ChartBase"
,
"description": "The CartesianChart class is a base class for the common chart types. CartesianChart defines the basic layout behavior of the standard rectangular, two-dimensional charts. <p>The <code>&lt;mx:CartesianChart&gt;</code> tag inherits all the properties of its parent classes and adds the following properties:</p> <pre>\\n &lt;mx:CartesianChart\\n <strong>Properties</strong>\\n computedGutters=&quot;<i>No default</i>&quot;\\n dataRegion=&quot;<i>Rectangle; no default</i>&quot;\\n horizontalAxis=&quot;<i>Axis; no default</i>&quot;\\n horizontalAxisRatio=&quot;.33&quot;\\n horizontalAxisRenderers=&quot;<i>Array; no default</i>&quot;\\n selectedChartItems=&quot;<i>Array; no default</i>&quot;\\n verticalAxis=&quot;<i>Axis; no default</i>&quot;\\n verticalAxisRatio=&quot;.33&quot;\\n verticalAxisRenderers=&quot;<i>Array; no default</i>&quot;\\n \\n <strong>Styles</strong>\\n axisTitleStyleName=&quot;<i>Style; no default</i>&quot;\\n gridLinesStyleName=&quot;<i>Style; no default</i>&quot;\\n gutterBottom=&quot;<i>No default</i>&quot;\\n gutterLeft=&quot;<i>No default</i>&quot;\\n gutterRight=&quot;<i>No default</i>&quot;\\n gutterTop=&quot;<i>No default</i>&quot;\\n horizontalAxisStyleNames=<i>Array; no default</i>&quot;\\n verticalAxisStyleNames = <i>Array; no default</i>&quot;\\n /&gt;\\n </pre>",
"tags": [
{ "tagName": "see",
"values": ["mx.charts.CategoryAxis", "mx.charts.LinearAxis", "mx.charts.chartClasses.ChartBase"]},
{ "tagName": "mxml",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "method",
"qname": "mx.charts.chartClasses.CartesianChart",
"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-write",
"return": "Array",
"qname": "backgroundElements",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "Sets an array of background ChartElement objects that appear below any data series rendered by the chart. Each item in the Array must extend the mx.charts.DualStyleObject class and implement the IChartElement2 interface.",
"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-only",
"return": "org.apache.royale.geom.Rectangle",
"qname": "dataRegion",
"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"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Array",
"qname": "selectedChartItems",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "An Array of the selected ChartItem objects in the chart. This includes selected ChartItem objects in all of the chart's series.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "org.apache.royale.geom.Rectangle",
"qname": "computedGutters",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The current computed size of the gutters of the CartesianChart. The gutters represent the area between the padding and the data area of the chart, where the titles and axes render. By default, the gutters are computed dynamically. You can set explicit values through the gutter styles. The gutters are computed to match any changes to the chart when it is validated by the LayoutManager.",
"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": "mx.charts.chartClasses.IAxis",
"qname": "horizontalAxis",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Defines the labels, tick marks, and data position for items on the x-axis. Use either the LinearAxis class or the CategoryAxis class to set the properties of the horizontalAxis as a child tag in MXML or create a LinearAxis or CategoryAxis object in ActionScript.",
"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": "horizontalAxisRatio",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Determines the height limit of the horiztonal axis. The limit is the width of the axis times this ratio.",
"tags": [
{ "tagName": "default",
"values": ["0.33."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "mx.charts.chartClasses.IAxisRenderer",
"qname": "horizontalAxisRenderer",
"namespace": "mx_internal",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "private",
"values": []} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Array",
"qname": "horizontalAxisRenderers",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Specifies how data appears along the x-axis of a chart. Use the AxisRenderer class to define the properties for horizontalAxisRenderer as a child tag in MXML or create an AxisRenderer object in ActionScript.",
"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": "mx.charts.chartClasses.IAxis",
"qname": "verticalAxis",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Defines the labels, tick marks, and data position for items on the y-axis. Use either the LinearAxis class or the CategoryAxis class to set the properties of the horizontal axis as a child tag in MXML or create a LinearAxis or CategoryAxis object in ActionScript.",
"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": "verticalAxisRatio",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Determines the width limit of the vertical axis. The limit is the width of the axis times this ratio.",
"tags": [
{ "tagName": "default",
"values": ["0.33."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "mx.charts.chartClasses.IAxisRenderer",
"qname": "verticalAxisRenderer",
"namespace": "mx_internal",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Specifies how data appears along the y-axis of a chart. Use the AxisRenderer class to set the properties for verticalAxisRenderer as a child tag in MXM or create an AxisRenderer object in ActionScript.",
"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": "Array",
"qname": "verticalAxisRenderers",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Specifies how data appears along the y-axis of a chart. Use the AxisRenderer class to set the properties for verticalAxisRenderer as a child tag in MXML or create an AxisRenderer object in ActionScript.",
"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": "mx.core.IFlexModuleFactory",
"qname": "moduleFactory",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "updateDisplayList",
"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": "unscaledWidth", "type": "Number"},
{ "name": "unscaledHeight", "type": "Number"}]}
,
{ "type": "method",
"qname": "styleChanged",
"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": "void",
"params": [{ "name": "styleProp", "type": "String"}]}
,
{ "type": "method",
"qname": "updateData",
"namespace": "mx_internal",
"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": "updateSeries",
"namespace": "mx_internal",
"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": "updateAxisOrder",
"namespace": "mx_internal",
"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": "int",
"params": [{ "name": "nextIndex", "type": "int"}]}
,
{ "type": "method",
"qname": "getLastItem",
"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": "mx.charts.ChartItem",
"params": [{ "name": "direction", "type": "String"}]}
,
{ "type": "method",
"qname": "getFirstItem",
"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": "mx.charts.ChartItem",
"params": [{ "name": "direction", "type": "String"}]}
,
{ "type": "method",
"qname": "getNextItem",
"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": "mx.charts.ChartItem",
"params": [{ "name": "direction", "type": "String"}]}
,
{ "type": "method",
"qname": "getPreviousItem",
"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": "mx.charts.ChartItem",
"params": [{ "name": "direction", "type": "String"}]}
,
{ "type": "method",
"qname": "getSeriesTransformState",
"namespace": "mx_internal",
"bindable": [],
"details": ["override"],
"deprecated": {},
"return": "Boolean",
"params": [{ "name": "seriesObject", "type": "Object"}]}
,
{ "type": "method",
"qname": "adjustAxesPlacements",
"namespace": "mx_internal",
"bindable": [],
"details": [],
"deprecated": {},
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "measureLabels",
"namespace": "mx_internal",
"bindable": [],
"details": [],
"deprecated": {},
"return": "Object",
"params": []}
,
{ "type": "method",
"qname": "getLeftMostRenderer",
"namespace": "mx_internal",
"bindable": [],
"details": [],
"deprecated": {},
"return": "mx.charts.chartClasses.IAxisRenderer",
"params": []}
,
{ "type": "method",
"qname": "getRightMostRenderer",
"namespace": "mx_internal",
"bindable": [],
"details": [],
"deprecated": {},
"return": "mx.charts.chartClasses.IAxisRenderer",
"params": []}
,
{ "type": "method",
"qname": "getTopMostRenderer",
"namespace": "mx_internal",
"bindable": [],
"details": [],
"deprecated": {},
"return": "mx.charts.chartClasses.IAxisRenderer",
"params": []}
,
{ "type": "method",
"qname": "getBottomMostRenderer",
"namespace": "mx_internal",
"bindable": [],
"details": [],
"deprecated": {},
"return": "mx.charts.chartClasses.IAxisRenderer",
"params": []}
]
}