Home > @activeviam/activeui-sdk > MdxAxesApi
MdxAxesApi interface
Contains all the operations related to the axes of a Select statement.
Signature:
export interface MdxAxesApi
Properties
| Property | Type | Description |
|---|---|---|
| getAxis | (node: SelectNode, axisName: AxisName) => AxisNode | undefined | |
| getAxisOfMeasuresHierarchy | (snd: StatementAndDiscovery) => AxisNode | undefined | |
| getColumnsAxis | (node: SelectNode) => AxisNode | undefined | |
| getColumnsAxisIndex | (node: SelectNode) => number | |
| getMeasuresAxis | (snd: StatementAndDiscovery) => AxisNode | undefined | |
| getRowsAxis | (node: SelectNode) => AxisNode | undefined | |
| getRowsAxisIndex | (node: SelectNode) => number | |
| getSlicerAxis | (node: SelectNode) => AxisNode | |
| hasAxis | (node: SelectNode, axisName: AxisName) => boolean | |
| isMainAxisName | (name: AxisName) => boolean | |
| listAxes | (statement: SelectNode) => AxisName[] | |
| MEASURES_AXIS_NAME | AxisName | |
| transformOnlyAxis | (statement: SelectNode, axisName: AxisName, transform: (a: AxisNode) => AxisNode, createIfNotExisting: () => AxisNode | undefined) => SelectNode | |
| updateNonEmptyOfAxis | (mdxStatementNode: SelectNode, axisName: AxisName, valueOfNonEmpty: boolean) => SelectNode |
Remarks
Axes can be split in two categories:
the SLICER axis corresponding to the WHERE part of an MDX statement
the main axes: COLUMNS, ROWS (the MDX specification includes more names like PAGES, CHAPTERS, SECTIONS but they are not supported by this API).