Skip to main content

Types

AccessLog#

PropertyTypeDescription
idstring
lastOpenednumber

ActionProps#

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
urlstringThe server's URL.
webServiceVersionServiceVersionThe version of the APIs offered by the server's REST and websocket endpoints.
connectionStatusConnectionStatusThe current connection status of the client.
dataModelDataModel | undefinedThe DataModel if it is already loaded. See loadDataModel.
drillthroughColumns{
   [cubeName: string]: {
     drillthroughColumns?: DrillthroughColumn[];
     isLoading: boolean;
     error?: Error;
  };
}
The list of DrillthrouhgColumn per cube, if they are already loaded. See loadDrillthroughColumns.
MethodDescription
addConnectionStatusListenerRegisters listener to be called whenever the client status changes.
addDataModelListenerRegisters listener to be called whenever the data model changes.
addDrillthroughColumnsListenerRegisters listener to be called whenever the drillthrough columns change.
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.
fetchAvailableDrillthroughColumnsDeprecated: use activepivotClient.drillthroughColumns instead. Asynchronously 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.
loadDrillthroughColumnsAsynchronously loads the list of DrillthroughColumn for cube cubeName, making it available through ActivePivotClient.
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.
removeDrillthroughColumnsListenerRemoves listener and stops calling it whenever the drillthrough columns change.
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.
userQueryContextQueryContextEntry[]Query context attached to the current user and applying to all dashboards they visit.

ActivityListener#

(value: Activity[K]) => void

ADataModelNode#

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

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
cubeNamestring
serverKeystring

AFilter#

A filter is always contextual to a hierarchy

HierarchyCoordinates & {
   isExclusionFilter?: boolean;
}

AllMeasuresInMapping#

A tile in the widget mapping, representing all measures.

PropertyTypeDescription
type"allMeasures"

AMdxCompoundIdentifier#

The common attributes shared by all types of MdxCompoundIdentifier.

PropertyTypeDescription
elementType"CompoundIdentifier"
identifiersMdxIdentifier[]

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.

PropertyTypeDescription
keystring
translations{
   [locale: string]: TranslationTree<string>;
}

ApplicationMenu#

An Antd.Menu.SubMenu that contains the submenu itself, and its children. The children can be more subMenus, or menuItems.

PropertyTypeDescription
children(ApplicationMenu | ApplicationMenuItem)[]
componentComponentTypeBy convention, always an Antd.Menu.SubMenu.

ApplicationMenuItem#

An Antd.Menu.Item that is displayed in the application menu.

PropertyTypeDescription
componentComponentTypeBy convention, always an Antd.Menu.Item.

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.

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

BasicDashboardProps#

PropertyTypeDescription
activePageKeystring
classNamestring
initialPageStateOmit<DashboardPageState, "name">
isExportingToPDFboolean
LeafComponentComponentType<LeafProps>
onActivePageChange(newActivePageKey: string) => void
onAfterPrint() => void
onChange(newState: DashboardState) => void
onWidgetSelected(newSelectedLeafKey: string) => void
selectedLeafKeystring
stateDashboardState
styleCSSProperties
tabBarExtraContentReactNode

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#

PropertyTypeDescription
cubesCube[]
namestring

CatalogNode#

A data model tree node representing a catalog

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
type"catalog"

Cell#

PropertyTypeDescription
formattedValuestring
ordinalnumber
properties{
   [key in CellProperty]?: null | string | number | undefined;
}
valuenumber | 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.

PropertyTypeDescription
keystring
translations{
   [locale: string]: TranslationTree<string>;
}
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"

CellProps#

Type extended by the props of CellPlugin Cell components.

PropertyTypeDescription
captionstring
classNamestring
columnIndexnumber
heightnumber
isColumnFrozenboolean
isRowFrozenboolean
leftnumber
parentTotalRowIndexnumber
rowIndexnumber
styleCSSProperties
topnumber
valuestring | number
widthnumber

CellSet#

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

CellSetAxesSelection#

