blob: 25b082b0e21b23ffcf09d24af24dd286c2c7f5a1 [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="OLAPTuple,mx.olap.OLAPTuple,COLUMN_AXIS,COLUMN_AXIS,ROW_AXIS,ROW_AXIS,SLICER_AXIS,SLICER_AXIS,TRACE_LEVEL_1,TRACE_LEVEL_2,TRACE_LEVEL_3,aggregator,allMemberName,allMemberName,attribute,attributeName,attributes,attributes,axes,axes,axes,axisOrdinal,cellData,child,child,children,children,children,children,cube,cube,cubeArray,cubeBuildingTimeInterval,cubes,cubes,dataCompareFunction,dataField,dataField,dataField,dataFunction,dataProvider,defaultMember,defaultMember,defaultMember,defaultMember,depth,depth,dimension,dimension,dimension,dimensions,dimensions,displayName,displayName,displayNameFunction,elements,elements,elements,explicitMembers,explicitMembers,formattedValue,formattedValue,hasAll,hasAll,hasAll,hierarchies,hierarchies,hierarchy,hierarchy,hierarchy,hierarchy,isAll,isAll,isMeasure,isMeasure,isMeasure,isMeasure,level,level,levels,levels,measureDimensionName,measures,members,members,members,members,members,members,members,members,members,name,name,name,name,name,name,parent,parent,parent,parent,positions,positions,query,query,queryBuildingTimeInterval,resultClass,sets,sets,traceLevel,traceOn,tuples,tuples,tuples,uniqueName,uniqueName,uniqueName,uniqueName,value,value,workDuration,addElement,addElement,addElements,addElements,addEventListener,addMember,addMember,addMember,addMember,addMembers,addMembers,addPosition,addSet,addSet,addTuple,addTuple,addTuple,addTuple,cancelQuery,cancelQuery,cancelRefresh,cancelRefresh,clear,compareMembers,computeBegin,computeEnd,computeLoop,computeObjectBegin,computeObjectEnd,computeObjectLoop,createCube,createCube,crossJoin,crossJoin,dispatchEvent,execute,execute,findAttribute,findAttribute,findChildMember,findChildMember,findCommonHierarchy,findDimension,findDimension,findHierarchy,findHierarchy,findLevel,findLevel,findMember,findMember,findMember,findMember,findMember,findMember,getAxis,getAxis,getAxis,getAxis,getCell,getCell,getCube,getCube,hasEventListener,hasRowData,hierarchize,hierarchize,refresh,refresh,removeEventListener,removePosition,setAxis,setAxis,sortTuple,toString,toString,traceMsg,union,union,willTrigger"><title>mx.olap.OLAPTuple</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 = 'OLAPTuple - 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/olap/OLAPTuple.html&amp;mx/olap/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">OLAPTuple</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("OLAPTuple"); 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.olap</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class OLAPTuple</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">OLAPTuple <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../mx/olap/IOLAPTuple.html">IOLAPTuple</a></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 OLAPTuple class reprsents a tuple expression pointing to an OLAP cube cell.
A tuple is made up of one member from every dimension that is contained within a cube.
The complete expression of a tuple identifier is made up of one or more explicitly specified members,
in parentheses.
A tuple can be fully qualified, can contain implicit members, or can contain a single member.
Any dimension that is not explicitly referenced within a tuple is implicitly referenced.
<p>The member for the implicitly referenced dimension depends on the structure of the dimension:
<ul>
<li>If the implicitly referenced dimension has a default member,
the default member is added to the tuple.</li>
<li>If the implicitly referenced dimension has no default member,
the (All) member of the default hierarchy is used.</li>
<li>If the implicitly referenced dimension has no default member,
and the default hierarchy has no (All) member,
the first member of the topmost level of the default hierarchy is used.</li>
</ul>
</p>
<p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="IOLAPTuple.html" target="">mx.olap.IOLAPTuple</a></div><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="#explicitMembers" class="signatureLink">explicitMembers</a> : <a href="../../mx/collections/IList.html">IList</a><div class="summaryTableDescription">[read-only]
The user added members of this tuple, as a list of IOLAPMember instances.</div></td><td class="summaryTableOwnerCol">OLAPTuple</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="#OLAPTuple()" class="signatureLink">OLAPTuple</a>()</div><div class="summaryTableDescription">
Constructor
</div></td><td class="summaryTableOwnerCol">OLAPTuple</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addMember()" class="signatureLink">addMember</a>(element:<a href="../../mx/olap/IOLAPElement.html">IOLAPElement</a>):void</div><div class="summaryTableDescription">
Adds a new member to the tuple.</div></td><td class="summaryTableOwnerCol">OLAPTuple</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addMembers()" class="signatureLink">addMembers</a>(value:<a href="../../mx/collections/IList.html">IList</a>):void</div><div class="summaryTableDescription">
Adds a list of members to the tuple.</div></td><td class="summaryTableOwnerCol">OLAPTuple</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="explicitMembers"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">explicitMembers</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>explicitMembers:<a href="../../mx/collections/IList.html">IList</a></code>&nbsp;&nbsp;[read-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 user added members of this tuple, as a list of IOLAPMember instances.
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get explicitMembers():<a href="../../mx/collections/IList.html">IList</a></code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="OLAPTuple()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">OLAPTuple</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function OLAPTuple()</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><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="addMember()"></a><a name="addMember(mx.olap.IOLAPElement)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addMember</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function addMember(element:<a href="../../mx/olap/IOLAPElement.html">IOLAPElement</a>):void</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>
Adds a new member to the tuple.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">element</span>:<a href="../../mx/olap/IOLAPElement.html">IOLAPElement</a></code> &mdash; The member to add.
If <code>member</code> is a dimension or hierarchy, its default member
is added. If <code>member</code> is an instance of IOLAPMember,
it is added directly.
</td></tr></table></p></div><a name="addMembers()"></a><a name="addMembers(mx.collections.IList)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addMembers</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function addMembers(value:<a href="../../mx/collections/IList.html">IList</a>):void</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>
Adds a list of members to the tuple.
This method can be called when many members need to be added to the tuple.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">value</span>:<a href="../../mx/collections/IList.html">IList</a></code> &mdash; The members to add, as a list of IOLAPMember instances.
</td></tr></table></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 -->