Types

AccessLog

PropertyTypeDescription
idstring
lastOpenednumber

ActionProps

  • WidgetActionProps<WidgetState, SelectionType>
  • WidgetInDashboardActionProps<WidgetState, SelectionType>

ActivePivotClient

Provides methods to interact with an ActivePivot server:

  • Allows to run MDX queries against ActivePivot via a websocket.

  • Allows to perform REST calls against ActivePivot.

PropertyTypeDescription
connectionStatusConnectionStatusThe current connection status of the client.
dataModelDataModel | undefinedReturns the DataModel if it is already loaded. See loadDataModel
MethodDescription
addConnectionStatusListenerRegisters listener to be called whenever the client status changes.
addDataModelListenerRegisters listener to be called whenever the data model changes.
addQueryListenerRegisters listener to be called whenever the Query identified by queryId is updated. listener is also called synchronously once, in case this query already exists.
addQueryResultListenerRegisters listener to be called whenever a new QueryResult is received for the Query identified by queryId. listener is also called synchronously once, in case results were already received for this query.
connectAsynchronously connects the client to the ActivePivot server's query streaming service. Resolves immediately if the client is already connected.
disconnectDisconnects the client from the ActivePivot server's query streaming service.
fetchAvailableDrillthroughColumnsAsynchronously returns the list of available DrillthroughColumn for query.
getQueryReturns the Query identified by queryId if it exists.
getQueryResultReturns the latest QueryResult for the Query identified by queryId.
loadDataModelAsynchronously loads the DataModel, making it available through ActivePivotClient. Can be called several times to load an up-to-date version.
refreshQueryRe-executes a paused query once.
removeConnectionStatusListenerRemoves listener and stops calling it whenever the client status changes.
removeDataModelListenerRemoves listener and stops calling it whenever the data model changes.
removeQueryListenerRemoves listener and stops calling it when the Query identified by queryId is updated.
removeQueryResultListenerRemoves listener and stops calling it when a new QueryResult is received for the Query identified by queryId. If it was the last listener on the results of the Query identified by queryId, stops the query.
setQueryUpdates the Query identified by queryId or register it if it did not exist. Marks the query as loading and sends a message to the server.

Activity

Information about the past usage of ActiveUI by the current user. Useful to provide shortcuts to recently used elements, and more. Regroups all pieces of information stored on the Content Server, belonging to a user and which are not settings.

PropertyTypeDescription
recentlyOpenedDashboardsAccessLog[]The ids of the dashboards recently opened by the current user, ordered by last opened
userFilters(T extends "serialized" ? MdxString : Mdx)[]Filters attached to the current user and applying to all dashboards she visits.

ADataModelNode

A node in a data model tree, under a cube.

PropertyTypeDescription
cubeNamestring
serverKeystring

AMetaData

PropertyTypeDescription
isFolderboolean
namestring

ANode

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean

ApiKey

  • "sentinel"
  • "jwt"
  • "pivot"
  • "repository"
  • "content"
  • "reporting"

APlugin

Type extended by every plugin type. Each plugin must specify its key and can come with its own translations.

{
   key: string;
   translations?: {
     [locale: string]: Tree<string>;
  };
}

Argument

  • "PLACE_HOLDER" /** * boolean, int, double, date, … */
  • "SCALAR" /** * function keyword */
  • "KEYWORD" /** * string (means will be surrounded by single quotes) */
  • "STRING"

AWidgetState

The state of any widget. Note that this interface is typically extended by each individual widget plugin.

PropertyTypeDescription
filters(T extends "serialized" ? MdxString : Mdx)[]
isFullScreenboolean
namestring
queryContextQueryContextEntry[]
widgetKeystring

Axis

PropertyTypeDescription
hierarchies{
   dimension: DimensionName;
   hierarchy: HierarchyName;
}[]
idAxisId
maxLevelPerHierarchynumber[]
positionsMember[][]
rangeAxisRange

AxisId

  • -1
  • 0
  • 1
  • 2
  • 3
  • 4

AxisName

  • "COLUMNS"
  • "0"
  • "ROWS"
  • "1"
  • "SLICER"
  • "PAGES"

AxisRange

PropertyTypeDescription
axisLengthnumber
entireAxisboolean
fromnumber
tonumber

Catalog

PropertyTypeDescription
cubesCube[]
namestring

Cell

PropertyTypeDescription
formattedValuestring
ordinalnumber
properties{
   [key in CellProperty]?: null | string | number | undefined;
}
valuenumber | string

CellPlugin

Plugin useful for cell Components usable on table widgets.

PropertyTypeDescription
CellForwardRefExoticComponent<CellPropsType & RefAttributes<HTMLDivElement>>

CellPluginForCellSetTable

Most used variant of CellPlugin, suitable for table widgets representing a CellSet.

CellPlugin<CellSetTableCellProps>

CellProperty

  • "BACK_COLOR"
  • "DISPLAY_INFO"
  • "FORE_COLOR"
  • "FONT_NAME"
  • "FONT_FLAGS"
  • "FONT_SIZE"
  • "FORMAT_STRING"

CellSet

PropertyTypeDescription
axesAxis[]
cellsCell[]
cubeCubeName
defaultMembersDefaultMember[]
epochnumber

CellSetAxesSelection

Represents elements of a cellset's axes that a user can select on a data visualization widget.

  • { id: AxisId; hierarchies?: (LevelCoordinates
  • {
       dimensionName: "Measures";
       hierarchyName: "Measures";
    })[];
    positions?: Tuple[];
    }[]

CellSetCellsSelection

Represents cells of a cellset's that a user can select on a data visualization widget.

  • { tuple: Tuple; value?: number
  • string; }[]

CellSetSelection

A selection of cells, positions and levels in a CellSet.

{
   axes?: CellSetAxesSelection;
   cells?: CellSetCellsSelection;
}

CellSetTableBodyCellProps

The props of body cells in a cellset table.

LoadingTableCellProps & DerivedCellSetTableBodyCellProps

CellSetTableCellProps

The props of cells in a cellset table.

CellSetTableHeaderCellProps

The props of header cells in a cellset table.

LoadingTableCellProps & DerivedCellSetTableHeaderCellProps

CellSetTableStaticHeaderCellProps

The props of static header cells in a cellset table.

LoadingTableCellProps & DerivedCellSetTableStaticHeaderCellProps

CellStylePlugin

Plugin useful to provide style to cells in table widgets.

PropertyTypeDescription
withCellStyle<T extends CellPropsType = CellPropsType>(CellComponent: ForwardRefExoticComponent<T & RefAttributes<HTMLDivElement>>) => ForwardRefExoticComponent<PropsWithoutRef<T> & RefAttributes<HTMLDivElement>>

CellStylePluginForCellSetTable

Most used variant of CellStylePlugin, suitable for table widgets representing a CellSet.

CellStylePlugin<CellSetTableCellProps>

Color

A string representing a color.

string

Configuration

Object describing how ActiveUI is configured. In particular, it describes which Plugins are registered, which has an impact both on the application functionalities and on the bundle size.

PropertyTypeDescription
drawersDrawer[]
higherOrderComponents((wrappedComponent: ComponentType) => ComponentType)[]Higher-order components (HOCs) wrapping the application. In particular, it allows to provide React contexts such as the ClientContext.See https://reactjs.org/docs/higher-order-components.html
initialDashboardPageStateOmit<DashboardPageState, "name">
pluginRegistryPluginRegistry

ConnectionStatus

The connection status of an ActivePivotClient. When "connected", queries can be run against it using useQueryResult.

  • "disconnected"
  • "connecting"
  • "connected"

ContentClient

Provides methods to interact with the Content Server.

MethodDescription
addActivityListenerRegisters listener to be called whenever the value of the activity identified by activityKey is updated.
addSettingListenerRegisters listener to be called whenever the value of the setting identified by settingKey is updated.
addTreeListener
addTreeListener
addTreeListener
addTreeListenerRegisters listener to be called whenever the dashboards, filters, or widgets tree is reloaded.
createFileAsynchronously creates a dashboard or a widget file on the Content Server. Returns its id.
createFolderAsynchronously creates a dashboard or a widget folder on the Content Server. Returns its id.
deleteFileAsynchronously deletes a dashboard or a widget file on the Content Server.
deleteFolderAsynchronously deletes a dashboard or a widget folder on the Content Server.
fetchFileAsynchronously returns the content of a dashboard or a widget file on the Content Server. Includes the file's metadata unless withMetaData: false is given, in which case pathToFolder is optional.
fetchThumbnailAsynchronously returns the thumbnail at path if it exists.
fetchThumbnailsAsynchronously returns all accessible thumbnails in pathToFolder. Does not return thumbnails of subfolders. Returns a record object where values are the thumbnail images and keys are the ids of the files they relate to.
getActivityReturns the value of the activity identified by activityKey if it exists.
getSettingReturns the value of the setting identified by settingKey if it exists.
getTree
getTree
getTree
getTreeReturns the dashboards, filters, or widgets tree, if it is already loaded.
loadActivityAsynchronously loads the Activity of the current user and makes it available via getActivity.
loadSettingsAsynchronously loads the settings, making them available via getSetting.
loadTree
loadTree
loadTreeAsynchronously loads the tree of all accessible dashboards, filters, or widgets.
moveFileAsynchronously moves a dashboard or a widget into a folder on the Content Server.
removeActivityListenerRemoves listener and stops calling it when the value of the activity identified by activityKey is updated.
removeSettingListenerRemoves listener and stops calling it when the value of the setting identified by settingKey is updated.
removeTreeListener
removeTreeListener
removeTreeListener
removeTreeListenerRemoves listener and stops calling it whenever the dashboards or widgets tree is reloaded.
updateActivitySaves the new version of the user's Activity on the Content Server.
updateFileAsynchronously updates an existing dashboard or widget file on the Content Server.
updateFilePermissionsAsynchronously updates an existing dashboard or widget file's permissions on the Content Server.
updateFolderAsynchronously updates an existing dashboard or widget folder on the Content Server.
updateFolderPermissionsAsynchronously updates an existing folder's permissions on the Content Server.
updateSettingAsynchronously updates the value of the setting identified by key for the given user.

