blob: a420ecc092ebe810e7389b499add85ac4810be35 [file] [log] [blame]
{ "type": "class",
"qname": "mx.charts.chartClasses.ChartElement",
"baseClassname": "mx.charts.chartClasses.DualStyleObject"
,
"description": "The ChartElement class is the base class for visual chart elements.",
"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.chartClasses.ChartElement",
"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.charts.chartClasses.ChartBase",
"qname": "chart",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Refers to the chart component containing this element.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "write-only",
"return": "Object",
"qname": "chartDataProvider",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The data provider assigned to the enclosing chart. Element types can choose to inherit the data provider from the enclosing chart if necessary, or allow developers to assign data providers specifically to the element. Not all elements are necessarily driven by a data provider.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "field",
"qname": "cursor",
"return": "mx.collections.IViewCursor",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Each ChartElement carries a cursor associated with their dataProvider for their own internal use. ChartElements have sole ownership of this cursor; they can assume no other code will modify its position.",
"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": "Object",
"qname": "dataProvider",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "A data provider assigned to the this specific element. In general, elements inherit the dataProvider from the enclosing chart. But individual elements can override with a specific dataProvider of their own.",
"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.DataTransform",
"qname": "dataTransform",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The DataTransform object that the element is associated with. A DataTransform object represents an association between a set of elements and a set of axis objects used to transform those elements from data space to screen coordinates and back. A chart element uses its associated DataTransform object to calculate how to render its data.",
"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": "mx.core.UIComponent",
"qname": "labelContainer",
"namespace": "public",
"bindable": [],
"details": [],
"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": "method",
"qname": "addChild",
"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.core.IUIComponent",
"params": [{ "name": "child", "type": "mx.core.IUIComponent"}]}
,
{ "type": "method",
"qname": "addChildAt",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "Adds a child DisplayObject instance to this DisplayObjectContainer instance. The child is added at the index position specified. An index of 0 represents the back (bottom) of the display list for this DisplayObjectContainer object. <p>If you add a child object that already has a different display object container as a parent, the object is removed from the child list of the other display object container. </p> <code>child</code> parameter. DisplayObjectContainer instance. currently occupied index position, the child object that exists at that position and all higher positions are moved up one position in the child list.",
"tags": [
{ "tagName": "param",
"values": ["child The DisplayObject instance to add as a child of this", "index The index position to which the child is added. If you specify a"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "return",
"values": ["The DisplayObject instance that you pass in the"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "mx.core.IUIComponent",
"params": [{ "name": "child", "type": "mx.core.IUIComponent"},
{ "name": "index", "type": "int"}]}
,
{ "type": "method",
"qname": "processNewDataProvider",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Called when a new dataProvider is assigned to the element. Subclasses can override and define custom behavior when a new dataProvider is assigned. This method is called when either the <code>dataProvider</code> property is set, or when the <code>chartDataProvider</code> property is set if no specific dataProvider has been assigned directly. or similar class.",
"tags": [
{ "tagName": "param",
"values": ["value The data provider. This is typically an Array, ArrayCollection, XMLList, XMLListCollection,"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "value", "type": "Object"}]}
,
{ "type": "method",
"qname": "mappingChanged",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Called when the mapping of one or more associated axes changes. The DataTransform assigned to this ChartElement will call this method when any of the axes it represents is modified in some way.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "dataChanged",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Indicates the underlying data represented by the element has changed. You should call this method whenever the data your series or element is displaying changes. It gives any associated axes a chance to update their ranges if appropriate.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "findDataPoints",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Finds the closest data point represented by the element under the given coordinates. <p>This method returns either an array of HitData structures describing the datapoints within range. Individual ChartElements may choose to only return a single dataPoint if their dataPoints are guaranteed not to overlap.</p> to the exact coordinates to be considered &quot;under&quot;. This property is similar to the value of the mouseSensitivity property of the chart control.",
"tags": [
{ "tagName": "param",
"values": ["x The X coordinate.", "y The Y coordinate.", "sensitivity2 How close, in pixels, the pointer must be"]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "return",
"values": ["An array of HitData."]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Array",
"params": [{ "name": "x", "type": "Number"},
{ "name": "y", "type": "Number"},
{ "name": "sensitivity2", "type": "Number"}]}
,
{ "type": "method",
"qname": "getAllDataPoints",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Returns an array of HitData of the items of all the underlying ChartElements whose dataTips are to be shown when <code>showAllDataTips</code> is set to <code>true</code> on chart",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "return",
"values": ["The HitData objects describing the data points."]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Array",
"params": []}
,
{ "type": "method",
"qname": "createDataID",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Creates a unique id to represent the dataPoint for comparison purposes. Derived classes can call this function with a locally unique data point ID to generate an ID that is unique across the application.",
"tags": [
{ "tagName": "param",
"values": ["dataPointID The dataPoint's current ID."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "return",
"values": ["An ID for the dataPoint that is unique across the application."]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "Number",
"params": [{ "name": "dataPointID", "type": "Number"}]}
,
{ "type": "method",
"qname": "describeData",
"namespace": "public",
"bindable": [],
"details": [],
"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"}]}
,
{ "type": "method",
"qname": "chartStateChanged",
"namespace": "public",
"bindable": [],
"details": [],
"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": "oldState", "type": "uint"},
{ "name": "v", "type": "uint"}]}
,
{ "type": "method",
"qname": "collectTransitions",
"namespace": "public",
"bindable": [],
"details": [],
"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": "chartState", "type": "Number"},
{ "name": "transitions", "type": "Array"}]}
,
{ "type": "method",
"qname": "claimStyles",
"namespace": "public",
"bindable": [],
"details": [],
"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": "uint",
"params": [{ "name": "styles", "type": "Array"},
{ "name": "firstAvailable", "type": "uint"}]}
,
{ "type": "method",
"qname": "dataToLocal",
"namespace": "public",
"bindable": [],
"details": [],
"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": "org.apache.royale.geom.Point",
"params": [{ "name": "dataValues", "type": "Array"}]}
,
{ "type": "method",
"qname": "localToData",
"namespace": "public",
"bindable": [],
"details": [],
"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": "pt", "type": "org.apache.royale.geom.Point"}]}
,
{ "type": "method",
"qname": "addedToParent",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"return": "void",
"params": []}
]
}