| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../../override.css" type="text/css"><meta name="keywords" content="DataDescription,mx.charts.chartClasses.DataDescription,ANGULAR_AXIS,HIDING_DATA,HORIZONTAL,HORIZONTAL_AXIS,NONE,PREPARING_TO_HIDE_DATA,PREPARING_TO_SHOW_DATA,RADIAL_AXIS,REQUIRED_BOUNDED_VALUES,REQUIRED_MIN_INTERVAL,REQUIRED_MIN_MAX,REQUIRED_PADDING,SHOWING_DATA,VERTICAL,VERTICAL_AXIS,accurate,allElements,allowNegativeForStacked,angularAxis,angularAxis,annotationElements,aspectRatio,assignedMaximum,assignedMinimum,autoAdjust,axes,axis,backgroundElements,barWidthRatio,baseAtZero,baseline,baseline,boundedValues,bounds,cache,chart,chartDataProvider,chartDataProvider,chartDataProvider,chartDataProvider,chartState,clipContent,closeField,columnWidthRatio,columnWidthRatio,computedGutters,computedInterval,computedMaximum,computedMinimum,count,creationCallback,cursor,data,data,dataChildren,dataDescriptions,dataFunction,dataProvider,dataProvider,dataRegion,dataRegion,dataRegion,dataTipFunction,dataTipItems,dataTipLayerIndex,dataTipMode,dataTransform,dataTransform,dataTransform,dataTransform,dataTransform,description,direction,discard,displayName,displayName,displayName,dragEnabled,dragImage,dragMoveEnabled,dropEnabled,element,elementBounds,elements,factory,filterData,filterDataValues,filterFunction,filteredCache,format,gutters,heightLimit,hide,highField,horizontal,horizontalAxis,horizontalAxis,horizontalAxis,horizontalAxis,horizontalAxisRatio,horizontalAxisRenderers,includeInRanges,includeInRanges,insertPosition,instances,interactive,internalStyleName,itemType,items,items,label,labelCache,labelContainer,labelContainer,labelElements,labelFunction,labelMaximum,labelMinimum,labels,legendData,legendData,legendData,length,lowField,lowerMargin,marker,max,maxBarWidth,maxColumnWidth,maxColumnWidth,maxTipWidth,min,minInterval,minorTickCache,minorTicks,minorTicks,minorTicks,moduleFactory,moduleFactory,moduleFactory,moduleFactory,mouseSensitivity,negTotalsByPrimaryAxis,offset,offset,offset,openField,origin,otherAxes,padding,padding,parseFunction,pixelHeight,pixelWidth,placement,posTotalsByPrimaryAxis,properties,radialAxis,radialAxis,radius,remove,renderData,renderData,renderDataType,requiredDescribedFields,selectable,selectedChartItem,selectedChartItems,selectedChartItems,selectedIndex,selectedIndices,selectedItem,selectedItems,selectionMode,series,series,seriesFilters,showAllDataTips,showDataTips,stackTotals,stackedMaximum,stackedMinimum,stacker,ticks,ticks,ticks,title,title,transitionRenderData,type,unitSize,unitSize,upperMargin,value,verticalAxis,verticalAxis,verticalAxis,verticalAxis,verticalAxisRatio,verticalAxisRenderers,visibleRegion,xField"><title>mx.charts.chartClasses.DataDescription</title></head><body><script language="javascript" type="text/javascript" src="../../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../../help.js"></script><script language="javascript" type="text/javascript" src="../../../cookies.js"></script><script language="javascript" type="text/javascript"><!-- |
| asdocTitle = 'DataDescription - ApacheFlex API Reference'; |
| var baseRef = '../../../'; |
| window.onload = configPage; |
| --></script> |
| <script type="text/javascript"> |
| scrollToNameAnchor(); |
| </script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../../package-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Packages</a> | <a href="../../../class-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Classes</a> | <a href="../../../all-index-A.html" onclick="loadClassListFrame('../../../index-list.html')">Index</a> | <a id="framesLink1" href="../../../index.html?mx/charts/chartClasses/DataDescription.html&mx/charts/chartClasses/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">DataDescription</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#constantSummary">Constants</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("DataDescription"); titleBar_setSubNav(true,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} |
| --> |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.charts.chartClasses</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class DataDescription</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">DataDescription <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p> |
| The DataDescription structure is used by ChartElements to describe |
| the characteristics of the data they represent to Axis objects |
| that auto-generate values from the data represented in the chart. |
| ChartElements displaying data should construct and return DataDescriptions |
| from their <code>describeData()</code> method when invoked. |
| |
| <p></p><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#boundedValues" class="signatureLink">boundedValues</a> : Array<div class="summaryTableDescription"> |
| An Array of BoundedValue objects describing the data in the element.</div></td><td class="summaryTableOwnerCol">DataDescription</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#max" class="signatureLink">max</a> : Number<div class="summaryTableDescription"> |
| The maximum data value displayed by the element.</div></td><td class="summaryTableOwnerCol">DataDescription</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#min" class="signatureLink">min</a> : Number<div class="summaryTableDescription"> |
| The minimum data value displayed by the element.</div></td><td class="summaryTableOwnerCol">DataDescription</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#minInterval" class="signatureLink">minInterval</a> : Number<div class="summaryTableDescription"> |
| The minimum interval, in data units, |
| between any two values displayed by the element.</div></td><td class="summaryTableOwnerCol">DataDescription</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#padding" class="signatureLink">padding</a> : Number<div class="summaryTableDescription"> |
| The amount of padding, in data units, that the element requires |
| beyond its min/max values to display its full values correctly .</div></td><td class="summaryTableOwnerCol">DataDescription</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#DataDescription()" class="signatureLink">DataDescription</a>()</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">DataDescription</td></tr></table></div><a name="constantSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Constants</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableConstant"><tr><th> </th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#REQUIRED_BOUNDED_VALUES" class="signatureLink">REQUIRED_BOUNDED_VALUES</a> : uint = 0x2<div class="summaryTableDescription">[static] |
| A bitflag passed by the axis to an element's describeData() method.</div></td><td class="summaryTableOwnerCol">DataDescription</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#REQUIRED_MIN_INTERVAL" class="signatureLink">REQUIRED_MIN_INTERVAL</a> : uint = 0x1<div class="summaryTableDescription">[static] |
| A bitflag passed by the axis to an element's describeData() method.</div></td><td class="summaryTableOwnerCol">DataDescription</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#REQUIRED_MIN_MAX" class="signatureLink">REQUIRED_MIN_MAX</a> : uint = 0x4<div class="summaryTableDescription">[static] |
| A bitflag passed by the axis to an element's describeData() method.</div></td><td class="summaryTableOwnerCol">DataDescription</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#REQUIRED_PADDING" class="signatureLink">REQUIRED_PADDING</a> : uint = 0x8<div class="summaryTableDescription">[static] |
| A bitflag passed by the axis to an element's describeData() method.</div></td><td class="summaryTableOwnerCol">DataDescription</td></tr></table></div><script language="javascript" type="text/javascript"><!-- |
| showHideInherited(); |
| --></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="boundedValues"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">boundedValues</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>public var boundedValues:Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| An Array of BoundedValue objects describing the data in the element. |
| BoundedValues are data points that have extra space reserved |
| around the datapoint in the chart's data area. |
| If requested, a chart element fills this property |
| with whatever BoundedValues are necessary |
| to ensure enough space is visible in the chart data area. |
| For example, a ColumnSeries that needs 20 pixels |
| above each column to display a data label. |
| |
| </p></div><a name="propertyDetail"></a><a name="max"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">max</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var max:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The maximum data value displayed by the element. |
| |
| </p></div><a name="propertyDetail"></a><a name="min"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">min</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var min:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The minimum data value displayed by the element. |
| |
| </p></div><a name="propertyDetail"></a><a name="minInterval"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">minInterval</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var minInterval:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The minimum interval, in data units, |
| between any two values displayed by the element. |
| |
| </p></div><a name="propertyDetail"></a><a name="padding"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">padding</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public var padding:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The amount of padding, in data units, that the element requires |
| beyond its min/max values to display its full values correctly . |
| |
| </p></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="DataDescription()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">DataDescription</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function DataDescription()</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p> |
| Constructor. |
| |
| </p></div><div class="detailSectionHeader">Constant Detail</div><a name="constantDetail"></a><a name="REQUIRED_BOUNDED_VALUES"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">REQUIRED_BOUNDED_VALUES</td><td class="detailHeaderType">Constant</td></tr></table><div class="detailBody"><code>public static const REQUIRED_BOUNDED_VALUES:uint = 0x2</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A bitflag passed by the axis to an element's <code>describeData()</code> method. |
| If this flag is set, the element sets the |
| <code>boundedValues</code> property. |
| |
| </p></div><a name="constantDetail"></a><a name="REQUIRED_MIN_INTERVAL"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">REQUIRED_MIN_INTERVAL</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const REQUIRED_MIN_INTERVAL:uint = 0x1</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A bitflag passed by the axis to an element's <code>describeData()</code> method. |
| If this flag is set, the element sets the |
| <code>minInterval</code> property. |
| |
| </p></div><a name="constantDetail"></a><a name="REQUIRED_MIN_MAX"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">REQUIRED_MIN_MAX</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const REQUIRED_MIN_MAX:uint = 0x4</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A bitflag passed by the axis to an element's <code>describeData()</code> method. |
| If this flag is set, the element sets the |
| <code>DescribeData.min</code> and <code>DescribeData.max</code> properties. |
| |
| </p></div><a name="constantDetail"></a><a name="REQUIRED_PADDING"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">REQUIRED_PADDING</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const REQUIRED_PADDING:uint = 0x8</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version : </b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A bitflag passed by the axis to an element's <code>describeData()</code> method. |
| If this flag is set, the element sets the |
| <code>DescribeData.padding</code> property. |
| |
| </p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |
