Types

AccessLog

Property	Type	Description
id	string
lastOpened	number

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.

Property	Type	Description
connectionStatus	ConnectionStatus	The current connection status of the client.
dataModel	DataModel | undefined	Returns the DataModel if it is already loaded. See loadDataModel.

Method	Description
addConnectionStatusListener	Registers listener to be called whenever the client status changes.
addDataModelListener	Registers listener to be called whenever the data model changes.
addQueryListener	Registers listener to be called whenever the Query identified by queryId is updated. listener is also called synchronously once, in case this query already exists.
addQueryResultListener	Registers 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.
connect	Asynchronously connects the client to the ActivePivot server's query streaming service. Resolves immediately if the client is already connected.
disconnect	Disconnects the client from the ActivePivot server's query streaming service.
fetchAvailableDrillthroughColumns	Asynchronously returns the list of available DrillthroughColumn for query.
getQuery	Returns the Query identified by queryId if it exists.
getQueryResult	Returns the latest QueryResult for the Query identified by queryId.
loadDataModel	Asynchronously loads the DataModel, making it available through ActivePivotClient. Can be called several times to load an up-to-date version.
refreshQuery	Re-executes a paused query once.
removeConnectionStatusListener	Removes listener and stops calling it whenever the client status changes.
removeDataModelListener	Removes listener and stops calling it whenever the data model changes.
removeQueryListener	Removes listener and stops calling it when the Query identified by queryId is updated.
removeQueryResultListener	Removes 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.
setQuery	Updates 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.

Property	Type	Description
recentlyOpenedDashboards	AccessLog[]	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.

ActivityListener

(value: Activity[K]) => void

ADataModelNode

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

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
cubeName	string
serverKey	string

AFilter

A filter is always contextual to a hierarchy

HierarchyCoordinates

AllMeasuresInMapping

A tile in the widget mapping, representing all measures.

Property	Type	Description
type	"allMeasures"

AMdxCompoundIdentifier

The common attributes shared by all types of MdxCompoundIdentifier.

Property	Type	Description
elementType	"CompoundIdentifier"
identifiers	MdxIdentifier[]

AMetaData

Property	Type	Description
isFolder	boolean
name	string

ANode

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean

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.

Property	Type	Description
key	string
translations	{    [locale: string]: TranslationTree<string>; }

Argument

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

AttributeRole

• "primaryNumeric"
• "primaryOrdinal"
• "secondaryNumeric"
• "secondaryOrdinal"
• "subplot"

AWidgetState

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

Property	Type	Description
filters	(T extends "serialized" ? MdxString : Mdx)[]
isFullScreen	boolean
name	string
queryContext	QueryContextEntry[]
widgetKey	string

Axis

Property	Type	Description
hierarchies	{    dimension: DimensionName;    hierarchy: HierarchyName; }[]
id	AxisId
maxLevelPerHierarchy	number[]
positions	Member[][]
range	AxisRange

AxisId

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

AxisName

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

AxisRange

Property	Type	Description
axisLength	number
entireAxis	boolean
from	number
to	number

BasicDashboardProps

Property	Type	Description
activePageKey	string
className	string
initialPageState	Omit<DashboardPageState, "name">
isExportingToPDF	boolean
LeafComponent	ComponentType<LeafProps>
onActivePageChange	(newActivePageKey: string) => void
onAfterPrint	() => void
onChange	(newState: DashboardState) => void
onWidgetSelected	(newSelectedLeafKey: string) => void
selectedLeafKey	string
state	DashboardState
style	CSSProperties
tabBarExtraContent	ReactNode

CalculatedMeasureMetaData

The content of a calculated measure meta data file on the Content Server, representing a calculated measure in the calculated measure tree.

{
   name: string;
   isFolder?: boolean;
}

Catalog

Property	Type	Description
cubes	Cube[]
name	string

CatalogNode

A data model tree node representing a catalog

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
type	"catalog"

Cell

Property	Type	Description
formattedValue	string
ordinal	number
properties	{    [key in CellProperty]?: null | string | number | undefined; }
value	number | string

CellIndices

Indices allowing to retrieve a cell in a cellSet.

{
   rowIndex: number;
   columnIndex: number;
   cellIndex: number;
}

CellPlugin

Plugin useful for cell Components usable on table widgets.

Property	Type	Description
key	string
translations	{    [locale: string]: TranslationTree<string>; }
Cell	ForwardRefExoticComponent<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"

CellProps

Property	Type	Description
caption	string
className	string
columnIndex	number
height	number
isColumnFrozen	boolean
isRowFrozen	boolean
left	number
parentTotalRowIndex	number
rowIndex	number
style	CSSProperties
top	number
value	string | number
width	number

CellSet

Property	Type	Description
axes	Axis[]
cells	Cell[]
cube	CubeName
defaultMembers	DefaultMember[]
epoch	number

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.

• LoadingTableCellProps
• CellSetTableBodyCellProps
• CellSetTableHeaderCellProps
• CellSetTableStaticHeaderCellProps

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.

Property	Type	Description
key	string
translations	{    [locale: string]: TranslationTree<string>; }
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>

ChartColors

• { [traceName: string]: Color
• undefined; }

Clients

Property	Type	Description
activePivot	{    [serverKey: string]: ActivePivotClient; }
content	ContentClient

Color

A string representing a color.

string

CompositeHierarchyInMapping

A tile in the widget mapping, representing 2 hierarchies glued together. This can be created through an "expand by" action on a pivot table.

Property	Type	Description
hierarchies	(LevelCoordinates & {    expandedDownTo?: LevelName; })[]
type	"compositeHierarchy"

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.

Property	Type	Description
drawers	Drawer[]
higherOrderComponents	((wrappedComponent: ComponentType) => ComponentType)[]	Higher-order components (HOCs) wrapping the application. In particular, it allows to provide React contexts.See https://reactjs.org/docs/higher-order-components.html
initialDashboardPageState	Omit<DashboardPageState, "name">
pluginRegistry	PluginRegistry

ConnectionStatus

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

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

ContainingMode

• "startsWith"
• "doesNotStartWith"
• "endsWith"
• "doesNotEndWith"
• "contains"
• "doesNotContain"

ContentClient

Provides methods to interact with the Content Server.

Method	Description
addActivityListener	Registers listener to be called whenever the value of the activity identified by activityKey is updated.
addSettingListener	Registers listener to be called whenever the value of the setting identified by settingKey is updated.
addTreeListener	Registers listener to be called whenever the dashboards, filters, or widgets tree is reloaded.
createFile	Asynchronously creates a dashboard or a widget file on the Content Server. Returns its id.
createFolder	Asynchronously creates a dashboard or a widget folder on the Content Server. Returns its id.
deleteFile	Asynchronously deletes a dashboard or a widget file on the Content Server.
deleteFolder	Asynchronously deletes a dashboard or a widget folder on the Content Server.
fetchFile	Asynchronously 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.
fetchThumbnail	Asynchronously returns the thumbnail at path if it exists.
fetchThumbnails	Asynchronously 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.
getActivity	Returns the value of the activity identified by activityKey if it exists.
getSetting	Returns the value of the setting identified by settingKey if it exists.
getTree	Returns the dashboards, filters, or widgets tree, if it is already loaded.
loadActivity	Asynchronously loads the Activity of the current user and makes it available via getActivity.
loadSettings	Asynchronously loads the settings, making them available via getSetting.
loadTree	Asynchronously loads the tree of all accessible dashboards, widgets, filters or calculated measures.
moveFile	Asynchronously moves a dashboard or a widget into a folder on the Content Server.
removeActivityListener	Removes listener and stops calling it when the value of the activity identified by activityKey is updated.
removeSettingListener	Removes listener and stops calling it when the value of the setting identified by settingKey is updated.
removeTreeListener	Removes listener and stops calling it whenever the dashboards or widgets tree is reloaded.
updateActivity	Saves the new version of the user's Activity on the Content Server.
updateFile	Asynchronously updates an existing dashboard or widget file on the Content Server.
updateFilePermissions	Asynchronously updates an existing dashboard or widget file's permissions on the Content Server.
updateFolder	Asynchronously updates an existing dashboard or widget folder on the Content Server.
updateFolderPermissions	Asynchronously updates an existing folder's permissions on the Content Server.
updateSetting	Asynchronously updates the value of the setting identified by key for the given user.

ContentEntry

Property	Type	Description
canRead	boolean
canWrite	boolean
content	Content
isDirectory	boolean
lastEditor	string
name	string
owners	string[]
readers	string[]
timestamp	number

ContentNode

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
entry	ContentEntry<AMetaData>
id	string
metaData	MetaData
type	ContentNodeType

ContentNodeType

• "file"
• "folder"
• "server"

ContentRecord

Property	Type	Description
children	{    [childName: string]: ContentRecord<Content>; }
entry	ContentEntry<Content>

ContentTreeMenuItemProps

Property	Type	Description
contentTree	ContentRecord
contentType	ContentType
doesRepresentServer	boolean
id	string
onAfterSubmit	() => void
onEditStarted	() => void
pathToParentFolder	string[]

ContentType

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

ContextValueDefinition

Property	Type	Description
category	string
description	string
name	string
type	string

Cube

Property	Type	Description
caption	string
contextValues	DefaultContextValue[]
defaultMembers	DefaultMember[]
dimensions	Dimension[]
kpis	Kpi[]
measureGroups	MeasureGroup[]
measures	Measure[]
name	CubeName
sets	Set[]

CubeName

string

CubeNode

A data model tree node representing a cube

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
name	string
serverKey	string
type	"cube"

CubeSelectorProps

Property	Type	Description
cube	Cube | null
mdx	MdxSelect	If provided, mdx controls which cube options are disabled.
onCubeSelected	(serverKey: string, cubeName: CubeName) => void
serverKey	string

CurriedCellSetTableCellProps

The props of CellSet table cells, which are curried by the CellSetTable Component.

Property	Type	Description
cells	({    caption: string;    value: number | string;    properties?: {      [key in CellProperty]?: null | string | number | undefined;   }; } | null)[][]	The cells forwarded to the underlying Table component. The dimensions of the array include the frozen rows and columns. Only the cells of the body are filled, as the rendering of the header cells depend on more information, present in the metaData.
columnHeaderIndices	{    hierarchyIndex: number;    levelIndex: number; }[]
columnsAxis	Axis | undefined
cube	Cube
data	CellSet
defaultMeasure	DefaultMember
hierarchyIndicesInCellSet	HierarchyIndicesInCellSet
indexOfMeasureOnSlicer	number
mapping	DataVisualizationWidgetMapping
numberOfColumnsInBody	number
numberOfFrozenColumns	number
numberOfFrozenRows	number
numberOfRowsInBody	number
rowHeaderIndices	{    hierarchyIndex: number;    levelIndex: number; }[]
rowsAxis	Axis
slicerAxis	Axis
sort	{    orderMode: OrderMode | undefined;    tupleCoordinates?: TupleCoordinates;    levelCoordinates?: LevelCoordinates; }
staticHeaderCoordinatesOnColumns	TableStaticHeaderCoordinates[]
staticHeaderCoordinatesOnRows	TableStaticHeaderCoordinates[]
staticHeadersOnColumns	TableStaticHeader[]
staticHeadersOnRows	TableStaticHeader[]
isExpandable	(tuple: TupleCoordinates) => boolean
isExpanded	(tuple: TupleCoordinates) => boolean
onExpansionChanged	(tuple: Tuple, toLevel: LevelCoordinates, isExpanding: boolean) => void
onSortChanged	() => void

CurriedDrillthroughTableCellProps

The props of cells in drillthrough table that are curried by the DrillthroughTable Component.

Property	Type	Description
headerCaptions	DrillthroughDataSetHeaderCell[]
headerValues	DrillthroughDataSetHeaderCell[]
onSortChanged	() => void
sort	{    orderMode: "ASC" | "DESC";    drillthroughColumnUniqueName: string; }

CustomFilter

Property	Type	Description
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.

Property	Type	Description
catalogs	Catalog[]
contextValues	ContextValueDefinition[]

DataModelNode

A data model tree node

• CatalogNode
• CubeNode
• DimensionNode
• HierarchyNode
• KpiPropertyNode
• KpiNode
• KpiFolderNode
• KpisRootNode
• LevelNode
• MeasuresFolderNode
• MeasuresRootNode
• MeasureNode
• ServerNode
• SetNode
• SetsRootNode

DataOverrides

Plotly overrides relative to the traces.

Property	Type	Description
additionalTraces	Trace[]
commonTraceOverride	Partial<Trace>
overridesByTraceIndex	Partial<Trace>[]
overridesByTraceKey	{    [traceKey: string]: Partial<Trace>; }

DataVisualizationMappingField

A field in a data visualization widget's mapping.

• AllMeasuresInMapping
• MeasureInMapping
• KpiPropertyInMapping
• HierarchyInMapping
• CompositeHierarchyInMapping

DataVisualizationWidgetMapping

The attributes to fields mapping, specific to a given type of data visualization widget. Contains deserialized fields.

For example:

{

rows: [

{

type: "hierarchy",

dimensionName: "Currency",

hierarchyName: "Currency",

levelName: "Currency"

}

]

}

DataVisualizationWidgetState

Property	Type	Description
filters	(T extends "serialized" ? MdxString : Mdx)[]
isFullScreen	boolean
name	string
queryContext	QueryContextEntry[]
widgetKey	string
query	Partial<Query<T extends "serialized" ? MdxString : MdxType>>
serverKey	string
mapping	T extends "serialized" ? SerializedDataVisualizationWidgetMapping : DataVisualizationWidgetMapping
styleAttributes	string[]
switchedTo	string

DefaultContextValue

Property	Type	Description
name	string
value	string

DefaultMember

Property	Type	Description
captionPath	string[]
dimension	DimensionName
hierarchy	HierarchyName
path	string[]

DerivedCellSetTableBodyCellProps

The props specific to body cells in a cellset table.

Property	Type	Description
properties	{    [key in CellProperty]?: null | string | number | undefined; }
tuple	Tuple | null

DerivedCellSetTableHeaderCellProps

The props specific to header cells in a cellset table.

Property	Type	Description
headerDepth	number
hierarchyIndex	number
levelIndex	number
positionIndex	number
tuple	Tuple | null

DerivedCellSetTableStaticHeaderCellProps

The props specific to static header cells in a cellset table.

Property	Type	Description
staticHeaderCoordinates	TableStaticHeaderCoordinates

Dimension

Property	Type	Description
caption	string
defaultHierarchy	HierarchyName
description	string
hierarchies	Hierarchy[]
name	DimensionName
type	string
visible	boolean

DimensionDraggedFromDataModelTree

Property	Type	Description
cubeName	CubeName
dimension	Dimension
fieldType	"dimension"
serverKey	string
type	"DATA_TREE_FIELD"

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

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
cubeName	string
serverKey	string
children	HierarchyNode[]
dimension	Dimension
type	"dimension"

DraggedWidget

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

Property	Type	Description
getState	() => Promise<WidgetState>
isDraggedFromDashboard	boolean
state	WidgetState
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.

Property	Type	Description
component	ComponentType<EditorProps>
icon	ComponentType<AntdIconProps>
key	string
shortcut	string
translations	{    [locale: string]: {      [key: string]: string;   }; }
type	"double" | "single"

DrillthroughColumn

The drillthrough column as described by the server

Property	Type	Description
caption	string
name	DrillthroughColumnUniqueName
type	"String" | "double" | "int" | "long" | "LocalDate" | "LocalDateTime" | "Object"
visible	boolean

DrillthroughColumnUniqueName

A unique identifier for a drillthrough column.

string

DrillthroughDataSet

Property	Type	Description
headers	DrillthroughDataSetHeaderCell[]
rows	DrillthroughDataSetRow[]

DrillthroughDataSetCell

• string
• number
• Record<string, unknown>

DrillthroughDataSetHeaderCell

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

Property	Type	Description
caption	string
name	string
type	"String" | "double" | "int" | "long" | "LocalDate" | "Object"

DrillthroughDataSetRow

DrillthroughDataSetCell[]

DrillthroughResult

Drillthrough query result as returned by the server

Property	Type	Description
epoch	number
result	DrillthroughDataSet

DrillthroughSelection

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

Property	Type	Description
columns	{    header: DrillthroughDataSetHeaderCell;    cells: DrillthroughDataSetCell[]; }[]
headers	DrillthroughDataSetHeaderCell[]

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.

Property	Type	Description
activate	(params: Configuration) => Promise<void>

FieldDraggedFromDataModelTree

• KpiPropertyDraggedFromDataModelTree
• MeasureDraggedFromDataModelTree
• DimensionDraggedFromDataModelTree
• HierarchyDraggedFromDataModelTree
• LevelDraggedFromDataModelTree

FieldUniqueName

• "ALL_MEASURES"
• LevelUniqueName
• MeasureUniqueName
• KpiPropertyIdentifier

Filter

• FilterOnMembers
• FilterOnTopBottomMembers
• FilterOnLowerOrGreaterValues
• FilterOnValuesRange
• FilterOnLowerOrGreaterCaptions
• FilterOnCaptionsRange
• FilterOnCaptionContaining
• FilterOnExistenceOfValue
• CustomFilter

FilterMetaData

The content of a filter meta data file on the Content Server, representing a filter in the filters tree.

{
   name: string;
   isFolder?: boolean;
}

FilterOnCaptionContaining

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

Property	Type	Description
containingMode	ContainingMode
levelName	LevelName
token	string
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.

Property	Type	Description
isBetween	boolean
levelName	LevelName
lowerToken	string
type	"captionsRange"
upperToken	string

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.

Property	Type	Description
doesExist	boolean
levelName	LevelName
measureName	MeasureName
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.

Property	Type	Description
levelName	LevelName
lowerOrGreaterMode	LowerOrGreaterMode
token	string
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.

Property	Type	Description
levelName	LevelName
lowerOrGreaterLimit	number
lowerOrGreaterMode	LowerOrGreaterMode
measureName	MeasureName
type	"lowerOrGreaterValue"

For example:

Filter on countries with a GDP above 500B$.

FilterOnMembers

A filter on explicitly defined members of a hierarchy.

Property	Type	Description
members	string[][]
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.

Property	Type	Description
levelIndex	number
limit	number
measureName	MeasureName
scope	FilterScope
topBottomMode	TopBottomMode
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.

Property	Type	Description
isBetween	boolean
levelName	LevelName
lowerLimit	number
measureName	MeasureName
type	"valuesRange"
upperLimit	number

For example:

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

FilterScope

• "overall"
• "ofEachParent"

FilterType

• "members"
• "topBottomMembers"
• "lowerOrGreaterValue"
• "valuesRange"
• "lowerOrGreaterCaptions"
• "captionsRange"
• "captionsContaining"
• "existenceOfValue"
• "custom"

FormulaType

• "SET"
• "MEMBER"

GenericIndenter

Property	Type	Description
indent	(needSpace?: boolean) => string
newLine	(needSpace?: boolean) => string
unindent	() => void

GridKey

• "staticHeader"
• "columnHeader"
• "rowHeader"
• "body"

GridRange

Property	Type	Description
columns	Range
rows	Range

Hash

Property	Type	Description
expected	string[]
line	number
loc	{    first_column: number;    last_column: number;    last_line: number; }
text	string

Hierarchy

Property	Type	Description
caption	string
description	string
levels	Level[]
name	HierarchyName
slicing	boolean
visible	boolean

HierarchyCoordinates

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

Property	Type	Description
dimensionName	DimensionName
hierarchyName	HierarchyName

For example:

const hierarchyCoordinates = {

dimensionName: 'Geography',

hierarchyName: 'City'

};

HierarchyDraggedFromDataModelTree

Property	Type	Description
cubeName	CubeName
dimension	Dimension
fieldType	"hierarchy"
hierarchy	Hierarchy
serverKey	string
type	"DATA_TREE_FIELD"

HierarchyIndicesInCellSet

A map of hierarchy unique names to the index of the axis where the hierarchy can be found in cellSet.axes and its own index in axis.hierarchies.

HierarchyInMapping

A tile in the widget mapping, representing a hierarchy.

Property	Type	Description
expandedDownTo	LevelName
type	"hierarchy"

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

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
cubeName	string
serverKey	string
dimension	Dimension
hierarchy	Hierarchy
type	"hierarchy"

HierarchyUniqueName

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

string

For example:

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

HighlightedCaptionProps

Property	Type	Description
caption	string
isDisabled	boolean
searchValue	string

InternalNode

NodeType & {
   path: number[];
   parentNames: string;
}

Kpi

Property	Type	Description
caption	string
description	string
expiry	string
folder	string
goal	string
name	string
start	string
status	string
statusPresenter	string
trend	string
value	string

KpiComparison

• SubmittedKpiComparison
• HierarchyCoordinates

KpiFolderNode

A data model tree node representing a folder of kpis

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
cubeName	string
serverKey	string
children	KpiNode[]
type	"kpiFolder"

KpiNode

A data model tree node representing a kpi

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
cubeName	string
serverKey	string
children	KpiPropertyNode[]
type	"kpi"

KpiProperty

Property	Type	Description
kpiName	string
kpiPropertyName	KpiPropertyName
underlyingMeasureName	MeasureName

KpiPropertyDraggedFromDataModelTree

Property	Type	Description
kpiName	string
kpiPropertyName	KpiPropertyName
underlyingMeasureName	MeasureName
fieldType	"kpiProperty"
type	"DATA_TREE_FIELD"

KpiPropertyIdentifier

string

For example:

KPIStatus("my KPI"): pnl.SUM

KpiPropertyInMapping

A tile in the widget mapping, representing a KPI property.

Property	Type	Description
kpiName	string
propertyName	KpiPropertyName
type	"kpiProperty"
underlyingMeasureName	MeasureName

KpiPropertyName

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

KpiPropertyNode

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

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
cubeName	string
serverKey	string
kpiName	string
kpiPropertyName	KpiPropertyName
underlyingMeasureName	MeasureName
type	"kpiProperty"

KpisRootNode

A data model tree node representing a kpisRoot

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
cubeName	string
serverKey	string
children	(KpiFolderNode | KpiNode)[]
type	"kpisRoot"

KpiWidgetState

Property	Type	Description
filters	(T extends "serialized" ? MdxString : Mdx)[]
isFullScreen	boolean
name	string
queryContext	QueryContextEntry[]
widgetKey	string
query	Partial<Query<T extends "serialized" ? MdxString : MdxType>>
serverKey	string
mapping	T extends "serialized" ? SerializedDataVisualizationWidgetMapping : DataVisualizationWidgetMapping
styleAttributes	string[]
switchedTo	string
comparison	KpiComparison
titles	{    [tupleId: string]: string; }

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.

Property	Type	Description
children	(Layout | LayoutLeaf)[]
direction	"column" | "row"
size	number

LayoutLeaf

Property	Type	Description
leafKey	string
size	number

LeafProps

The props provided by the dashboard to each of its leaves.

Property	Type	Description
dashboardState	DashboardState
dragHandleRef	DragElementWrapper<DragSourceOptions>
isDeferred	boolean
layoutPath	number[]
leafKey	string
onActivePageChange	(newActivePageKey: string) => void
onDashboardChange	(newDashboardState: DashboardState) => void
onLoaded	() => void
pageKey	string	The key of the page containing the widget.
widgetState	WidgetState

Level

Property	Type	Description
caption	string
description	string
name	LevelName
type	string

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'

};

LevelDraggedFromDataModelTree

Property	Type	Description
cubeName	CubeName
dimension	Dimension
fieldType	"level"
hierarchy	Hierarchy
level	Level
serverKey	string
type	"DATA_TREE_FIELD"

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

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
cubeName	string
serverKey	string
depth	number
dimension	Dimension
hierarchy	Hierarchy
level	Level
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

LowerOrGreaterMode

• "Lower"
• "LowerOrEqual"
• "Greater"
• "GreaterOrEqual"
• "Equal"
• "NotEqual"

Mdx

The Abstract syntax tree of an MdxString.

• MdxExpression
• MdxAxis
• MdxFromClause
• MdxFormula
• MdxDrillthrough
• MdxMemberPropertyDefinition
• MdxSelect
• MdxSubSelect
• MdxWhenClause

MdxAxis

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

Property	Type	Description
elementType	"Axis"
expression	MdxExpression
name	AxisName
nonEmpty	boolean
properties	Mdx[]

MdxCaseExpression

An Mdx representing a CASE statement.

Property	Type	Description
cases	MdxWhenClause[]
elementType	"CaseExpression"
elseExp	MdxExpression
match	MdxExpression | null
name	string

MdxCompoundIdentifier

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

• MdxUnknownCompoundIdentifier
• MdxDimensionCompoundIdentifier
• MdxHierarchyCompoundIdentifier
• MdxLevelCompoundIdentifier
• MdxMemberCompoundIdentifier
• MdxMeasureCompoundIdentifier
• MdxNamedSetCompoundIdentifier

MdxDimensionCompoundIdentifier

A MdxCompoundIdentifier that represents a dimension.

Property	Type	Description
elementType	"CompoundIdentifier"
identifiers	MdxIdentifier[]
dimensionName	DimensionName
type	"dimension"

MdxDrillthrough

An Mdx representing a DRILLTHROUGH statement.

Property	Type	Description
columns	MdxExpression[]
elementType	"Drillthrough"
firstRow	number
maxRows	number
select	MdxSelect

MdxErrorDetails

Property	Type	Description
expected	string[]
from	{    line: number;    ch: number; }
text	string
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.

• MdxLiteral
• MdxIdentifier
• MdxCompoundIdentifier
• MdxCaseExpression
• MdxFunction

MdxFormula

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

Property	Type	Description
elementType	"Formula"
expression	MdxExpression
inlined	boolean | undefined
name	MdxNamedSetCompoundIdentifier | MdxMeasureCompoundIdentifier | MdxMemberCompoundIdentifier | MdxUnknownCompoundIdentifier
properties	MdxMemberPropertyDefinition[]
type	string

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.

Property	Type	Description
cubeName	CubeName
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.

Property	Type	Description
arguments	MdxExpression[]
elementType	"Function"
name	string
syntax	Syntax

MdxHierarchyCompoundIdentifier

A MdxCompoundIdentifier that represents a hierarchy.

Property	Type	Description
elementType	"CompoundIdentifier"
identifiers	MdxIdentifier[]
dimensionName	DimensionName
hierarchyName	HierarchyName
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.

Property	Type	Description
elementType	"Identifier"
quoting	Quoting
value	string

MdxLevelCompoundIdentifier

A MdxCompoundIdentifier that represents a level.

Property	Type	Description
elementType	"CompoundIdentifier"
identifiers	MdxIdentifier[]
dimensionName	DimensionName
hierarchyName	HierarchyName
levelName	LevelName
type	"level"

MdxLiteral

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

Property	Type	Description
elementType	"Literal"
type	Argument
value	string

MdxMeasureCompoundIdentifier

Property	Type	Description
elementType	"CompoundIdentifier"
identifiers	MdxIdentifier[]
measureName	MeasureName
type	"measure"

MdxMemberCompoundIdentifier

A MdxCompoundIdentifier that represents a member.

Property	Type	Description
elementType	"CompoundIdentifier"
identifiers	MdxIdentifier[]
dimensionName	DimensionName
hierarchyName	HierarchyName
levelName	LevelName
path	string[]
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.

Property	Type	Description
elementType	"MemberPropertyDefinition"
expression	MdxExpression
name	string

MdxNamedSet

Property	Type	Description
caption	string
cube	CubeName
description	string
expression	MdxString
name	AxisName
serverUrl	string
type	"namedSet"

MdxNamedSetCompoundIdentifier

A MdxCompoundIdentifier that represents a named set.

Property	Type	Description
elementType	"CompoundIdentifier"
identifiers	MdxIdentifier[]
setName	SetName
type	"namedSet"

MdxOrderFunction

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

• MdxFunction & MdxFunction & { arguments: [MdxExpression, MdxExpression, OrderModeMdxLiteral]
• [MdxExpression, MdxExpression]; name: "Order"; }

MdxSelect

An Mdx representing a SELECT statement.

Property	Type	Description
axes	MdxAxis[]
cellProps	string[]
elementType	"Select"
from	MdxSubSelect | MdxFromClause
slicerAxis	MdxSlicerAxis | null
withClause	MdxFormula[]

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.

Property	Type	Description
axes	MdxAxis[]
elementType	"SubSelect"
from	MdxSubSelect | MdxFromClause
nonVisual	boolean
slicerAxis	MdxSlicerAxis | null

MdxUnknownCompoundIdentifier

A MdxCompoundIdentifier representing an unknown identifier.

Property	Type	Description
elementType	"CompoundIdentifier"
identifiers	MdxIdentifier[]
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.

Property	Type	Description
elementType	"When"
then	MdxExpression
when	MdxExpression

Measure

Property	Type	Description
caption	string
folder	string
formatString	string
name	MeasureName
type	string
visible	boolean

MeasureDraggedFromDataModelTree

Property	Type	Description
fieldType	"measure"
measure	Measure
type	"DATA_TREE_FIELD"

MeasureGroup