The tuples and levels corresponding to the selected positions (which can be headers in a table or ticks on a chart's axes).

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

CellSetCellsSelection#

The tuple and value corresponding to each selected Cell (which can be body cells in a table, or points on a chart).

  • { 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 CellSetTable.

LoadingTableCellProps & DerivedCellSetTableBodyCellProps

CellSetTableCellProps#

The props of cells in a CellSetTable.

CellSetTableHeaderCellProps#

The props of header cells in a CellSetTable.

LoadingTableCellProps & DerivedCellSetTableHeaderCellProps

CellSetTableStaticHeaderCellProps#

The props of static header cells in a CellSetTable.

LoadingTableCellProps & DerivedCellSetTableStaticHeaderCellProps

CellStylePlugin#

Plugin useful to provide style to cells in table widgets.

PropertyTypeDescription
keystring
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>

Client#

Parent interface for ActivePivot/Content Server/ActiveMonitor clients.

PropertyTypeDescription
urlstringThe server's URL.
webServiceVersionServiceVersionThe version of the APIs offered by the server's REST and websocket endpoints.

Clients#

PropertyTypeDescription
activePivot{
   [serverKey: string]: ActivePivotClient;
}
contentClientContentClient

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.

PropertyTypeDescription
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.

PropertyTypeDescription
applicationNamestring
drawersDrawer[]
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
initialDashboardPageStateOmit<DashboardPageState, "name">
leftApplicationMenu(ApplicationMenu | ApplicationMenuItem)[]Controls the menu items on the left of the header. They are usually specific to dashboards.
pluginRegistryPluginRegistry
rightApplicationMenu(ApplicationMenu | ApplicationMenuItem)[]Controls the menu items on the right of the header. They are typically always available.
storeEnhancersStoreEnhancer[]Redux store enhancers, allowing extensions to hook into the state of ActiveUI.It can be used by an extension to: - inject its own state into ActiveUI, so that the extension itself and other extensions can consume it - react to actions dispatched by ActiveUI or other extensionsThe store enhancers are composed, which allows to split state management on a per-extension basis.See https://redux.js.org/usage/configuring-your-store#extending-redux-functionality

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.

PropertyTypeDescription
urlstringThe server's URL.
webServiceVersionServiceVersionThe version of the APIs offered by the server's REST and websocket endpoints.
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.
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.
deleteFilesAndFoldersAsynchronously deletes the selected files and folders of type 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, undefined otherwise.
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.
getAreSettingsLoadedReturns whether the settings have been loaded by loadSettings
getSettingReturns the value of the setting identified by settingKey if it exists.
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. If the activity file's content is not a valid JSON object, a default empty activity object is loaded.
loadSettingsAsynchronously loads the settings, making them available via getSetting. If the settings file's content is not a valid JSON object, loads a set of default settings values instead.
loadTreeAsynchronously loads the tree of all accessible dashboards, widgets, filters or calculated measures.
moveFileAsynchronously moves a dashboard or a widget into a folder on the Content Server.
moveFilesAsynchronously moves files from a same folder into a different 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.
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
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
entryContentEntry<AMetaData>
idstring
metaDataMetaData
typeContentNodeType

ContentNodeType#

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

ContentRecord#

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

ContentTreeMenuItemProps#

PropertyTypeDescription
contentTreeContentRecord
contentTypeContentType
onAfterSubmit() => void
onEditStarted(id: string) => void
pathToParentFolderstring[]
selectedFilesAndFolders({
   id: string;
   record: ContentRecord<AMetaData>;
   metaData: AMetaData;
} | {
   doesRepresentServer: true;
})[]

ContentType#

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

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
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
namestring
serverKeystring
type"cube"

CubeSelectorProps#

PropertyTypeDescription
cubeCube | null
mdxMdxSelectIf provided, mdx controls which cube options are disabled.
onCubeSelected(serverKey: string, cubeName: CubeName) => void
serverKeystring

CurriedCellSetTableCellProps#

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

PropertyTypeDescription
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;
}[]
columnsAxisAxis | undefined
cubeCube
dataCellSet
defaultMeasureDefaultMember
hierarchyIndicesInCellSetHierarchyIndicesInCellSet
indexOfMeasureOnSlicernumber
mappingDataVisualizationWidgetMapping
numberOfColumnsInBodynumber
numberOfFrozenColumnsnumber
numberOfFrozenRowsnumber
numberOfRowsInBodynumber
rowHeaderIndices{
   hierarchyIndex: number;
   levelIndex: number;
}[]
rowsAxisAxis
slicerAxisAxis
sort{
   orderMode: OrderMode | undefined;
   tupleCoordinates?: TupleCoordinates;
   levelCoordinates?: LevelCoordinates;
}
staticHeaderCoordinatesOnColumnsTableStaticHeaderCoordinates[]
staticHeaderCoordinatesOnRowsTableStaticHeaderCoordinates[]
staticHeadersOnColumnsTableStaticHeader[]
staticHeadersOnRowsTableStaticHeader[]
isExpandable(tuple: TupleCoordinates) => boolean
isExpanded(tuple: TupleCoordinates) => boolean
onExpansionChanged(tuple: Tuple, toLevel: LevelCoordinates, isExpanding: boolean) => void
onSortChanged() => void
widgetStateDataVisualizationWidgetState

CurriedDrillthroughTableCellProps#

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

PropertyTypeDescription
headerCaptionsDrillthroughDataSetHeaderCell[]
headerValuesDrillthroughDataSetHeaderCell[]
onSortChanged() => void
sort{
   orderMode: "ASC" | "DESC";
   drillthroughColumnUniqueName: string;
}

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

DataOverrides#

Plotly overrides relative to the traces.

PropertyTypeDescription
additionalTracesTrace[]
commonTraceOverridePartial<Trace>
overridesByTraceIndexPartial<Trace>[]
overridesByTraceKey{
   [traceKey: string]: Partial<Trace>;
}

DataVisualizationMappingField#

A field in a data visualization widget's mapping.

DataVisualizationStyle#

Style attributes of a data visualization widget.

PropertyTypeDescription
measures{
   [measureName: string]: MeasureStyle;
}

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#

PropertyTypeDescription
filters(T extends "serialized" ? MdxString : Mdx)[]
isFullScreenboolean
namestring
queryContextQueryContextEntry[]
widgetKeystring
queryPartial<Query<T extends "serialized" ? MdxString : MdxType>>
serverKeystring
mappingT extends "serialized" ? SerializedDataVisualizationWidgetMapping : DataVisualizationWidgetMapping
styleDataVisualizationStyle
switchedTostring

DefaultContextValue#

PropertyTypeDescription
namestring
valuestring

DefaultMember#

PropertyTypeDescription
captionPathstring[]
dimensionDimensionName
hierarchyHierarchyName
pathstring[]

DerivedCellSetTableBodyCellProps#

The props specific to body cells in a CellSetTable.

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

DerivedCellSetTableHeaderCellProps#

The props specific to header cells in a CellSetTable.

PropertyTypeDescription
headerDepthnumber
hierarchyIndexnumber
levelIndexnumber
positionIndexnumber
tupleTuple | null

DerivedCellSetTableStaticHeaderCellProps#

The props specific to static header cells in a CellSetTable.

PropertyTypeDescription
staticHeaderCoordinatesTableStaticHeaderCoordinates

Dimension#

PropertyTypeDescription
captionstring
defaultHierarchyHierarchyName
descriptionstring
hierarchiesHierarchy[]
nameDimensionName
typestring
visibleboolean

DimensionDraggedFromDataModelTree#

PropertyTypeDescription
cubeNameCubeName
dimensionDimension
fieldType"dimension"
serverKeystring
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

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
cubeNamestring
serverKeystring
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>The component displayed when the user opens the drawer.
iconComponentType<AntdIconProps>The icon displayed in the left bar and on which the user can click in order to open or close this drawer.
keystringIdentifies the drawer.
shortcutstringThe key of the shortcut to open this drawer. For instance, "w" means that the user can open this drawer by pressing "Alt" + "w".
translations{
   [locale: string]: {
     [key: string]: string;
  };
}
Translations specific to this drawer. This is useful if you wish to include a drawer within an extension (see ExtensionModule) in order to make it reusable across projects.
type"double" | "single"Whether the drawer contains two independently resizable parts, or if it is a single block.

DrillthroughColumn#

The drillthrough column as described by the server

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

DrillthroughColumnUniqueName#

A unique identifier for a drillthrough column.

string

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"

ExpansionAction#

An action of expansion in a tree.

PropertyTypeDescription
pathnumber[]the path to the node that the user interacted with
type"expand" | "collapse"whether the node was expanded or collapsed

ExtensionModule#

The entrypoint module of an ActiveUI extension.

PropertyTypeDescription
activate(params: Configuration) => Promise<void>

FieldDraggedFromDataModelTree#

FieldUniqueName#

Filter#

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.

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".

FilterOnDateRange#

A filter on a range of dates (only available for hierarchies of type time).

PropertyTypeDescription
endDateDate
isRollingDateboolean
levelNamestring
startDateDate
type"dateRange"
For example:

Filter on transactions between "2021/12/01" and "2021/12/20".

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$.

FilterScope#

  • "overall"
  • "ofEachParent"

FilterType#

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

FormulaType#

  • "SET"
  • "MEMBER"

GenericIndenter#

PropertyTypeDescription
indent(needSpace?: boolean) => string
newLine(needSpace?: boolean) => string
unindent() => void

GridKey#

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

GridRange#

PropertyTypeDescription
columnsRange
rowsRange

Hash#

PropertyTypeDescription
expectedstring[]
linenumber
loc{
   first_column: number;
   last_column: number;
   last_line: number;
}
textstring

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'};

HierarchyDraggedFromDataModelTree#

PropertyTypeDescription
cubeNameCubeName
dimensionDimension
fieldType"hierarchy"
hierarchyHierarchy
serverKeystring
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.

PropertyTypeDescription
expandedDownToLevelName
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

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
cubeNamestring
serverKeystring
dimensionDimension
hierarchyHierarchy
type"hierarchy"

HierarchyUniqueName#

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

string

For example:
const hierarchyUniqueName = '[Geography].[City]';

HighlightedCaptionProps#

PropertyTypeDescription
captionstring
isDisabledboolean
searchValuestring

InternalNode#

Represents a node in a tree.

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

Kpi#

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

KpiComparison#

KpiFolderNode#

A data model tree node representing a folder of kpis

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
cubeNamestring
serverKeystring
childrenKpiNode[]
type"kpiFolder"

KpiNode#

A data model tree node representing a kpi

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
cubeNamestring
serverKeystring
childrenKpiPropertyNode[]
type"kpi"

KpiProperty#

PropertyTypeDescription
kpiNamestring
kpiPropertyNameKpiPropertyName
underlyingMeasureNameMeasureName

KpiPropertyDraggedFromDataModelTree#

PropertyTypeDescription
kpiNamestring
kpiPropertyNameKpiPropertyName
underlyingMeasureNameMeasureName
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.

PropertyTypeDescription
kpiNamestring
propertyNameKpiPropertyName
type"kpiProperty"
underlyingMeasureNameMeasureName

KpiPropertyName#

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

KpiPropertyNode#

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

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
cubeNamestring
serverKeystring
kpiNamestring
kpiPropertyNameKpiPropertyName
underlyingMeasureNameMeasureName
type"kpiProperty"

KpisRootNode#

A data model tree node representing a kpisRoot

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
cubeNamestring
serverKeystring
children(KpiFolderNode | KpiNode)[]
type"kpisRoot"

KpiWidgetState#

PropertyTypeDescription
filters(T extends "serialized" ? MdxString : Mdx)[]
isFullScreenboolean
namestring
queryContextQueryContextEntry[]
widgetKeystring
queryPartial<Query<T extends "serialized" ? MdxString : MdxType>>
serverKeystring
mappingT extends "serialized" ? SerializedDataVisualizationWidgetMapping : DataVisualizationWidgetMapping
styleDataVisualizationStyle
switchedTostring
comparisonKpiComparison
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.

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

LayoutLeaf#

PropertyTypeDescription
leafKeystring
sizenumber

LeafProps#

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

PropertyTypeDescription
dashboardStateDashboardState
dragHandleRefDragElementWrapper<DragSourceOptions>
isDeferredboolean
layoutPathnumber[]
leafKeystring
onActivePageChange(newActivePageKey: string) => void
onDashboardChange(newDashboardState: DashboardState) => void
onLoaded() => void
pageKeystringThe key of the page containing the widget.
widgetStateWidgetState

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'};

LevelDraggedFromDataModelTree#

PropertyTypeDescription
cubeNameCubeName
dimensionDimension
fieldType"level"
hierarchyHierarchy
levelLevel
serverKeystring
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

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
cubeNamestring
serverKeystring
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 CellSetTable, 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.

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
elementType"CompoundIdentifier"
identifiersMdxIdentifier[]
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
elementType"CompoundIdentifier"
identifiersMdxIdentifier[]
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
elementType"CompoundIdentifier"
identifiersMdxIdentifier[]
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
elementType"CompoundIdentifier"
identifiersMdxIdentifier[]
measureNameMeasureName
type"measure"

MdxMemberCompoundIdentifier#

A MdxCompoundIdentifier that represents a member.

PropertyTypeDescription
elementType"CompoundIdentifier"
identifiersMdxIdentifier[]
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
elementType"CompoundIdentifier"
identifiersMdxIdentifier[]
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
elementType"CompoundIdentifier"
identifiersMdxIdentifier[]
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

MeasureConditionalStyle#

Contains the style for a measure and the conditions under which to apply it. The condition is described with 1 or 2 keys. When there are 2 keys, they are necessarily a pair of lt(e)/gt(e), matching all values between or outside 2 limits.

PropertyTypeDescription
eqnumber
gtnumber
gtenumber
ltnumber
ltenumber
neqnumber
styleCSSProperties

MeasureDraggedFromDataModelTree#

PropertyTypeDescription
fieldType"measure"
measureMeasure
type"DATA_TREE_FIELD"

MeasureGroup#

PropertyTypeDescription
captionstring
descriptionstring
namestring

MeasureInMapping#

A tile in the widget mapping, representing a measure.

PropertyTypeDescription
measureNamestring
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

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
cubeNamestring
serverKeystring
measureMeasure
type"measure"

MeasuresFolderNode#

A data model tree node representing a measuresFolder

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
cubeNamestring
serverKeystring
childrenMeasureNode[]
type"measuresFolder"

MeasuresRootNode#

A data model tree node representing a measuresRoot

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
cubeNamestring
serverKeystring
type"measuresRoot"

MeasureStyle#

The style applied to the values of a Measure in the target widget.

PropertyTypeDescription
conditionalMeasureConditionalStyle[]
defaultCSSProperties
numberFormatNumberFormat
numberOfDecimalsnumber

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[];
}

