asdoc/mx/charts/chartClasses/CartesianTransform.js.json

{ "type": "class",
  "qname": "mx.charts.chartClasses.CartesianTransform",
  "baseClassname": "mx.charts.chartClasses.DataTransform"
  ,
    "description": "The CartesianTransform object represents a set of axes that maps data values to x/y Cartesian screen coordinates and vice versa.  <p>When using charts in your applications, you typically will not need to interact with the CartesianTransform object. Transforms are created automatically by the built-in chart types and used by the series contained within so that they can transform data into rendering coordinates.</p>",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "field",
        "qname": "HORIZONTAL_AXIS",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "A String representing the horizontal axis.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "field",
        "qname": "VERTICAL_AXIS",
        "return": "String",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "A String representing the vertical axis.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "mx.charts.chartClasses.CartesianTransform",
        "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": "write-only",
        "return": "Number",
        "qname": "pixelWidth",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The width of the data area that the CartesianTransform represents, in pixels. The containing chart sets this property explicitly during layout. The CartesianTransform uses this property to map data values to screen coordinates.",
        "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": "Number",
        "qname": "pixelHeight",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The height of the data area that the CartesianTransform represents, in pixels. The containing chart sets this property explicitly during layout. The CartesianTransform uses this property to map data values to screen coordinates.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "invertTransform",
        "namespace": "public",
        "bindable": [],
        "details": ["override"],
        "deprecated": {},
          "description": "Transforms x and y coordinates relative to the DataTransform coordinate system into a 2-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": "transformCache",
        "namespace": "public",
        "bindable": [],
        "details": ["override"],
        "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 stores the converted numeric values.   is stored.   is 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 are stored.", "xConvertedField The field where the mapped x screen coordinate", "yField The field where the data values for the y axis are stored.", "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"}]}
      ]
  }