ContentEntry

PropertyTypeDescription
canReadboolean
canWriteboolean
contentContent
isDirectoryboolean
lastEditorstring
namestring
ownersstring[]
readersstring[]
timestampnumber

ContentNode

PropertyTypeDescription
entryContentEntry<AMetaData>
idstring
metaDataMetaData
typeContentNodeType

ContentRecord

PropertyTypeDescription
children{
   [childName: string]: ContentRecord<Content>;
}
entryContentEntry<Content>

ContentType

  • "dashboard"
  • "widget"
  • "filter"

ContextValueDefinition

PropertyTypeDescription
categorystring
descriptionstring
namestring
typestring

Cube

PropertyTypeDescription
captionstring
contextValuesDefaultContextValue[]
defaultMembersDefaultMember[]
dimensionsDimension[]
kpisKpi[]
measureGroupsMeasureGroup[]
measuresMeasure[]
nameCubeName
setsSet[]

CubeName

string

CubeNode

A data model tree node representing a cube

PropertyTypeDescription
namestring
serverKeystring
type"cube"

CustomFilter

PropertyTypeDescription
type"custom"

DashboardContent

The content of a dashboard file on the Content Server.

Omit<DashboardState<"serialized">, "name">

DashboardMetaData

The content of a dashboard meta data file on the Content Server, representing this dashboard in the dashboards tree.

AMetaData

DashboardPageState

The state of a dashboard page. content contains the state of each leaf. layout represents how they are laid out.

{
   content: {
     [leafKey: string]: WidgetStateType;
  };
   filters?: (T extends "serialized" ? MdxString : Mdx)[];
   queryContext?: QueryContextEntry[];
   layout: Layout;
   name: string;
}

DashboardState

The state of a dashboard. pages contains the state of each page.

{
   filters?: (T extends "serialized" ? MdxString : Mdx)[];
   queryContext?: QueryContextEntry[];
   name?: string;
   pages: {
     [pageKey: string]: DashboardPageState<T>;
  };
   pagesOrder: string[];
}

DataModel

Describes the data contained in a server.

PropertyTypeDescription
catalogsCatalog[]
contextValuesContextValueDefinition[]

DataModelNode

A data model tree node

DataVisualizationContentEditorProps

EditorProps<DataVisualizationWidgetState> & {
   extraSection?: JSX.Element;
   onTileMovedFromExtraSection?: (toSection: string, item: any, toPosition: number) => void;
}

DataVisualizationWidgetState

PropertyTypeDescription
mappingT extends "serialized" ? SerializedDataVisualizationWidgetMapping : DataVisualizationWidgetMapping
styleAttributesstring[]
switchedTostring

DefaultContextValue

PropertyTypeDescription
namestring
valuestring

DefaultMember

PropertyTypeDescription
captionPathstring[]
dimensionDimensionName
hierarchyHierarchyName
pathstring[]

Dimension

PropertyTypeDescription
captionstring
defaultHierarchyHierarchyName
descriptionstring
hierarchiesHierarchy[]
nameDimensionName
typestring
visibleboolean

DimensionName

The readable name of a dimension in a cube.

string

For example:

const dimensionName = 'Geography';

DimensionNode

A data model tree node representing a dimension

PropertyTypeDescription
childrenHierarchyNode[]
dimensionDimension
type"dimension"

DraggedWidget

The drag item corresponding to a widget being dragged into or within a dashboard.

PropertyTypeDescription
getState() => Promise<WidgetState>
isDraggedFromDashboardboolean
stateWidgetState
type"WIDGET"

Drawer

Drawer accessible by clicking its icon in the vertical bar to the left of the ActiveUI application. Useful to allow users to edit the dashboard or interact with it.

PropertyTypeDescription
componentComponentType<EditorProps>
iconComponentType<AntdIconProps>
keystring
shortcutstring
translations{
   [locale: string]: {
     [key: string]: string;
  };
}
type"double" | "single"

DrillthroughColumn

The drillthrough column as described by the server

PropertyTypeDescription
captionstring
nameDrillthroughColumnUniqueName
type"String" | "double" | "int" | "long" | "LocalDate" | "LocalDateTime" | "Object"
visibleboolean

DrillthroughDataSet

PropertyTypeDescription
headersDrillthroughDataSetHeaderCell[]
rowsDrillthroughDataSetRow[]

DrillthroughDataSetCell

  • string
  • number
  • Record<string, unknown>

DrillthroughDataSetHeaderCell