MenuItemPlugin#

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

PropertyTypeDescription
keystring
translations{
   [locale: string]: TranslationTree<string>;
}
ComponentComponentType<MenuItemProps<WidgetState, SelectionType>>

MenuItemProps#

ActionProps<WidgetState, SelectionType> & AntMenuItemProps

NodeIconProps#

PropertyTypeDescription
nodeInternalNode & NodeType
styleCSSProperties

NodeProps#

PropertyTypeDescription
caretStyleCSSProperties
ContextMenuComponentType<TreeContextMenuProps>
dataInternalNode[]
getDefaultCaption(node?: NodeType) => string
hasCheckboxboolean
hasSelectedChildrenboolean
hoverStyleCSSProperties
IconComponentType<NodeIconProps> | null
indexnumber
isEditedboolean
isExpandableboolean
isExpandedboolean
isSelectedboolean
onClick(item: InternalNode, event: ReactMouseEvent<HTMLDivElement>) => void
onEditCanceled() => void
onEditEnded(path: number[], caption: string) => void
onEditStarted(path: number[]) => void
onExpandToggled(item: InternalNode, isExpanding: boolean) => void
selectionStyleCSSProperties
styleCSSProperties
treesTreeObject<NodeType>[]

NumberFormat#

The types of number format, corresponding to ways to abbreviate big numbers in order to make them more legible.

  • "number"
  • "thousands"
  • "millions"
  • "percentage"
  • "billions"

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.