Property	Type	Description
caption	string
description	string
name	string

MeasureInMapping

A tile in the widget mapping, representing a measure.

Property	Type	Description
measureName	string
type	"measure"

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

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
cubeName	string
serverKey	string
measure	Measure
type	"measure"

MeasuresFolderNode

A data model tree node representing a measuresFolder

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
cubeName	string
serverKey	string
children	MeasureNode[]
type	"measuresFolder"

MeasuresRootNode

A data model tree node representing a measuresRoot

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
cubeName	string
serverKey	string
type	"measuresRoot"

MeasureUniqueName

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

string

For example:

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

Member

Property	Type	Description
captionPath	string[]
namePath	string[]
properties	{    [key in CellProperty]?: null | string | number | undefined; }

MemberCoordinates

Coordinates identifying a Member.

HierarchyCoordinates & {
   namePath: string[];
}

MenuItemPlugin

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

Property	Type	Description
key	string
translations	{    [locale: string]: TranslationTree<string>; }
Component	ComponentType<MenuItemProps<WidgetState, SelectionType>>

MenuItemProps

ActionProps<WidgetState, SelectionType> & AntMenuItemProps

NodeIconProps

Property	Type	Description
node	InternalNode & NodeType
style	CSSProperties

NodeProps

Property	Type	Description
caretStyle	CSSProperties
ContextMenu	ComponentType<TreeContextMenuProps>
data	InternalNode[]
getDefaultCaption	(node?: NodeType) => string
hasCheckbox	boolean
hasSelectedChildren	boolean
hoverStyle	CSSProperties
Icon	ComponentType<NodeIconProps> | null
index	number
isEdited	boolean
isExpandable	boolean
isExpanded	boolean
isSelected	boolean
onClick	(item: InternalNode, event: ReactMouseEvent<HTMLDivElement>) => void
onEditCanceled	() => void
onEditEnded	(path: number[], caption: string) => void
onEditStarted	(path: number[]) => void
onExpandToggled	(item: InternalNode) => void
selectionStyle	CSSProperties
style	CSSProperties
trees	TreeObject<NodeType>[]

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.

• { userName: UserName
• UserGroupName; type: PermissionType; isPending?: boolean; }

PermissionType

• "reader"
• "editor"

PlotlyOverrides

Plotly configuration overrides that can be made in the chart's configuration.

Property	Type	Description
config	Partial<Plotly.Config>
data	DataOverrides
layout	Partial<Plotly.Layout>

PlotlyWidgetState

Property	Type	Description
filters	(T extends "serialized" ? MdxString : Mdx)[]
isFullScreen	boolean
name	string
queryContext	QueryContextEntry[]
widgetKey	string
query	Partial<Query<T extends "serialized" ? MdxString : MdxType>>
serverKey	string
mapping	T extends "serialized" ? SerializedDataVisualizationWidgetMapping : DataVisualizationWidgetMapping
styleAttributes	string[]
switchedTo	string
colors	ChartColors
isTextVisible	boolean
opacity	number
plotly	PlotlyOverrides
subplotLimits	SubplotLimits

Plugin

Any type of ActiveUI plugin.

• CellPlugin<any>
• CellStylePlugin<any>
• SelectionListenerPlugin<any>
• MenuItemPlugin<any>
• TitleBarButtonPlugin<any>
• WidgetPlugin<any>

PluginRegistry

All ActiveUI plugins registered by the application using the SDK.

Property	Type	Description
"cell-style"	PluginsOfType<CellStylePlugin>
"menu-item"	PluginsOfType<MenuItemPlugin<any, any>>
"selection-listener"	PluginsOfType<SelectionListenerPlugin>
"titlebar-button"	PluginsOfType<TitleBarButtonPlugin<any, any>>
cell	PluginsOfType<CellPlugin>
widget	PluginsOfType<WidgetPlugin<any, any>>

PluginsOfType

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

PluginsProviderProps

Property	Type	Description
value	PluginRegistry | null

PluginType

A type of Plugin.

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

Query

Property	Type	Description
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.
mdx	T	Query 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".
updateMode	UpdateMode	Whether 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.

Property	Type	Description
key	string
value	string | 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

Property	Type	Description
errorChain	{    type: string;    message: string; }[]
stackTrace	string

QueryRange

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

Property	Type	Description
from	number
to	number

QueryResult

Property	Type	Description
data	ResultType	The data for this result, either a CellSet or a DrillthroughResult
error	QueryError
isLoading	boolean

QuickFilterWidgetState

Property	Type	Description
filters	(T extends "serialized" ? MdxString : Mdx)[]
isFullScreen	boolean
name	string
queryContext	QueryContextEntry[]
widgetKey	string
cubeName	CubeName
levelCoordinates	LevelCoordinates
mode	"select" | "multi-select" | "checkbox" | "radio"
serverKey	string

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"

Range

Property	Type	Description
from	number
to	number

RangeConfiguration

Property	Type	Description
chunkSize	number
thresholdPercentage	number

RangesConfiguration

{
   [a in TableAxisId]: RangeConfiguration;
}

SelectionAnchor

Property	Type	Description
columnIndex	number
gridKey	GridKey
rowIndex	number

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.

Property	Type	Description
key	string
translations	{    [locale: string]: TranslationTree<string>; }
SelectionListener	ComponentType<WidgetPluginProps<WidgetState, SelectionType> & {    children: JSX.Element;    selection?: SelectionType; }>

SelectionRange

Property	Type	Description
anchor	SelectionAnchor
body	GridRange
columnHeader	GridRange
rowHeader	GridRange
staticHeader	GridRange

SerializedDataVisualizationWidgetMapping

The attributes to fields mapping, specific to a given type of data visualization widget. Contains serialized fields. See DataVisualizationWidgetMapping

For example:

{

rows: [

"[Currency].[Currency].[Currency]"

]

}

ServerNode

A data model tree node representing a server

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
type	"server"

ServiceVersion

Property	Type	Description
id	string
restPath	string
wsPath	string

