Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
OLAPQueryAxis

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
      />

See also

mx.olap.OLAPQuery
mx.olap.IOLAPQueryAxis

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
|  | 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

| 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:IOLAPTuple):void Adds a tuple to the query axis. | OLAPQueryAxis
|  | clear():void Clears all the sets, tuples and members from this axis. | OLAPQueryAxis

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: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: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.

Wed Nov 15 2017, 09:50 AM +01:00