PermissionType#

  • "reader"
  • "editor"

PlotlyOverrides#

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

PropertyTypeDescription
configPartial<Plotly.Config>
dataDataOverrides
layoutPartial<Plotly.Layout>

PlotlyWidgetState#

PropertyTypeDescription
filters(T extends "serialized" ? MdxString : Mdx)[]
isFullScreenboolean
namestring
queryContextQueryContextEntry[]
widgetKeystring
queryPartial<Query<T extends "serialized" ? MdxString : MdxType>>
serverKeystring
mappingT extends "serialized" ? SerializedDataVisualizationWidgetMapping : DataVisualizationWidgetMapping
styleDataVisualizationStyle
switchedTostring
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)

PluginsProviderProps#

PropertyTypeDescription
valuePluginRegistry | null

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

QuickFilterWidgetState#

The state of a pluginWidgetQuickFilter.

PropertyTypeDescription
filters(T extends "serialized" ? MdxString : Mdx)[]
isFullScreenboolean
namestring
queryContextQueryContextEntry[]
widgetKeystring
cubeNameCubeName
levelCoordinatesLevelCoordinates
mode"select" | "multi-select" | "checkbox" | "radio" | "tree"
serverKeystring

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#

PropertyTypeDescription
fromnumber
tonumber

SelectionAnchor#

