blob: b4450df401813cc75841c1733585714a06367baf [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="OLAPQueryAxis,mx.olap.OLAPQueryAxis,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.OLAPQueryAxis</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 = 'OLAPQueryAxis - 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/OLAPQueryAxis.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">OLAPQueryAxis</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("OLAPQueryAxis"); 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 OLAPQueryAxis</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">OLAPQueryAxis <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/IOLAPQueryAxis.html">IOLAPQueryAxis</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 OLAPQueryAxis interface represents an axis of an OLAP query.
<p></p><a name="mxmlSyntaxSummary"></a><span class="classHeaderTableLabel">MXML Syntax</span><span id="showMxmlLink" style="display:none"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/collapsed.gif" title="collapsed" alt="collapsed" class="collapsedImage">Show MXML Syntax</a><br/></span><span id="hideMxmlLink"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/expanded.gif" title="expanded" alt="expanded" class="expandedImage">Hide MXML Syntax</a></span><div id="mxmlSyntax" class="mxmlSyntax"> <p>
The <code>&lt;mx:OLAPQueryAxis&gt;</code> tag inherits all of the tag attributes
of its superclass, and adds the following tag attributes:
</p>
<pre>
&lt;mx:OLAPQueryAxis
<b>Properties</b>
/&gt;
</div><script language="javascript" type="text/javascript"><!--
setMXMLOnly();
--></script><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="OLAPQuery.html" target="">mx.olap.OLAPQuery</a><br/><a href="IOLAPQueryAxis.html" target="">mx.olap.IOLAPQueryAxis</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="#axisOrdinal" class="signatureLink">axisOrdinal</a> : int<div class="summaryTableDescription">
The type of axis, as
OLAPQuery.COLUMN AXIS for a column axis,
OLAPQuery.ROW_AXIS for a row axis,
and OLAPQuery.SLICER_AXIS for a slicer axis.</div></td><td class="summaryTableOwnerCol">OLAPQueryAxis</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#sets" class="signatureLink">sets</a> : Array<div class="summaryTableDescription">[read-only]
All the sets of the query axis, as an Array of IOLAPSet instances.</div></td><td class="summaryTableOwnerCol">OLAPQueryAxis</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#tuples" class="signatureLink">tuples</a> : Array<div class="summaryTableDescription">[read-only]
All the tuples added to the query axis, as an Array of IOLAPTuple instances.</div></td><td class="summaryTableOwnerCol">OLAPQueryAxis</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="#OLAPQueryAxis()" class="signatureLink">OLAPQueryAxis</a>(ordinal:int)</div><div class="summaryTableDescription">
Constructor
</div></td><td class="summaryTableOwnerCol">OLAPQueryAxis</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>(m:<a href="../../mx/olap/IOLAPMember.html">IOLAPMember</a>):void</div><div class="summaryTableDescription">
Adds a single member to the query axis.</div></td><td class="summaryTableOwnerCol">OLAPQueryAxis</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addSet()" class="signatureLink">addSet</a>(s:<a href="../../mx/olap/IOLAPSet.html">IOLAPSet</a>):void</div><div class="summaryTableDescription">
Adds a set to the query axis.</div></td><td class="summaryTableOwnerCol">OLAPQueryAxis</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addTuple()" class="signatureLink">addTuple</a>(t:<a href="../../mx/olap/IOLAPTuple.html">IOLAPTuple</a>):void</div><div class="summaryTableDescription">
Adds a tuple to the query axis.</div></td><td class="summaryTableOwnerCol">OLAPQueryAxis</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#clear()" class="signatureLink">clear</a>():void</div><div class="summaryTableDescription">
Clears all the sets, tuples and members from this axis.</div></td><td class="summaryTableOwnerCol">OLAPQueryAxis</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="axisOrdinal"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">axisOrdinal</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>public var axisOrdinal:int</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 type of axis, as
<code>OLAPQuery.COLUMN AXIS</code> for a column axis,
<code>OLAPQuery.ROW_AXIS</code> for a row axis,
and <code>OLAPQuery.SLICER_AXIS</code> for a slicer axis.
</p></div><a name="propertyDetail"></a><a name="sets"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">sets</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>sets:Array</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>
All the sets of the query axis, as an Array of IOLAPSet instances.
This Array includes sets added by the <code>addMember()</code>
and <code>addTuple()</code> methods.
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get sets():Array</code><br/></div><a name="propertyDetail"></a><a name="tuples"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">tuples</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>tuples:Array</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>
All the tuples added to the query axis, as an Array of IOLAPTuple instances.
This Array includes tuples added by the <code>addMember()</code>
and <code>addSet()</code> methods.
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get tuples():Array</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="OLAPQueryAxis()"></a><a name="OLAPQueryAxis(int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">OLAPQueryAxis</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function OLAPQueryAxis(ordinal:int)</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><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">ordinal</span>:int</code> &mdash; The type of axis.
Use <code>OLAPQuery.COLUMN AXIS</code> for a column axis,
<code>OLAPQuery.ROW_AXIS</code> for a row axis,
and <code>OLAPQuery.SLICER_AXIS</code> for a slicer axis.
</td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="addMember()"></a><a name="addMember(mx.olap.IOLAPMember)"></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(m:<a href="../../mx/olap/IOLAPMember.html">IOLAPMember</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 single member to the query axis.
The member is automatically converted to an IOLPASet instance.
This method is useful when adding a member to a slicer axis.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">m</span>:<a href="../../mx/olap/IOLAPMember.html">IOLAPMember</a></code> &mdash; The member to add to the query.
</td></tr></table></p></div><a name="addSet()"></a><a name="addSet(mx.olap.IOLAPSet)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addSet</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function addSet(s:<a href="../../mx/olap/IOLAPSet.html">IOLAPSet</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 set to the query axis.
The set define the members and tuples that provide the information for the query axis.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">s</span>:<a href="../../mx/olap/IOLAPSet.html">IOLAPSet</a></code> &mdash; The set to add to the query.
</td></tr></table></p></div><a name="addTuple()"></a><a name="addTuple(mx.olap.IOLAPTuple)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addTuple</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function addTuple(t:<a href="../../mx/olap/IOLAPTuple.html">IOLAPTuple</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 tuple to the query axis.
The tuple is automatically converted to an IOLPASet instance.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">t</span>:<a href="../../mx/olap/IOLAPTuple.html">IOLAPTuple</a></code> &mdash; The tuple to add to the query.
</td></tr></table></p></div><a name="clear()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">clear</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function clear():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>
Clears all the sets, tuples and members from this axis.
</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 -->