Drillthrough's result column header description as returned by the server

PropertyTypeDescription
captionstring
namestring
type"String" | "double" | "int" | "long" | "LocalDate" | "Object"

DrillthroughDataSetRow

DrillthroughDataSetCell[]

DrillthroughResult

Drillthrough query result as returned by the server

PropertyTypeDescription
epochnumber
resultDrillthroughDataSet

DrillthroughSelection

A selection of cells and/or headers in a DrillthroughResult.

PropertyTypeDescription
columns{
   header: DrillthroughDataSetHeaderCell;
   cells: DrillthroughDataSetCell[];
}[]
headersDrillthroughDataSetHeaderCell[]

DrillthroughTableCellProps

The props of cells in a drillthrough table

CellProps & CurriedDrillthroughTableCellProps

DrillthroughTableWidgetState

  • WidgetWithQueryState<MdxDrillthrough> & {
       columnWidths?: {
         [drillthroughColumnUniqueName: string]: number;
      }; sort?: { orderMode: "ASC"
  • "DESC"; drillthroughColumnUniqueName: string; }; }

EditorProps

Props received by content and style editors.

ActionProps<WidgetState>

ElementType

Used for switching when visiting

  • "Drillthrough"
  • "Select"
  • "SubSelect"
  • "Axis"
  • "CaseExpression"
  • "CompoundIdentifier"
  • "Formula"
  • "Function"
  • "From"
  • "Identifier"
  • "Literal"
  • "MemberPropertyDefinition"
  • "When"

ExtensionModule

The entrypoint module of an ActiveUI extension.

{
   activate: ActivateExtension;
}

FieldUniqueName

Filter

FilterOnCaptionContaining

A filter on the members of a level of a hierarchy with a caption starting, ending, containing (or not) the given string.

PropertyTypeDescription
containingModeContainingMode
levelNameLevelName
tokenstring
type"captionsContaining"
For example:

Filter on employees with a last name alphabetically containing "son".

FilterOnCaptionsRange

A filter on the members of a level of a hierarchy with a caption alphabetically between the given limits.

PropertyTypeDescription
isBetweenboolean
levelNameLevelName
lowerTokenstring
type"captionsRange"
upperTokenstring
For example:

Filter on employees with a last name alphabetically between "L" and "O".

FilterOnExistenceOfValue

A filter on the members of a level of a hierarchy with an existing value for the given measure.

PropertyTypeDescription
doesExistboolean
levelNameLevelName
measureNameMeasureName
type"existenceOfValue"
For example:

Filter on countries with a known GDP.

FilterOnLowerOrGreaterCaptions

A filter on the members of a level of a hierarchy with a caption alphabetically before or after a given limit.

PropertyTypeDescription
levelNameLevelName
lowerOrGreaterModeLowerOrGreaterMode
tokenstring
type"lowerOrGreaterCaptions"
For example:

Filter on employees with a last name alphabetically after "H".

FilterOnLowerOrGreaterValues

A filter on the members of a level of a hierarchy with a value of a given measure lower or greater than a defined limit.

PropertyTypeDescription
levelNameLevelName
lowerOrGreaterLimitnumber
lowerOrGreaterModeLowerOrGreaterMode
measureNameMeasureName
type"lowerOrGreaterValue"
For example:

Filter on countries with a GDP above 500B$.

FilterOnMembers

A filter on explicitly defined members of a hierarchy.

PropertyTypeDescription
membersstring[][]
type"members"
For example:

Filter on Currency = Dollar

FilterOnTopBottomMembers

A filter on the n members of a level of a hierarchy with the lowest or highest value for a measure.

PropertyTypeDescription
levelIndexnumber
limitnumber
measureNameMeasureName
scopeFilterScope
topBottomModeTopBottomMode
type"topBottomMembers"
For example:

Filter on the 3 best selling products of each category

FilterOnValuesRange

A filter on the members of a level of a hierarchy with a value of a given measure between or outside the given limits.

PropertyTypeDescription
isBetweenboolean
levelNameLevelName
lowerLimitnumber
measureNameMeasureName
type"valuesRange"
upperLimitnumber
For example:

Filter on countries with a GDP between 200 and 500B$.

FormulaType

  • "SET"
  • "MEMBER"

Hierarchy

PropertyTypeDescription
captionstring
descriptionstring
levelsLevel[]
nameHierarchyName
slicingboolean
visibleboolean

HierarchyCoordinates

The dimension and hierarchy names identifying a hierarchy in a cube.

PropertyTypeDescription
dimensionNameDimensionName
hierarchyNameHierarchyName
For example:

const hierarchyCoordinates = { dimensionName: 'Geography', hierarchyName: 'City' };

HierarchyName

The readable name of a hierarchy in a cube.

string

For example:

const hierarchyName = 'City';

HierarchyNode

A data model tree node representing a hierarchy

PropertyTypeDescription
dimensionDimension
hierarchyHierarchy
type"hierarchy"