PropertyTypeDescription
columnIndexnumber
gridKeyGridKey
rowIndexnumber

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
keystring
translations{
   [locale: string]: TranslationTree<string>;
}
SelectionListenerComponentType<WidgetPluginProps<WidgetState, SelectionType> & {
   children: JSX.Element;
   selection?: SelectionType;
}>

SelectionRange#

PropertyTypeDescription
anchorSelectionAnchor
bodyGridRange
columnHeaderGridRange
rowHeaderGridRange
staticHeaderGridRange

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

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
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
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
cubeNamestring
serverKeystring
setSet
type"set"

SetsRootNode#

A data model tree node representing a setsRoot

PropertyTypeDescription
captionstring
dragItemany
isActionableboolean
isDisabledboolean
isFolderboolean
cubeNamestring
serverKeystring
type"setsRoot"

SettingListener#

(value: Settings[K]) => void

Settings#

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

PropertyTypeDescription
"calculatedMeasures.areEnabled"booleanWhether the calculated measures creation and edition popup is accessible.
"dataModel.isSimplified"booleanWhen 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.
"drillthrough.defaultSelectedColumns"{
   [cubeName: string]: DrillthroughColumnUniqueName[];
}
The set of columns that is selected by default when opening a drillthrough table, per cube. If none is specified for a given cube, all the available drillthrough columns in this cube are selected.
"mdx.doesIncludeCalculatedMembers"booleanWhether 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"numberThe maximum number of search results.
"smartFiltering.ignoredHierarchies"string[]The unique names of the hierarchies to ignore in the smart filtering context: - When adding a filter on an ignored hierarchy, all members are displayed for selection. - When adding a filter on another hierarchy, the filters on the ignored hierarchy are *not* taken into account to retrieve the list of members displayed for selection.This can typically be used to disable smart filtering for an analysis hierarchy.
"userFilters.areEnabled"booleanWhether the "All dashboards" section is visible in the filters editor and taken into account by widgets. When enabled, it allows users to create filters that apply to all dashboards they visit.
"userQueryContext.isEnabled"booleanWhether the "All dashboards" section is visible in the query context editor and taken into account by widgets. When enabled, it allows users to create a global query context, which applies to all dashboards they visit.
homePageLayout"grid" | "list"The layout mode for the homepage.
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.

