asdoc/mx/charts/ColumnChart.js.json

{ "type": "class",
  "qname": "mx.charts.ColumnChart",
  "baseClassname": "mx.charts.chartClasses.CartesianChart"
  ,
    "description": "The ColumnChart control represents data as a series of vertical columns whose height is determined by values in the data. You can use the ColumnChart to represent a variety of different charts including simple columns, clustered columns, stacked, 100% stacked, and high/low.  <p>A ColumnChart control expects its <code>series</code> property to contain an array of ColumnSeries objects.</p>  <p>Stacked and 100% column charts override the <code>minField</code> property of their ColumnSeries objects.</p>   <p>The <code>&lt;mx:ColumnChart&gt;</code> tag inherits all the properties of its parent classes and adds the following properties:</p>  <pre>\\n &lt;mx:ColumnChart\\n <strong>Properties</strong>\\n extendLabelToEnd=&quot;false|true&quot;\\n maxLabelWidth=&quot;<i>50</i>&quot;\\n showLabelVertically=&quot;false|true&quot;\\n type=&quot;<i>clustered|overlaid|stacked|100%</i>&quot;\\n \\n <strong>Styles</strong>\\n columnWidthRatio=&quot;.65&quot;\\n maxColumnWidth=&quot;<i>No default</i>&quot;\\n /&gt;\\n </pre>",
  "tags": [
  {  "tagName": "includeExample",
         "values": ["examples/Column_BarChartExample.mxml"]},
      {  "tagName": "see",
         "values": ["mx.charts.series.ColumnSeries"]},
      {  "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.ColumnChart",
        "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": "Boolean",
        "qname": "extendLabelToEnd",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Determines whether or not data labels can extend to the end of the chart. If you set this to true, labels can use the whole space between the item and the boundary of the chart to show its label. Otherwise, data labels are restricted to the area defined by their chart item.",
        "tags": [
        {  "tagName": "default",
               "values": ["false"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "int",
        "qname": "maxLabelWidth",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Determines maximum width in pixels of label of items.",
        "tags": [
        {  "tagName": "default",
               "values": ["50"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "Boolean",
        "qname": "showLabelVertically",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Determines whether or not the data labels can be shown vertically. If you set this to true and if embedded fonts are used, labels will be shown vertically if they cannot be fit horizontally within the column width.",
        "tags": [
        {  "tagName": "default",
               "values": ["false"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "accessor",
        "access": "read-write",
        "return": "String",
        "qname": "type",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The type of the column chart.  <p>Possible values are:</p> <ul> <li><code>&quot;clustered&quot;</code>: Values from different series are grouped by category. This is the default type.</li> <li><code>&quot;overlaid&quot;</code>: Multiple values are rendered on top of one another by category, with the last series on top. </li> <li><code>&quot;stacked&quot;</code>: Columns are stacked on top of each other and grouped by category. Each column represents the cumulative value of the columns beneath it. </li> <li><code>&quot;100%&quot;</code>: Columns are stacked on top of each other, adding up to 100%. Each column represents the percent that it contributes to the sum of the values for that category.</li> </ul>",
        "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": "measureLabels",
        "namespace": "mx_internal",
        "bindable": [],
        "details": ["override"],
        "deprecated": {},
          "description": "Determines positions and dimensions of labels for all series in the chart",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Flex 3"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "Object",
          "params": []}
      ,
      { "type": "method",
        "qname": "getSeriesLabelPos",
        "namespace": "mx_internal",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "void",
          "params": [{ "name": "series", "type": "mx.charts.chartClasses.Series"}]}
      ,
      { "type": "method",
        "qname": "getSeriesLabelPosSet",
        "namespace": "mx_internal",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "return": "void",
          "params": []}
      ]
  }