HierarchyUniqueName

A string representing the unique identifier of a hierarchy in a cube.

string

For example:

const hierarchyUniqueName = '[Geography].[City]';

Kpi

PropertyTypeDescription
captionstring
descriptionstring
expirystring
folderstring
goalstring
namestring
startstring
statusstring
statusPresenterstring
trendstring
valuestring

KpiFolderNode

A data model tree node representing a folder of kpis

PropertyTypeDescription
childrenKpiNode[]
type"kpiFolder"

KpiNode

A data model tree node representing a kpi

PropertyTypeDescription
childrenKpiPropertyNode[]
type"kpi"

KpiPropertyIdentifier

string

For example:

KPIStatus("my KPI"): pnl.SUM

KpiPropertyName

  • "KPIValue"
  • "KPIGoal"
  • "KPIStatus"
  • "KPITrend"
  • "KPIStart"
  • "KPIExpiry"

KpiPropertyNode

A data model tree node representing a kpi property, such as its status

PropertyTypeDescription
type"kpiProperty"

KpisRootNode

A data model tree node representing a kpisRoot

PropertyTypeDescription
children(KpiFolderNode | KpiNode)[]
type"kpisRoot"

Layout

ActiveUI 5 dashboard page layout Tree of widgets, not necessarily binary. Allows a more intuitive widget resizing behavior than the ActiveUI 4 binary layout.

PropertyTypeDescription
children(Layout | LayoutLeaf)[]
direction"column" | "row"
sizenumber

LayoutLeaf

PropertyTypeDescription
leafKeystring
sizenumber

Level

PropertyTypeDescription
captionstring
descriptionstring
nameLevelName
typestring

LevelCoordinates

The dimension, hierarchy and level names identifying a hierarchy in a cube.

HierarchyCoordinates & {
   levelName: LevelName;
}

For example:

const hierarchyCoordinates = { dimensionName: 'Geography', hierarchyName: 'City', levelName: 'City' };

LevelName

The readable name of a level in a cube.

string

For example:

const levelName = 'City';

LevelNode

A data model tree node representing a level

PropertyTypeDescription
depthnumber
dimensionDimension
hierarchyHierarchy
levelLevel
type"level"

LevelUniqueName

A string representing the unique identifier of a level in a cube.

string

For example:

const levelUniqueName = '[Geography].[City].[City]';

LoadingTableCellProps

The props of cells in a cellset table, in cases such as undefined cube or undefined data.

CellProps & CurriedCellSetTableCellProps

Locale

The locale of the user

string

Mdx

The Abstract syntax tree of an MdxString.

MdxAxis

An Mdx representing an axis such as ROWS or COLUMNS and its associated expression.

PropertyTypeDescription
elementType"Axis"
expressionMdxExpression
nameAxisName
nonEmptyboolean
propertiesMdx[]

MdxCaseExpression

An Mdx representing a CASE statement.

PropertyTypeDescription
casesMdxWhenClause[]
elementType"CaseExpression"
elseExpMdxExpression
matchMdxExpression | null
namestring

MdxCompoundIdentifier

The subset of Mdxs that identify something using hierarchical dot notation, as in the MDX [Measures].[MyMeasure]. Each segment is an MdxIdentifier.

MdxDimensionCompoundIdentifier

A MdxCompoundIdentifier that represents a dimension.

PropertyTypeDescription
dimensionNameDimensionName
type"dimension"

MdxDrillthrough

An Mdx representing a DRILLTHROUGH statement.

PropertyTypeDescription
columnsMdxExpression[]
elementType"Drillthrough"
firstRownumber
maxRowsnumber
selectMdxSelect

MdxErrorDetails

PropertyTypeDescription
expectedstring[]
from{
   line: number;
   ch: number;
}
textstring
to{
   line: number;
   ch: number;
}

MdxExpression

The subset of Mdxs that can be used in expression contexts such as the expression of a calculated measure.

MdxFormula

An Mdx representing an formula definition in the WITH clause of a MdxSelect. An example formula: WITH Member [Measures].[MyConstant] AS 42.

PropertyTypeDescription
elementType"Formula"
expressionMdxExpression
inlinedboolean | undefined
nameMdxNamedSetCompoundIdentifier | MdxMeasureCompoundIdentifier | MdxMemberCompoundIdentifier | MdxUnknownCompoundIdentifier
propertiesMdxMemberPropertyDefinition[]
typestring

MdxFromClause

An Mdx representing a named cube for the FROM clause of a MdxSelect. Does not represent a subselect expression in a FROM clause – that is represented by a MdxSubSelect instead.

PropertyTypeDescription
cubeNameCubeName
elementType"From"

MdxFunction

An Mdx representing a function call. Some functions are called with syntax that makes them look like an operator or part of the language; see Syntax for the different syntaxes for calling functions.

PropertyTypeDescription
argumentsMdxExpression[]
elementType"Function"
namestring
syntaxSyntax