PropertyTypeDescription
horizontalnumber
verticalnumber

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"

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

TableStateDerivedFromCellSet#

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

PropertyTypeDescription
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;
}[]
columnsAxisAxis | undefined
cubeCube
dataCellSet
defaultMeasureDefaultMember
hierarchyIndicesInCellSetHierarchyIndicesInCellSet
indexOfMeasureOnSlicernumber
mappingDataVisualizationWidgetMapping
numberOfColumnsInBodynumber
numberOfFrozenColumnsnumber
numberOfFrozenRowsnumber
numberOfRowsInBodynumber
rowHeaderIndices{
   hierarchyIndex: number;
   levelIndex: number;
}[]
rowsAxisAxis
slicerAxisAxis
sort{
   orderMode: OrderMode | undefined;
   tupleCoordinates?: TupleCoordinates;
   levelCoordinates?: LevelCoordinates;
}
staticHeaderCoordinatesOnColumnsTableStaticHeaderCoordinates[]
staticHeaderCoordinatesOnRowsTableStaticHeaderCoordinates[]
staticHeadersOnColumnsTableStaticHeader[]
staticHeadersOnRowsTableStaticHeader[]

TableStaticHeader#

  • {
       type: "Measures";
    }
  • Level

TableStaticHeaderCoordinates#

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

