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

{ "type": "interface",
  "qname": "mx.charts.chartClasses.IChartElement2",
"baseInterfaceNames": [
"mx.charts.chartClasses.IChartElement"]
,
    "description": "IChartElement2 defines the base set of properties and methods required by a UIComponent to be representable in the data space of a chart. Any component assigned to the series, backgroundElements, or annotationElements Arrays of a chart must implement this interface.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
    "qname": "dataToLocal",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Converts a tuple of data values to an x-y coordinate on screen. Call this function to transform data on to the screen using the same transform that the individual elements go through. For example, to create a custom highlight for a data region of a chart, you might use this function to determine the on-screen coordinates of the range of interest.  <p>For Cartesian chartelements, you typically pass two values. The first value maps to the horizontal axis, and the second value maps to the vertical axis.</p>  <p>For polar charts, the first value maps to the angular axis, and the second maps to the radial axis.</p>",
    "tags": [
    {  "tagName": "param",
           "values": ["dataValues The data values to convert to coordinates."]},
        {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "return",
           "values": ["Coordinates that are relative to the chart."]},
        {  "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": "Converts a coordinate on screen to a tuple of data values. Call this function to determine what data values a particular point on-screen represents. <p>Individual chart types determine how this transformation occurs. The point should be relative to the chart's coordinate space.</p>",
    "tags": [
    {  "tagName": "param",
           "values": ["pt The Point to convert."]},
        {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "return",
           "values": ["The tuple of data values."]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "Array",
      "params": [{ "name": "pt", "type": "org.apache.royale.geom.Point"}]}
  ,
  { "type": "method",
    "qname": "getAllDataPoints",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Returns an array of HitData of the items of all the underlying objects that implement <code>IChartElement2</code> 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": []}
  ]
  }