MdxHierarchyCompoundIdentifier

A MdxCompoundIdentifier that represents a hierarchy.

PropertyTypeDescription
dimensionNameDimensionName
hierarchyNameHierarchyName
type"hierarchy"

MdxIdentifier

An Mdx representing an identifier – the name of a hierarchy, level, measure, KPI, etc. For example, this could represent the MDX Geography or [Geography]. A MdxCompoundIdentifier is made of these separated by dots.

PropertyTypeDescription
elementType"Identifier"
quotingQuoting
valuestring

MdxLevelCompoundIdentifier

A MdxCompoundIdentifier that represents a level.

PropertyTypeDescription
dimensionNameDimensionName
hierarchyNameHierarchyName
levelNameLevelName
type"level"

MdxLiteral

An Mdx representing a literal value such as a number or string.

PropertyTypeDescription
elementType"Literal"
typeArgument
valuestring

MdxMeasureCompoundIdentifier

PropertyTypeDescription
measureNameMeasureName
type"measure"

MdxMemberCompoundIdentifier

A MdxCompoundIdentifier that represents a member.

PropertyTypeDescription
dimensionNameDimensionName
hierarchyNameHierarchyName
levelNameLevelName
pathstring[]
type"member"

MdxMemberPropertyDefinition

An Mdx representing the definition of a property of a member that is defined in a MdxFormula. Some example property names are FORE_COLOR and FONT_FLAGS.

PropertyTypeDescription
elementType"MemberPropertyDefinition"
expressionMdxExpression
namestring

MdxNamedSet

PropertyTypeDescription
captionstring
cubeCubeName
descriptionstring
expressionMdxString
nameAxisName
serverUrlstring
type"namedSet"

MdxNamedSetCompoundIdentifier

A MdxCompoundIdentifier that represents a named set.

PropertyTypeDescription
setNameSetName
type"namedSet"

MdxOrderFunction