TableWidgetPlugin#

The more specific WidgetPlugin interface, suited for table widgets.

PropertyTypeDescription
keystring
translations{
   [locale: string]: TranslationTree<string>;
}
attributesWidgetAttributes
categoryWidgetCategory
ComponentComponentType<WidgetPluginProps<WidgetState, SelectionType>>
contentEditorComponentType<EditorProps<WidgetState>>
contextMenuItemsstring[]
doesSupportMeasuresRedirectionboolean
filtersEditorComponentType<EditorProps>
IconComponentType<IconProps>
initialStateWidgetState
lazyLoading{
   chunkSizes: Partial<Record<"columns" | "rows", number>>;
}
Configuration of the maximum number of rows and columns that this widget fetches. Past these values, lazy loading kicks in: more rows and columns are only fetched dynamically when the user scrolls. When this attribute is omitted, it means that the widget does not support lazy loading and will fetch the entirety of the required data upfront.
menuItemsstring[]
queryEditorComponentType<EditorProps<WidgetState>>
selectionListenerstringThe key of a SelectionListenerPlugin to be executed whenever this widget's selection changes.
styleEditorComponentType<EditorProps<WidgetState>>
subCategorystring
titleBarButtonsstring[]
cellstringThe key of the cell plugin to use.
cellStylestringThe key of the cell style plugin to use.

TableWidgetState#

PropertyTypeDescription
filters(T extends "serialized" ? MdxString : Mdx)[]
isFullScreenboolean
namestring
queryContextQueryContextEntry[]
widgetKeystring
queryPartial<Query<T extends "serialized" ? MdxString : MdxType>>
serverKeystring
mappingT extends "serialized" ? SerializedDataVisualizationWidgetMapping : DataVisualizationWidgetMapping
styleDataVisualizationStyle
switchedTostring
columnWidths{
   [tupleId: string]: number;
}

TextEditorWidgetState#

State of a pluginWidgetTextEditor widget.

PropertyTypeDescription
filters(T extends "serialized" ? MdxString : Mdx)[]
isFullScreenboolean
namestring
queryContextQueryContextEntry[]
widgetKeystring
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
menuInlineSubmenuBgColor
placeholderColorColor
primaryColorColor
selectedMenuItemBackgroundColor
selectionColorColor
selectionOverlayColorColor
shadowColorColor
successColorColor
textColorColor
warningColorColor
whiteColor

TitleBarButtonPlugin#

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

PropertyTypeDescription
keystring
translations{
   [locale: string]: TranslationTree<string>;
}
ComponentComponentType<ActionProps<WidgetState, SelectionType>>

TitleProps#

PropertyTypeDescription
childrenReact.ReactNode
disabledboolean
level1 | 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#

PropertyTypeDescription
nodeANode & NodeType
onEditStarted() => void
pathnumber[]
treesTreeObject<NodeType>[]

TreeListener#

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

WidgetActionProps#

