Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
OLAPQuery

Package | mx.olap
Class | public class OLAPQuery
Inheritance | OLAPQuery Object
Implements | IOLAPQuery

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The OLAPQuery interface represents an OLAP query that is executed on an IOLAPCube.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

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

      <mx:OLAPQuery
        Properties
           axis=""
      />

Default MXML Property `axes`

See also

mx.olap.IOLAPQuery
mx.olap.IOLAPQueryAxis
mx.olap.OLAPQueryAxis

Public Properties

| Property | Defined By
--- | --- | ---
|  | axes : Array The axis of the Query as an Array of OLAPQueryAxis instances. | OLAPQuery
|  | COLUMN_AXIS : int = 0 [static] Specifies a column axis. | OLAPQuery
|  | ROW_AXIS : int = 1 [static] Specifies a row axis. | OLAPQuery
|  | SLICER_AXIS : int = 2 [static] Specifies a slicer axis. | OLAPQuery

Public Methods

| Method | Defined By
--- | --- | ---
|  | getAxis(axisOrdinal:int):IOLAPQueryAxis Gets an axis from the query. | OLAPQuery
|  | setAxis(axisOrdinal:int, axis:IOLAPQueryAxis):void Sets an axis to the query. | OLAPQuery

Property Detail

axes | property

`axes:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The axis of the Query as an Array of OLAPQueryAxis instances. A query can have three axes: column, row, and slicer.

Implementation
`public function get axes():Array`
`public function set axes(value:Array):void`

COLUMN_AXIS | property |

`public static var COLUMN_AXIS:int = 0`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies a column axis. Use this property as a value of the `axisOrdinal` argument to the `getAxis()` method.

ROW_AXIS | property |

`public static var ROW_AXIS:int = 1`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies a row axis. Use this property as a value of the `axisOrdinal` argument to the `getAxis()` method.

SLICER_AXIS | property |

`public static var SLICER_AXIS:int = 2`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Specifies a slicer axis. Use this property as a value of the `axisOrdinal` argument to the `getAxis()` method.

Method Detail

getAxis | () | method

`public function getAxis(axisOrdinal:int):IOLAPQueryAxis`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Gets an axis from the query. You typically call this method to obtain an uninitialized IOLAPQueryAxis instance, then configure the IOLAPQueryAxis instance for the query.

Parameters

| `axisOrdinal:int` — Specify `OLAPQuery.COLUMN AXIS` for a column axis, `OLAPQuery.ROW_AXIS` for a row axis, and `OLAPQuery.SLICER_AXIS` for a slicer axis.

Returns

| `IOLAPQueryAxis` — The IOLAPQueryAxis instance.

setAxis | () | method |

`public function setAxis(axisOrdinal:int, axis:IOLAPQueryAxis):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Sets an axis to the query.

Parameters

| `axisOrdinal:int` — Specify `OLAPQuery.COLUMN AXIS` for a column axis, `OLAPQuery.ROW_AXIS` for a row axis, and `OLAPQuery.SLICER_AXIS` for a slicer axis.
| `axis:IOLAPQueryAxis` — The IOLAPQueryAxis instance.

Sun Mar 5 2017, 03:42 PM +11:00