ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.olap 

OLAPQueryAxis  - AS3 Flex

Packagemx.olap
Classpublic class OLAPQueryAxis
InheritanceOLAPQueryAxis Inheritance Object
Implements IOLAPQueryAxis

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The OLAPQueryAxis interface represents an axis of an OLAP query.

MXML SyntaxexpandedHide MXML Syntax

The <mx:OLAPQueryAxis> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:OLAPQueryAxis
    Properties
  />
 
  

Related API Elements



Public Properties
 PropertyDefined By
  axisOrdinal : int
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.
OLAPQueryAxis
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  sets : Array
[read-only] All the sets of the query axis, as an Array of IOLAPSet instances.
OLAPQueryAxis
  tuples : Array
[read-only] All the tuples added to the query axis, as an Array of IOLAPTuple instances.
OLAPQueryAxis
Public Methods
 MethodDefined By
  
Constructor
OLAPQueryAxis
  
Adds a single member to the query axis.
OLAPQueryAxis
  
Adds a set to the query axis.
OLAPQueryAxis
  
Adds a tuple to the query axis.
OLAPQueryAxis
  
Clears all the sets, tuples and members from this axis.
OLAPQueryAxis
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

axisOrdinal

property
public var axisOrdinal:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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.

sets

property 
sets:Array  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

All the sets of the query axis, as an Array of IOLAPSet instances. This Array includes sets added by the addMember() and addTuple() methods.



Implementation
    public function get sets():Array

tuples

property 
tuples:Array  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

All the tuples added to the query axis, as an Array of IOLAPTuple instances. This Array includes tuples added by the addMember() and addSet() methods.



Implementation
    public function get tuples():Array
Constructor Detail

OLAPQueryAxis

()Constructor
public function OLAPQueryAxis(ordinal:int)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor

Parameters
ordinal:int — The type of axis. Use OLAPQuery.COLUMN AXIS for a column axis, OLAPQuery.ROW_AXIS for a row axis, and OLAPQuery.SLICER_AXIS for a slicer axis.
Method Detail

addMember

()method
public function addMember(m:IOLAPMember):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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.

Parameters

m:IOLAPMember — The member to add to the query.

addSet

()method 
public function addSet(s:IOLAPSet):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Adds a set to the query axis. The set define the members and tuples that provide the information for the query axis.

Parameters

s:IOLAPSet — The set to add to the query.

addTuple

()method 
public function addTuple(t:mx.olap:IOLAPTuple):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Adds a tuple to the query axis. The tuple is automatically converted to an IOLPASet instance.

Parameters

t:mx.olap:IOLAPTuple — The tuple to add to the query.

clear

()method 
public function clear():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Clears all the sets, tuples and members from this axis.