PropertyTypeDescription
classNamestring
onWidgetChange(newWidgetState: WidgetState) => void
queryIdstring
selectionSelectionType
widgetStateWidgetState

WidgetAttribute#

PropertyTypeDescription
isMainAxisboolean
maxNumberOfFieldsnumber
roleAttributeRole

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.

WidgetInDashboardActionProps#

PropertyTypeDescription
classNamestring
onWidgetChange(newWidgetState: WidgetState) => void
queryIdstring
selectionSelectionType
widgetStateWidgetState
dashboardStateDashboardState
layoutPathnumber[]
leafKeystring
onActivePageChange(newActivePageKey: string) => void
onDashboardChange(newDashboardState: DashboardState) => void
pageKeystring

WidgetMetaData#

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

PropertyTypeDescription
isFolderboolean
namestring
widgetKeystring

WidgetPlugin#

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

PropertyTypeDescription
keystring
translations{
   [locale: string]: TranslationTree<string>;
}
attributesWidgetAttributes
categoryWidgetCategory
ComponentComponentType<WidgetPluginProps<WidgetState, SelectionType>>
contentEditorComponentType<EditorProps<WidgetState>>
contextMenuItemsstring[]
doesSupportMeasuresRedirectionboolean
filtersEditorComponentType<EditorProps>
IconComponentType<IconProps>
initialStateWidgetState
lazyLoading{
   chunkSizes: Partial<Record<"columns" | "rows", number>>;
}
Configuration of the maximum number of rows and columns that this widget fetches. Past these values, lazy loading kicks in: more rows and columns are only fetched dynamically when the user scrolls. When this attribute is omitted, it means that the widget does not support lazy loading and will fetch the entirety of the required data upfront.
menuItemsstring[]
queryEditorComponentType<EditorProps<WidgetState>>
selectionListenerstringThe key of a SelectionListenerPlugin to be executed whenever this widget's selection changes.
styleEditorComponentType<EditorProps<WidgetState>>
subCategorystring
titleBarButtonsstring[]

WidgetPluginInDashboardProps#

Props received by a widget within a dashboard

PropertyTypeDescription
isDeferredboolean
onChange(newState: WidgetState) => void
onLoaded() => void
onSelectionChange(newSelection: SelectionType) => void
queryIdstring
styleCSSProperties
widgetStateWidgetState
dashboardStateDashboardState
layoutPathnumber[]
leafKeystring
onActivePageChange(newActivePageKey: string) => void
onDashboardChange(newDashboardState: DashboardState) => void
pageKeystring

WidgetPluginOutsideADashboardProps#

PropertyTypeDescription
isDeferredboolean
onChange(newState: WidgetState) => void
onLoaded() => void
onSelectionChange(newSelection: SelectionType) => void
queryIdstring
styleCSSProperties
widgetStateWidgetState

WidgetPluginProps#

Props received by a widget plugin component.

WidgetWithQueryProps#

Props received by a widget with a query.

WidgetPluginProps<WidgetState, SelectionType> & {
   queryResult: QueryResult<ResultType>;
   onQueryRangesChanged: (newRanges: Partial<{
     [axisId in AxisId]: QueryRange;
  }>) => void;
}

WidgetWithQueryState#

The state of widgets using a query.

PropertyTypeDescription
filters(T extends "serialized" ? MdxString : Mdx)[]
isFullScreenboolean
namestring
queryContextQueryContextEntry[]
widgetKeystring
queryPartial<Query<T extends "serialized" ? MdxString : MdxType>>
serverKeystring

WithCubeProps#

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

PropertyTypeDescription
cubeCube
dataModelDataModel
serverKeystring

WizardSection#

The attributes describing a section that is passed to a Wizard.

PropertyTypeDescription
captionstring
isAddButtonVisibleboolean
tilesWizardTile[]

WizardTile#

The attributes describing a tile element that is passed to a WizardSection.

PropertyTypeDescription
captionstring | ReactElement
dragItem{
   type: string;
} & any
isCorruptboolean
isDisabledboolean
isEditableboolean
isRemovableboolean
isSavableboolean
tooltipValuestring