Home > @activeviam/activeui-sdk > MdxKpiApi
MdxKpiApi interface
Contains all the operations related to KPIs and their functions.
Signature:
export interface MdxKpiApi
Properties
| Property | Type | Description |
|---|---|---|
| Attributes | typeof Attributes | |
| AttributeToFunction | typeof AttributeToFunction | |
| extractPotentialKpiNameFromMeasure | (measureName: MeasureName, attribute?: string) => string | undefined | |
| FunctionToAttribute | FunctionToAttribute | |
| generateCreateKpiStatement | (cubeName: CubeName, kpi: KpiDefinition, usePercentFormat: boolean) => Mdx | |
| generateDropKpiStatement | (cubeName: CubeName, kpi: Pick<KpiDefinition, 'name'>) => Mdx | |
| generateLookupMdx | (lookupName: ParameterName, defaultValue: string) => Mdx | |
| generateSimpleKpiStatusMdx | (kpiName: KpiName, lookup: string, type: 'upper' | 'lower') => Mdx | |
| getKpiFunctionsFromExpression | (expression: MdxNode) => KPIFunctionNode[] | |
| getLookupFunctionsFromExpression | (expression: MdxNode) => LookupFunctionNode[] | |
| isMeasureAnyAttributeOfTheKpiInItsName | (measureName: MeasureName, cubeDiscovery: CubeDiscovery) => boolean | |
| isMeasureAttributeOfKpi | (cubeDiscovery: CubeDiscovery, measureUniqueName: MeasureName, attribute: string, kpiName: KpiName) => boolean | |
| isMeasureAttributeOfTheKpiInItsName | (measureName: MeasureName, cubeDiscovery: CubeDiscovery, attributeName: string) => boolean | |
| KpiFunctionName | KpiFunctionName |