ActiveUI

ActiveUI

  • User Guide
  • Developer Documentation

Home > @activeviam/activeui-sdk > MdxBaseApi

MdxBaseApi interface

Contains basic read/write operations on Mdx and MdxNodes.

Signature:

export interface MdxBaseApi 

Properties

PropertyTypeDescription
createKeyword(a: string) => LiteralNode
createScalar(numberForMdx: Mdx | number) => LiteralNode
createSet(args: ExpressionNode[]) => MdxFunctionNode
createString(a: string) => LiteralNode
getAllCompoundIdentifiers(mdxNode: MdxNode) => CompoundIdentifierNode[]
getCubeName(statement: MdxNode | Mdx) => CubeName | undefined
getEmptyCubeStatement(a: CubeName, discovery?: Discovery) => MdxNode
getIdentifiersValues(a: CompoundIdentifierNode) => string[]
getMeasureCompoundIdentifierName(a: MeasureCompoundIdentifierNode) => MeasureName
getMeasureCompoundIdFilter(measureIn: boolean) => (a: MdxNode) => boolean
getMeasureName(a: MeasureNode, b?: CubeDiscovery) => MeasureName
getMemberName(a: Mdx) => string | undefined
getSetSize(a: MdxNode) => number | null
isAFunction(node: MdxNode) => node is MdxFunctionNode
isAKpiFunction(node: MdxNode) => node is KPIFunctionNode
isALookupFunction(node: MdxNode) => node is LookupFunctionNode
isAnInfixFunction(node: MdxNode) => node is MdxFunctionNode
isARegularFunction(node: MdxNode) => node is MdxFunctionNode
isAxis(node: MdxNode, name?: AxisName) => node is AxisNode
isCase(node: MdxNode) => node is CaseExpressionNode
isColumnsAxis(node: MdxNode) => node is ColsAxisNode
isCompoundIdentifier(node: MdxNode) => node is CompoundIdentifierNode
isDimension(node: MdxNode) => node is DimensionCompoundIdentifierNode
isDrillthrough(node: MdxNode) => node is DrillthroughStatementNode
isEquivalentToCrossjoin(node: MdxNode) => node is MdxFunctionNode
isEquivalentToUnion(node: MdxNode) => node is MdxFunctionNode
isExplicitSet(node: MdxNode) => boolean
isFormula(node: MdxNode) => node is FormulaNode
isFunction(node: MdxNode, name: string) => node is MdxFunctionNode
isHierarchy(node: MdxNode) => node is HierarchyCompoundIdentifierNode
isInfixFunction(node: MdxNode, name: string) => node is MdxFunctionNode
isLevel(node: MdxNode) => node is LevelCompoundIdentifierNode
isLiteral(node: MdxNode) => node is LiteralNode
isMeasure(node: MdxNode) => node is MeasureNode
isMeasureCompoundIdentifier(node: MdxNode) => node is MeasureCompoundIdentifierNode
isMember(node: MdxNode) => node is MemberCompoundIdentifierNode
isNamedSet(node: MdxNode) => node is FormulaNode
isNamedSetCompoundId(node: MdxNode) => node is NamedSetCompoundIdentifierNode
isNegativeNumber(node: MdxNode) => node is MdxFunctionNode
isNull(a: MdxNode) => boolean
isNumber(node: MdxNode) => boolean
isNumericAndOnColsAxis(a: TableHeader) => boolean
isOnRows(a: TableHeader) => boolean
isPlaceHolder(a: LiteralNode) => boolean
isPositiveNumber(node: MdxNode) => node is LiteralNode
isRegularFunction(node: MdxNode, name: string) => node is MdxFunctionNode
isRowsAxis(node: MdxNode) => node is RowsAxisNode
isSameCompoundIdentifier(cId1: CompoundIdentifierNode, cId2: CompoundIdentifierNode) => boolean
isScalar(node: MdxNode) => node is LiteralNode
isSelect(node: MdxNode) => node is SelectNode
isSet(node: MdxNode) => node is MdxFunctionNode
isSlicerAxis(node: MdxNode) => node is SlicerAxisNode
isString(node: MdxNode) => node is LiteralNode
isSubSelect(node: MdxNode) => node is SubSelectNode
isTuple(node: MdxNode | MdxTupleNode) => node is MdxTupleNode
isUnknownCompoundId(node: MdxNode) => node is UnknownCompoundIdentifierNode
isWhen(node: MdxNode) => node is WhenClauseNode
quote(...path: string[]) => Mdx
unquote(a: Mdx) => string[]
updateSnD(snd: StatementAndDiscovery, transform: (a: SelectNode) => SelectNode) => StatementAndDiscovery

Remarks

Some of these functions can be grouped into sets of related functions:

Quoting

Functions for converting between an array of unquoted identifier MDX strings and a single dot-separated compound identifier MDX string.

  • quote

  • unquote

Predicates on MdxNodes

  • isAFunction

  • isAKpiFunction

  • isALookupFunction

  • isAnInfixFunction

  • isARegularFunction

  • isAxis

  • isCase

  • isColumnsAxis

  • isCompoundIdentifier

  • isDimension

  • isDrillthrough

  • isFormula

  • isFunction

  • isHierarchy

  • isInfixFunction

  • isLevel

  • isLiteral

  • isMeasure

  • isMeasureCompoundIdentifier

  • isMember

  • isNamedSet

  • isNamedSetCompoundId

  • isNull

  • isPlaceHolder

  • isRegularFunction

  • isRowsAxis

  • isScalar

  • isSelect

  • isSet

  • isSlicerAxis

  • isString

  • isSubSelect

  • isTuple

  • isUnknownCompoundId

  • isWhen

This API contains other functions that do not belong in a specific group.

  • MdxBaseApi interface
  • Properties
  • Remarks
Copyright © 2019 ActiveViam