| { "type": "class", | |
| "qname": "mx.charts.chartClasses.DataTransform", | |
| "baseClassname": "org.apache.royale.events.EventDispatcher" | |
| , | |
| "description": "The DataTransform object represents a portion of a chart that contains glyphs and can transform values to screen coordinates and vice versa. Each DataTransform object has a horizontal axis, a vertical axis, and a set of glyphs (background, data, and overlay) to render. <p>In theory, a chart can contain multiple overlaid DataTransform objects. This allows you to display a chart with multiple data sets rendered in the same area but with different ranges. For example, you might want to show monthly revenues compared to the number of units sold. If revenue was typically in millions while units was typically in the thousands, it would be difficult to render these effectively along the same range. Overlaying them in different DataTransform objects allows the end user to compare trends in the values when they are rendered with different ranges.</p> <p>Charts can only contain one set of DataTransform.</p> <p>Most of the time, you will use the ChartBase object, which hides the existance of the DataTransform object between the chart and its contained glyphs and axis objects. If you create your own ChartElement objects, you must understand the methods of the DataTransform class to correctly implement their element.</p>", | |
| "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.DataTransform", | |
| "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": "Object", | |
| "qname": "axes", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The set of axes associated with this transform.", | |
| "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": "elements", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The elements that are associated with this transform. This Array includes background, series, and overlay elements associated with the transform. This value is assigned by the enclosing chart object.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "method", | |
| "qname": "transformCache", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Maps a set of numeric values representing data to screen coordinates. This method assumes the values are all numbers, so any non-numeric values must have been previously converted with the <code>mapCache()</code> method. in their fields. This is also where this function will store the converted numeric values. can be found. will be stored. can be found. will be stored.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["cache An array of objects containing the data values", "xField The field where the data values for the x axis", "xConvertedField The field where the mapped x screen coordinate", "yField The field where the data values for the y axis", "yConvertedField The field where the mapped y screen coordinate"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "cache", "type": "Array"}, | |
| { "name": "xField", "type": "String"}, | |
| { "name": "xConvertedField", "type": "String"}, | |
| { "name": "yField", "type": "String"}, | |
| { "name": "yConvertedField", "type": "String"}]} | |
| , | |
| { "type": "method", | |
| "qname": "invertTransform", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Transforms x and y coordinates relative to the DataTransform coordinate system into a two-dimensional value in data space.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["...values The x and y positions (in that order)."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "return", | |
| "values": ["An Array containing the transformed values."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Array", | |
| "params": [{ "name": "values", "type": "Array"}]} | |
| , | |
| { "type": "method", | |
| "qname": "dataChanged", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Informs the DataTransform that some of the underlying data being represented on the chart has changed. The DataTransform generally has no knowledge of the source of the underlying data being represented by the chart, so glyphs should call this when their data changes so that the DataTransform can recalculate range scales based on their data. This does <b>not</b> invalidate the DataTransform, because there is no guarantee the data has changed. The axis objects (or range objects) must trigger an invalidate event.", | |
| "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": "describeData", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Collects important displayed values for all elements associated with this data transform. Axis instances call this method to collect the values they need to consider when auto-generating appropriate ranges. This method returns an Array of BoundedValue objects. <p>To collect important values for the horizontal axis of a CartesianTransform, pass 0. To collect values for the vertical axis, pass 1.</p> by this transform.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["dimension The dimension to collect values for.", "requiredFields Defines the data that are required"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "return", | |
| "values": ["A Array of BoundedValue objects."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "Array", | |
| "params": [{ "name": "dimension", "type": "String"}, | |
| { "name": "requiredFields", "type": "uint"}]} | |
| , | |
| { "type": "method", | |
| "qname": "getAxis", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Retrieves the axis instance responsible for transforming the data dimension specified by the <code>dimension</code> parameter. If no axis has been previously assigned, a default axis is created. The default axis for all dimensions is a LinearAxis with the <code>autoAdjust</code> property set to <code>false</code>. for transforming the data.", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["mx.charts.LinearAxis"]}, | |
| { "tagName": "param", | |
| "values": ["dimension The dimension whose axis is responsible"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "return", | |
| "values": ["The axis instance."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "mx.charts.chartClasses.IAxis", | |
| "params": [{ "name": "dimension", "type": "String"}]} | |
| , | |
| { "type": "method", | |
| "qname": "setAxis", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Assigns an axis instance to a particular dimension of the transform. Axis objects are assigned by the enclosing chart object.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["dimension The dimension of the transform.", "v The target axis instance."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "void", | |
| "params": [{ "name": "dimension", "type": "String"}, | |
| { "name": "v", "type": "mx.charts.chartClasses.IAxis"}]} | |
| ] | |
| , | |
| "events": [ | |
| { "qname": "transformChange", | |
| "type": "mx.events.FlexEvent" | |
| , | |
| "description": "Dispatched when the transformation from data space to screen space has changed, typically either because the axes that make up the transformation have changed in some way, or the data transform itself has size.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["mx.events.FlexEvent.TRANSFORM_CHANGE"]}, | |
| { "tagName": "productversion", | |
| "values": ["Flex 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}] | |
| } |