blob: 749202927ce7ffbd96847284c9ebfe793c142def [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="IStackable,mx.charts.chartClasses.IStackable,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,addChild,addChild,addChild,addChildAt,addChildAt,addChildAt,addDataChild,addDataChild,addDragData,adjustGutters,adjustMinMax,applySeriesSet,beginBitmapFill,beginBitmapFill,beginFill,beginFill,beginInterpolation,beginInterpolation,buildLabelCache,buildMinorTickCache,buildSubSeries,cacheDefaultValues,cacheIndexValues,cacheNamedValues,chartStateChanged,chartStateChanged,chartStateChanged,claimStyles,claimStyles,claimStyles,clear,clear,clearSelection,clone,collectTransitions,collectTransitions,colorFromFill,commitProperties,commitProperties,commitProperties,createChildren,createChildren,createDataID,curveTo,curveTo,customizeSeries,customizeSeries,dataChanged,dataChanged,dataChanged,dataChanged,dataToLocal,dataToLocal,dataToLocal,defaultFilterFunction,describeData,describeData,describeData,describeData,describeData,describeData,describeData,dragCompleteHandler,dragDropHandler,dragEnterHandler,dragExitHandler,dragOverHandler,dragStartHandler,dragStartHandler,drawArc,drawCircle,drawCircle,drawEllipse,drawEllipse,drawPolyLine,drawRect,drawRect,drawRoundedRect,drawRoundedRect,endFill,endFill,endInterpolation,extractMinInterval,extractMinMax,fillFromStyle,fillRect,filterCache,filterCache,findDataPoints,findDataPoints,findDataPoints,formatDataTip,formatDataTip,formatForScreen,formatForScreen,getAllDataPoints,getAllDataPoints,getAllDataPoints,getAxis,getAxis,getElementBounds,getElementBounds,getFirstItem,getFirstItem,getFirstItem,getItemsInRegion,getItemsInRegion,getItemsInRegion,getLabelEstimate,getLabelEstimate,getLabels,getLabels,getLastItem,getLastItem,getLastItem,getMissingInterpolationValues,getMissingInterpolationValues,getNextItem,getNextItem,getNextItem,getPreviousItem,getPreviousItem,getPreviousItem,getRenderDataForTransition,guardMinMax,hideData,hideDropFeedback,initializeInterpolationData,interpolate,invalidateCache,invalidateChildOrder,invalidateData,invalidateData,invalidateData,invalidateData,invalidateDisplayList,invalidateDisplayList,invalidateFilter,invalidateMapping,invalidateSeries,invalidateSeries,invalidateSeriesStyles,invalidateSize,invalidateStacking,invalidateTransform,invalidateTransitions,invertTransform,invertTransform,invertTransform,invertTransform,legendDataChanged,legendDataChanged,lineStyle,lineStyle,lineTo,lineTo,localToData,localToData,localToData,mapCache,mapCache,mappingChanged,mappingChanged,mappingChanged,mappingChanged,measure,measure,moveTo,moveTo,positionAllDataTips,positionDataTips,preferDropLabels,preferDropLabels,processNewDataProvider,reduceLabels,reduceLabels,registerDataTransform,registerDataTransform,removeAllChildren,removeAllChildren,removeChild,removeChild,removeChildAt,removeChildAt,setActualSize,setActualSize,setAxis,setAxis,setLineStyle,setSize,showDropFeedback,stack,stack,stackAll,stripNaNs,stripNaNs,stripNaNs,styleChanged,styleChanged,stylesInitialized,transformCache,transformCache,transformCache,transformCache,transformCache,unregisterDataTransform,unregisterDataTransform,update,update,updateAllDataTips,updateData,updateData,updateDataChild,updateDataChild,updateDisplayList,updateDisplayList,updateDisplayList,updateDisplayList,updateDisplayList,updateDisplayList,updateDisplayList,updateDisplayList,updateFilter,updateFilter,updateFilter,updateFilter,updateMapping,updateMapping,updateStacking,updateTransform,updateTransform,validateData,validateData,validateData,validateTransform,validateTransform,validateTransform"><title>mx.charts.chartClasses.IStackable</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 = 'IStackable - 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/IStackable.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">IStackable</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("IStackable"); 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">Interface</td><td class="classSignature">public interface IStackable</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 IStackable interface is implemented by any series that can be stacked.
Stacking sets (ColumnSet, BarSet, AreaSet) require that any sub-series
assigned to it when stacking implement this interface.
<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="#stacker" class="signatureLink">stacker</a> : <a href="../../../mx/charts/chartClasses/StackedSeries.html">StackedSeries</a><div class="summaryTableDescription">
The StackedSeries associated with this series.</div></td><td class="summaryTableOwnerCol">IStackable</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#stackTotals" class="signatureLink">stackTotals</a> : Dictionary<div class="summaryTableDescription">[write-only]
The stack totals for the series.</div></td><td class="summaryTableOwnerCol">IStackable</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="#stack()" class="signatureLink">stack</a>(stackedXValueDictionary:Dictionary, previousElement:<a href="../../../mx/charts/chartClasses/IStackable.html">IStackable</a>):Number</div><div class="summaryTableDescription">
Stacks the series.</div></td><td class="summaryTableOwnerCol">IStackable</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="stacker"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">stacker</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>stacker:<a href="../../../mx/charts/chartClasses/StackedSeries.html">StackedSeries</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 StackedSeries associated with this series.
The stacker manages the series's stacking behavior.
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get stacker():<a href="../../../mx/charts/chartClasses/StackedSeries.html">StackedSeries</a></code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set stacker(value:<a href="../../../mx/charts/chartClasses/StackedSeries.html">StackedSeries</a>):void</code><br/></div><a name="propertyDetail"></a><a name="stackTotals"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">stackTotals</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>stackTotals:Dictionary</code>&nbsp;&nbsp;[write-only] <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 stack totals for the series.
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set stackTotals(value:Dictionary):void</code><br/></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="stack()"></a><a name="stack(flash.utils.Dictionary,mx.charts.chartClasses.IStackable)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">stack</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function stack(stackedXValueDictionary:Dictionary, previousElement:<a href="../../../mx/charts/chartClasses/IStackable.html">IStackable</a>):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>
Stacks the series. Normally, a series implements the <code>updateData()</code> method
to load its data out of the data provider. But a stacking series performs special
operations because its values are not necessarily stored in its data provider.
Its values are whatever is stored in its data provider, summed with the values
that are loaded by the object it stacks on top of.
<p>A custom stacking series should implement the <code>stack()</code> method by loading its
data out of its data provider, adding it to the base values stored in the dictionary
to get the real values it should render with, and replacing the values in the dictionary
with its new, summed values.</p>
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">stackedXValueDictionary</span>:Dictionary</code> &mdash; Contains the base values that the series should stack
on top of. The keys in the dictionary are the y values, and the values are the x values.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">previousElement</span>:<a href="../../../mx/charts/chartClasses/IStackable.html">IStackable</a></code> &mdash; The previous element in the stack. If, for example, the element
is of the same type, you can use access to this property to avoid duplicate effort when
rendering.
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> &mdash; The maximum value in the newly stacked series.
</td></tr></table></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 -->