blob: d08c36e21f84896b5ed5358e0ebc3dbe6c82568a [file] [log] [blame]
<!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="LegendData,mx.charts.chartClasses.LegendData,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.LegendData</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 = 'LegendData - 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>&nbsp;|&nbsp;<a href="../../../class-summary.html" onclick="loadClassListFrame('../../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../../all-index-A.html" onclick="loadClassListFrame('../../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../../index.html?mx/charts/chartClasses/LegendData.html&amp;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">LegendData</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("LegendData"); titleBar_setSubNav(false,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 LegendData</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">LegendData <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 :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p>
The LegendData structure is used by charts to describe the items
that should be displayed in an auto-generated legend.
A chart's <code>legendData</code> property contains an Array
of LegendData objects, one for each item in the Legend.
<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>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#aspectRatio" class="signatureLink">aspectRatio</a> : Number<div class="summaryTableDescription">
Determines
the size and placement of the legend marker.</div></td><td class="summaryTableOwnerCol">LegendData</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#element" class="signatureLink">element</a> : <a href="../../../mx/charts/chartClasses/IChartElement.html">IChartElement</a><div class="summaryTableDescription">
The chart item that generated this legend item.</div></td><td class="summaryTableOwnerCol">LegendData</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#label" class="signatureLink">label</a> : String<div class="summaryTableDescription">
The text identifying the series or item displayed in the legend item.</div></td><td class="summaryTableOwnerCol">LegendData</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#marker" class="signatureLink">marker</a> : <a href="../../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a><div class="summaryTableDescription">
A visual indicator associating the legend item
with the series or item being represented.</div></td><td class="summaryTableOwnerCol">LegendData</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>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#LegendData()" class="signatureLink">LegendData</a>()</div><div class="summaryTableDescription">
Constructor.</div></td><td class="summaryTableOwnerCol">LegendData</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="aspectRatio"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">aspectRatio</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>public var aspectRatio:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Determines
the size and placement of the legend marker.
If set, the LegendItem ensures that the marker's
width and height match this value.
If unset (<code>NaN</code>), the legend item chooses an appropriate
default width and height.
</p></div><a name="propertyDetail"></a><a name="element"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">element</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public var element:<a href="../../../mx/charts/chartClasses/IChartElement.html">IChartElement</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
The chart item that generated this legend item.
</p></div><a name="propertyDetail"></a><a name="label"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">label</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public var label:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
The text identifying the series or item displayed in the legend item.
</p></div><a name="propertyDetail"></a><a name="marker"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">marker</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public var marker:<a href="../../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
A visual indicator associating the legend item
with the series or item being represented.
This DisplayObject is added as a child to the LegendItem.
</p></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="LegendData()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">LegendData</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function LegendData()</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</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 :&nbsp;</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 :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p>
Constructor.
</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 -->