Set

Property	Type	Description
caption	string
description	string
expression	string
name	SetName

SetName

string

SetNode

A data model tree node representing a set

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
cubeName	string
serverKey	string
set	Set
type	"set"

SetsRootNode

A data model tree node representing a setsRoot

Property	Type	Description
caption	string
dragItem	any
isActionable	boolean
isDisabled	boolean
isFolder	boolean
cubeName	string
serverKey	string
type	"setsRoot"

SettingListener

(value: Settings[K]) => void

Settings

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

Property	Type	Description
"calculatedMeasures.areEnabled"	boolean	Whether the calculated measures creation and edition popup is accessible.
"dataModel.isSimplified"	boolean	When true, redundant/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"	boolean	Whether calculated members are requested in MDX queries. Changing this setting only affects the queries generated by future user interactions. It does not have any impact on already saved widgets and dashboards.
"search.maxResults"	number	The maximum number of search results.
"userFilters.areEnabled"	boolean	Whether 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"

SubmittedKpiComparison

HierarchyCoordinates & {
   referenceMemberNamePath: string[];
   comparedMemberNamePath: string[];
}

SubplotLimits

Maximum number of subplots that will be displayed horizontally and vertically.

Property	Type	Description
horizontal	number
vertical	number

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"

TableAxisId

• 0
• 1

TableCell

The minimal information representing a cell in the Table component. Note that this has no reality in terms of the data fetched from ActivePivot and it is entirely specific to the Table component.

• { caption: string; value: number
• string; }
• null

TableProps

Property	Type	Description
Cell	ComponentType<CellProps>
cells	TableCell[][]
columnWidths	{    [columnIndex: number]: number; }
isTotal	(rowIndex: number) => boolean
numberOfFrozenColumns	number
numberOfFrozenRows	number
onColumnsResized	(updatedColumnWidths: {    [columnIndex: number]: number; }) => void
onKeyDown	(event: KeyboardEvent<HTMLDivElement>) => void
onKeyUp	(event: KeyboardEvent<HTMLDivElement>) => void
onScrolled	(newPosition: {    scrollTop: number;    scrollLeft: number; }) => void
onSelectionChanged	(selection: SelectionRange[]) => void
style	CSSProperties

TableStateDerivedFromCellSet

The information derived from data and used by CellSetTable and its children (including plugins).

Property	Type	Description
cells	({    caption: string;    value: number | string;    properties?: {      [key in CellProperty]?: null | string | number | undefined;   }; } | null)[][]	The cells forwarded to the underlying Table component. The dimensions of the array include the frozen rows and columns. Only the cells of the body are filled, as the rendering of the header cells depend on more information, present in the metaData.
columnHeaderIndices	{    hierarchyIndex: number;    levelIndex: number; }[]
columnsAxis	Axis | undefined
cube	Cube
data	CellSet
defaultMeasure	DefaultMember
hierarchyIndicesInCellSet	HierarchyIndicesInCellSet
indexOfMeasureOnSlicer	number
mapping	DataVisualizationWidgetMapping
numberOfColumnsInBody	number
numberOfFrozenColumns	number
numberOfFrozenRows	number
numberOfRowsInBody	number
rowHeaderIndices	{    hierarchyIndex: number;    levelIndex: number; }[]
rowsAxis	Axis
slicerAxis	Axis
sort	{    orderMode: OrderMode | undefined;    tupleCoordinates?: TupleCoordinates;    levelCoordinates?: LevelCoordinates; }
staticHeaderCoordinatesOnColumns	TableStaticHeaderCoordinates[]
staticHeaderCoordinatesOnRows	TableStaticHeaderCoordinates[]
staticHeadersOnColumns	TableStaticHeader[]
staticHeadersOnRows	TableStaticHeader[]

TableStaticHeader

• {
     type: "Measures";
  }
• Level

TableStaticHeaderCoordinates

• {
     dimensionName: "Measures";
     hierarchyName: "Measures";
  }
• LevelCoordinates

TableWidgetPlugin

The more specific WidgetPlugin interface, suited for table widgets.

Property	Type	Description
key	string
translations	{    [locale: string]: TranslationTree<string>; }
attributes	WidgetAttributes
category	WidgetCategory
Component	ComponentType<WidgetPluginProps<WidgetState, SelectionType>>
contentEditor	ComponentType<EditorProps<WidgetState>>
contextMenuItems	string[]
doesSupportMeasuresRedirection	boolean
filtersEditor	ComponentType<EditorProps>
Icon	ComponentType<IconProps>
initialState	WidgetState
menuItems	string[]
queryEditor	ComponentType<EditorProps<WidgetState>>
selectionListener	string	The key of a SelectionListenerPlugin to be executed whenever this widget's selection changes.
styleEditor	ComponentType<EditorProps<WidgetState>>
subCategory	string
titleBarButtons	string[]
cell	string	The key of the cell plugin to use.
cellStyle	string	The key of the cell style plugin to use.

TableWidgetState

Property	Type	Description
filters	(T extends "serialized" ? MdxString : Mdx)[]
isFullScreen	boolean
name	string
queryContext	QueryContextEntry[]
widgetKey	string
query	Partial<Query<T extends "serialized" ? MdxString : MdxType>>
serverKey	string
mapping	T extends "serialized" ? SerializedDataVisualizationWidgetMapping : DataVisualizationWidgetMapping
styleAttributes	string[]
switchedTo	string
columnWidths	{    [tupleId: string]: number; }

TextEditorWidgetState

State of a pluginWidgetTextEditor widget.

Property	Type	Description
filters	(T extends "serialized" ? MdxString : Mdx)[]
isFullScreen	boolean
name	string
queryContext	QueryContextEntry[]
widgetKey	string
displayMode	"view" | "edit"
text	string

Theme

Contains all style attributes used by ActiveUI components.