An MdxFunction that represents a call to the [Order function](https://docs.microsoft.com/en-us/sql/mdx/order-mdx).

MdxSelect

An Mdx representing a SELECT statement.

PropertyTypeDescription
axesMdxAxis[]
cellPropsstring[]
elementType"Select"
fromMdxSubSelect | MdxFromClause
slicerAxisMdxSlicerAxis | null
withClauseMdxFormula[]

MdxSlicerAxis

MdxAxis & {
   name: "SLICER";
}

MdxString

A string representing an [MDX](https://en.wikipedia.org/wiki/MultiDimensional\_eXpressions) query or a part of one.

string

For example:
const mdx = 'SELECT\n [Measures].[contributors.COUNT] ON COLUMNS\n FROM [EquityDerivativesCube]';
For example:
const mdx = '[Measures].[contributors.COUNT]';
For example:
const mdx = '"a string in MDX"';
For example:
const mdx = '123';

MdxSubSelect

An Mdx representing a subselect expression.

PropertyTypeDescription
axesMdxAxis[]
elementType"SubSelect"
fromMdxSubSelect | MdxFromClause
nonVisualboolean
slicerAxisMdxSlicerAxis | null

MdxUnknownCompoundIdentifier

A MdxCompoundIdentifier representing an unknown identifier.

PropertyTypeDescription
type"unknown"
Remarks:

This type is used for any mdx compound identifier whose type cannot be identified. It is the case for all compound identifiers in the raw result of parsing an MDX string. It can then be further refined by confronting it to the dataModel and calling getSpecificCompoundIdentifier.

MdxWhenClause

An Mdx representing a WHEN clause of a MdxCaseExpression, including the clause’s THEN true result expression.

PropertyTypeDescription
elementType"When"
thenMdxExpression
whenMdxExpression

Measure

PropertyTypeDescription
captionstring
folderstring
formatStringstring
nameMeasureName
typestring
visibleboolean

MeasureGroup

PropertyTypeDescription
captionstring
descriptionstring
namestring

MeasureName

The readable name of a measure in a cube.

string

For example:

const measureName = 'pnl.SUM';

MeasureNode

A data model tree node representing a measure

PropertyTypeDescription
measureMeasure
type"measure"

MeasuresFolderNode

A data model tree node representing a measuresFolder

PropertyTypeDescription
childrenMeasureNode[]
type"measuresFolder"

MeasuresRootNode

A data model tree node representing a measuresRoot

PropertyTypeDescription
type"measuresRoot"

MeasureUniqueName

A string representing the unique identifier of a measure in a cube.

string

For example:

const measureUniqueName = '[Measures].[pnl.SUM]';

Member

PropertyTypeDescription
captionPathstring[]
namePathstring[]
properties{
   [key in CellProperty]?: null | string | number | undefined;
}

MemberCoordinates

Coordinates identifying a Member.

HierarchyCoordinates & {
   namePath: string[];
}

MenuItemDeleteFileProps

AntMenuItemProps & ContentTreeMenuItemProps

MenuItemMoveFileOrFolderProps

AntMenuItemProps & ContentTreeMenuItemProps

MenuItemPlugin

Plugin useful for items in the context menus of widgets or in the top right widget menu.

PropertyTypeDescription
ComponentComponentType<MenuItemProps<WidgetState, SelectionType>>

MenuItemProps

ActionProps<WidgetState, SelectionType> & AntMenuItemProps

MenuItemRenameFolderProps

AntMenuItemProps & ContentTreeMenuItemProps

OrderMode

  • "ASC"
  • "DESC"
  • "BASC"
  • "BDESC"

OrderModeMdxLiteral

A MdxLiteral that represents one of the OrderMode strings.

MdxLiteral & {
   type: "STRING";
   value: OrderMode;
}

Permission

The permissions of a ContentEntry of a file or folder.

PlotlyWidgetState

PropertyTypeDescription
colorsChartColors
isTextVisibleboolean
opacitynumber
plotlyPlotlyOverrides
subplotLimitsSubplotLimits

Plugin

Any type of ActiveUI plugin.

PluginRegistry

All ActiveUI plugins registered by the application using the SDK.

PropertyTypeDescription
"cell-style"PluginsOfType<CellStylePlugin>
"menu-item"PluginsOfType<MenuItemPlugin<any, any>>
"selection-listener"PluginsOfType<SelectionListenerPlugin>
"titlebar-button"PluginsOfType<TitleBarButtonPlugin<any, any>>
cellPluginsOfType<CellPlugin>
widgetPluginsOfType<WidgetPlugin<any, any>>

PluginsOfType

The plugins of a certain type (e.g. all registered widget plugins)

PluginType

A type of Plugin.

  • "cell"
  • "cell-style"
  • "selection-listener"
  • "menu-item"
  • "theme"
  • "titlebar-button"
  • "widget"

Query

PropertyTypeDescription
context{
   [key: string]: string | number | boolean;
}
Context values usable as input for server-side calculations. E.g. the confidence level for value at risk calculation.
mdxTQuery to execute.
ranges{
   [axisId in AxisId]?: QueryRange;
}
Ranges of positions that should be returned by the server. E.g. "only return the first 100 rows and the first 20 columns".
updateModeUpdateModeWhether the query is only run once, or kept open in order to receive real-time updates.

QueryContextEntry

A piece of a query's context. Allows to parametrize the behavior of ActivePivot when it answers the query.

PropertyTypeDescription
keystring
valuestring | number | boolean
Remarks:

Technical query context entries should not be accessible to end users. Functional query context entries can usually be replaced by analysis hierarchies, which offer a better experience to end users. Query context entries are still used by legacy projects, particularly in finance.

For example:

timeout, target currency, VaR sensitivy.

QueryError

PropertyTypeDescription
errorChain{
   type: string;
   message: string;
}[]
stackTracestring

QueryRange

The range of results to fetch, in the case of infinite scrolling.

PropertyTypeDescription
fromnumber
tonumber

QueryResult

PropertyTypeDescription
dataResultTypeThe data for this result, either a CellSet or a DrillthroughResult
errorQueryError
isLoadingboolean

Quoting

  • "QUOTED" /** * Unquoted identifier, for example `Geography`. */
  • "UNQUOTED" /** * Identifier quoted with an ampersand to indicate a key value, for example the second segment in `[Geography].&[France]`. */
  • "AMP_QUOTED"

RangeConfiguration

PropertyTypeDescription
chunkSizenumber
thresholdPercentagenumber

RangesConfiguration

{
   [a in TableAxisId]: RangeConfiguration;
}

SelectionListenerPlugin

Plugin useful to define a function to be executed when the user makes (or clears) the selection on a widget. For example: function to execute when the user selects cells on a pivot table.

PropertyTypeDescription
SelectionListenerComponentType<WidgetPluginProps<WidgetState, SelectionType> & {
   children: JSX.Element;
   selection?: SelectionType;
}>

ServerNode

A data model tree node representing a server

PropertyTypeDescription
type"server"

ServiceVersion

PropertyTypeDescription
idstring
restPathstring
wsPathstring

Set

PropertyTypeDescription
captionstring
descriptionstring
expressionstring
nameSetName

SetName

string

SetNode

A data model tree node representing a set

PropertyTypeDescription
setSet
type"set"

SetsRootNode

A data model tree node representing a setsRoot

PropertyTypeDescription
type"setsRoot"

Settings

Flat map containing the preferences of the user regarding the behavior of various parts of ActiveUI.

PropertyTypeDescription
"dataModel.isSimplified"booleanWhen true, redudant/inactionable nodes of the data model tree are hidden: dimensions and the level of "single level hierarchies". When false, the data model tree displays the data model as it is.
"mdx.doesIncludeCalculatedMembers"booleanWhen true, calculated members are included in the results of MDX queries.
"search.maxResults"numberThe maximum number of search results.
"userFilters.areEnabled"booleanWhether user filters are visible in the filters editor and taken into account by widgets. When enabled, user filters allow to quickly create filters that apply to all dashboards, until removed.
theme"light-activeviam" | "dark-activeviam"Controls the style of all ActiveUI components. Must be the key of a provided theme.

Side

  • "center"
  • "top"
  • "right"
  • "bottom"
  • "left"

Syntax

  • "Property" /** * Function style, e.g. `FUNCTION()` or `FUNCTION(args)`. */
  • "Function" /** * Method style, e.g. `object.METHOD()` or `object.METHOD(args)`. */
  • "Method" /** * Infix style, e.g. `arg OPERATOR arg` (typically for operators such as '+' or 'AND'). */
  • "Infix" /** * Prefix style, e.g. `OPERATOR arg` (typically for unary operators such as '-'). */
  • "Prefix" /** * Parentheses style, e.g. `(ARG,...)` (used for tuple expressions) */
  • "Parentheses" /** * Braces style, e.g. `{
      ARG, ...
    }` (used for set expressions) */
  • "Braces"

TableWidgetPlugin

The more specific WidgetPlugin interface, suited for table widgets.

PropertyTypeDescription
cellstringThe key of the cell plugin to use.
cellStylestringThe key of the cell style plugin to use.

TableWidgetState

PropertyTypeDescription
columnWidths{
   [tupleId: string]: number;
}

TextEditorWidgetState

State of a pluginWidgetTextEditor widget.

PropertyTypeDescription
displayMode"view" | "edit"
textstring

Theme

Contains all style attributes used by ActiveUI components.

PropertyTypeDescription
activeTabBackgroundColorColor
alternateCellBackgroundColorColor
backgroundColorColor
blackColor
cellBackgroundDuringNegativeTransitionColor
cellBackgroundDuringPositiveTransitionColor
cellBorderColorColor
disabledBackgroundColor
disabledTextColorColor
dropHintBorderColorColor
dropHintColorColor
errorColorColor
grayScaleColor[]
headerActiveColorColor
hoverColorColor
inactiveTabBackgroundColorColor
isDarkboolean
placeholderColorColor
primaryColorColor
selectedMenuItemBackgroundColor
selectionColorColor
shadowColorColor
successColorColor
textColorColor
warningColorColor
whiteColor

TitleBarButtonPlugin

Plugin useful to define buttons accessible next to the top right menu of widgets.

PropertyTypeDescription
ComponentComponentType<ActionProps<WidgetState, SelectionType>>

TranslationParameters

TreeObject

T & {
   children?: TreeObject<T>[];
}

Tuple

(HierarchyCoordinates & Member)[]

TupleCoordinates

Coordinates identifying a Tuple.

MemberCoordinates[]

UpdateMode

Update mode for MDX query.

  • "once"
  • "realTime"

User

Describes the current user.

PropertyTypeDescription
usernamestring
userRolesstring[]

UserGroupName

The name of a group of users.

string

UserName

The name of a user.

string

Versions

PropertyTypeDescription
apis{
   [apiKey: string]: {
     versions: [ServiceVersion];
  };
}
serverVersionstring
versionnumber

WidgetAttribute

PropertyTypeDescription
isMainAxisboolean
maxNumberOfFieldsnumber
roleAttributeRole

WidgetContent

The content of the file to fetch in order to render a dashboard. Like SerializedDashboardState, but name and value.widgetKey are omitted.

WidgetMetaData

The content of the file to fetch in order to render the node representing a widget in the widgets tree.

PropertyTypeDescription
widgetKeystring

WidgetPlugin

Plugin defining a component that can be used in a dashboard.

PropertyTypeDescription
attributesWidgetAttributes
categoryWidgetCategory
ComponentComponentType<WidgetPluginProps<WidgetState, SelectionType>>
contentEditorComponentType<EditorProps<WidgetState>>
contextMenuItemsstring[]
doesSupportMeasuresRedirectionboolean
filtersEditorComponentType<EditorProps>
IconComponentType<IconProps>
initialStateWidgetState
menuItemsstring[]
queryEditorComponentType<EditorProps<WidgetState>>
selectionListenerstringThe key of a SelectionListenerPlugin to be executed whenever this widget's selection changes.
styleEditorComponentType<EditorProps<WidgetState>>
subCategorystring
titleBarButtonsstring[]

WidgetPluginProps

Props received by a widget plugin component.

  • WidgetPluginOutsideADashboardProps<WidgetState, SelectionType>
  • WidgetPluginInDashboardProps<WidgetState, SelectionType>

WidgetWithQueryProps

Props received by a widget with a query

WidgetPluginProps<WidgetState, SelectionType> & {
   queryResult: QueryResult<ResultType>;
}

WidgetWithQueryState

The state of widgets using a query.

PropertyTypeDescription
queryPartial<Query<T extends "serialized" ? MdxString : MdxType>>
serverKeystring