mx.olap

# OLAPQueryAxis - AS3 Flex

Package | mx.olap
Class | public class OLAPQueryAxis
Inheritance | OLAPQueryAxis 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 Syntax Show MXML Syntax
Hide 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

mx.olap.OLAPQuery
mx.olap.IOLAPQueryAxis

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined 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
|  | constructor : 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
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | OLAPQueryAxis(ordinal:int) Constructor | OLAPQueryAxis
|  | addMember(m:IOLAPMember):void Adds a single member to the query axis. | OLAPQueryAxis
|  | addSet(s:IOLAPSet):void Adds a set to the query axis. | OLAPQueryAxis
|  | addTuple(t:mx.olap:IOLAPTuple):void Adds a tuple to the query axis. | OLAPQueryAxis
|  | clear():void Clears all the sets, tuples and members from this axis. | OLAPQueryAxis
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object 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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00