Property	Type	Description
activeTabBackgroundColor	Color
alternateCellBackgroundColor	Color
backgroundColor	Color
black	Color
cellBackgroundDuringNegativeTransition	Color
cellBackgroundDuringPositiveTransition	Color
cellBorderColor	Color
disabledBackground	Color
disabledTextColor	Color
dropHintBorderColor	Color
dropHintColor	Color
errorColor	Color
grayScale	Color[]
headerActiveColor	Color
hoverColor	Color
inactiveTabBackgroundColor	Color
isDark	boolean
placeholderColor	Color
primaryColor	Color
selectedMenuItemBackground	Color
selectionColor	Color
shadowColor	Color
successColor	Color
textColor	Color
warningColor	Color
white	Color

TitleBarButtonPlugin

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

Property	Type	Description
key	string
translations	{    [locale: string]: TranslationTree<string>; }
Component	ComponentType<ActionProps<WidgetState, SelectionType>>

TitleProps

Property	Type	Description
children	React.ReactNode
disabled	boolean
level	1 | 2 | 3 | 4 | 5

TopBottomMode

• "TopCount"
• "TopSum"
• "TopPercent"
• "BottomCount"
• "BottomSum"
• "BottomPercent"

Trace

• Omit<Partial<Plotly.PlotData>, "x"
• "y"
• "r"
• "theta"> & "theta"> & { _key: string; cellsIndices: (CellIndices[]
• null)[]; axisIndices?: (number
• null)[]; } & (T extends "vertical" ? & (T extends "vertical" ? { x: (string
• null)[]; y: (number
• null)[]; } : unknown) & (T extends "horizontal" ? : unknown) & (T extends "horizontal" ? { x: (number
• null)[]; y: (string
• null)[]; } : unknown) & (T extends "scatter" ? : unknown) & (T extends "scatter" ? { x: (number
• null)[]; y: (number
• null)[]; } : unknown) & (T extends "radar" ? : unknown) & (T extends "radar" ? { r: (number
• null)[]; theta: string[]; } : unknown)

TraceType

Defines whether the trace has an ordinal horizontal axis and a numeric vertical one, or the other way around.

• "horizontal"
• "vertical"
• "noaxis"
• "scatter"
• "radar"For example:

Lines and column charts are "vertical" whereas bar charts are "horizontal".

TranslationParameter

• string
• number
• boolean
• Date
• undefined
• null

TranslationParameters

Object containing TranslationParameter values identified by a key.

TranslationTree

A tree of translations identified by a key.

TreeContextMenuProps

Property	Type	Description
node	ANode & NodeType
onEditStarted	() => void
path	number[]
trees	TreeObject<NodeType>[]

TreeListener

• (value: ContentRecord<DashboardMetaData
• WidgetMetaData
• FilterMetaData
• CalculatedMeasureMetaData>) => void

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.

Property	Type	Description
username	string
userRoles	string[]

UserGroupName

The name of a group of users.

string

UserName

The name of a user.

string

Versions

Property	Type	Description
apis	{    [apiKey: string]: {      versions: [ServiceVersion];   }; }
serverVersion	string
version	number

WidgetActionProps

Property	Type	Description
className	string
onWidgetChange	(newWidgetState: WidgetState) => void
queryId	string
selection	SelectionType
widgetState	WidgetState

WidgetAttribute

Property	Type	Description
isMainAxis	boolean
maxNumberOfFields	number
role	AttributeRole

WidgetAttributes

An object containing WidgetAttribute values identified by their name.

WidgetCategory

• "dataVisualization"
• "editor"
• "filter"
• "monitor"
• "misc"

WidgetContent

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

• Omit<AWidgetState<"serialized">, "name"
• "widgetKey">

WidgetInDashboardActionProps

Property	Type	Description
className	string
onWidgetChange	(newWidgetState: WidgetState) => void
queryId	string
selection	SelectionType
widgetState	WidgetState
dashboardState	DashboardState
layoutPath	number[]
leafKey	string
onActivePageChange	(newActivePageKey: string) => void
onDashboardChange	(newDashboardState: DashboardState) => void
pageKey	string

WidgetMetaData

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

Property	Type	Description
isFolder	boolean
name	string
widgetKey	string

WidgetPlugin

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

Property	Type	Description
key	string
translations	{    [locale: string]: TranslationTree<string>; }
attributes	WidgetAttributes
category	WidgetCategory
Component	ComponentType<WidgetPluginProps<WidgetState, SelectionType>>
contentEditor	ComponentType<EditorProps<WidgetState>>
contextMenuItems	string[]
doesSupportMeasuresRedirection	boolean
filtersEditor	ComponentType<EditorProps>
Icon	ComponentType<IconProps>
initialState	WidgetState
menuItems	string[]
queryEditor	ComponentType<EditorProps<WidgetState>>
selectionListener	string	The key of a SelectionListenerPlugin to be executed whenever this widget's selection changes.
styleEditor	ComponentType<EditorProps<WidgetState>>
subCategory	string
titleBarButtons	string[]

WidgetPluginInDashboardProps

Props received by a widget within a dashboard

WidgetPluginOutsideADashboardProps<WidgetState, SelectionType> & {
   layoutPath: number[];
   leafKey: string;
   pageKey: string;
   dashboardState: DashboardState;
   onDashboardChange: (newDashboardState: DashboardState) => void;
   onActivePageChange: (newActivePageKey: string) => void;
}

WidgetPluginOutsideADashboardProps

Property	Type	Description
isDeferred	boolean
onChange	(newState: WidgetState) => void
onLoaded	() => void
onSelectionChange	(newSelection: SelectionType) => void
queryId	string
style	CSSProperties
widgetState	WidgetState

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.

Property	Type	Description
filters	(T extends "serialized" ? MdxString : Mdx)[]
isFullScreen	boolean
name	string
queryContext	QueryContextEntry[]
widgetKey	string
query	Partial<Query<T extends "serialized" ? MdxString : MdxType>>
serverKey	string

WithCubeProps

The props provided to a Component, when it is wrapped in withCube.

Property	Type	Description
cube	Cube
dataModel	DataModel
serverKey	string