ActiveUI SDK API reference

4.2.11

AboutActionParameters

Displays the about popup. There is no requirement concerning its availability (it can be used anywhere).

AboutActionParameters

Type: Object

Example
{
  key: 'about',
  args: {}
}

AboutApi

Version of the package and the Content Server

AboutApi

Type: Object

Properties
contentServerVersion (string)
packageVersion (string)

ActionImplementationProperties

Build an action offered to users in several places of the UI.

For example in the title bar of a dock in a dashboard, or in context menus or other user event handlers. Most of its methods are optional but one, execute. The methods are given different payloads depending on the situation in which they are instantiated (see ActionSituation to have a list of the different situations).

ActionImplementationProperties

Type: Object

Properties
execute (function (event: AnyEvent, actionPayload: ActionPayload): void) : Called when the action is being interacted with.
getBadge (function (actionPayload: ActionPayload): (string | number)?) : Returns a number or a string that will be displayed inside a badge on the bottom left corner of the icon. Not implementing this function means that no badge will be displayed.
getCaption (function (actionPayload: ActionPayload): TranslationPayload?) : Returns the caption of the action. Defaults to 'errors.noCaption'.
getIconSrcKey (function (actionPayload: ActionPayload): string?) : Returns the icon key for the action. Default to having no icon.
isAvailable (function (actionPayload: ActionPayload): boolean?) : Returns whether the action should be present in the UI. This can be used to hide actions dynamically based on the conditions in which it is used. Defaults to true.
isDisabled (function (actionPayload: ActionPayload): boolean?) : Returns whether the action should be disabled if present. This comes on top of isAvailable in order to still display the action but in a disabled mode. Defaults to false.
load (function (actionPayload: ActionPayload): void?) : Called when the action is loaded in the UI.
unload (function (actionPayload: ActionPayload): void?) : Called when the action is unloaded from the UI.

ActionImplementationStaticProperties

ActionImplementationStaticProperties

Type: Object

ActionPayload

ActionPayload

Type: (DockActionPayload | ChartHandlerActionPayload | FeaturedValuesHandlerActionPayload | StandaloneActionPayload | TabularHandlerActionPayload | TreeHandlerActionPayload)

ActionSituation

ActionSituation

Type: ("chart-handler" | "dock-action" | "featured-values-handler" | "standalone" | "tabular-handler" | "tree-handler")

ActiveFilter

ActiveFilter

Type: Object

Properties
key (string) : the key of the originating filter.
hierarchy (HierarchyUniqueName) : the hierarchy of the cube of the query on which this filter applies.
value (FilterValueType) : the value of the filter.

ActiveMonitorAgent

Agent registered to an ActiveMonitor Server

ActiveMonitorAgent

Type: Object

Properties
id (number) : agent id
agentName (string) : name of an agent
agentType (string) : type of an agent
sites (Array<string>) : sites an agent considers
connectionDetails (ActiveMonitorAgentConnectionDetails) : details about agent connection

ActiveMonitorAgentConnectionDetails

Details about connection to an agent

ActiveMonitorAgentConnectionDetails

Type: Object

Properties
url (Url) : url to reach the agent

ActiveMonitorAgentMap

Map Site to agent

ActiveMonitorAgentMap

Type: Object<string, ActiveMonitorAgent>

ActiveMonitorAlert

Alert received from an ActiveMonitor websocket.

ActiveMonitorAlert

Type: Object

Properties
content (string)
eventId (number)
monitorId (number)
site (string)
start (number)
stop (number)

ActiveMonitorAlertId

ActiveMonitorAlertId

Type: number

ActiveMonitorEvent

Event received from ActiveMonitor Server.

ActiveMonitorEvent

Type: Object

Properties
id (number) : event id
monitorId (number) : id of the monitor owning the event
site (string) : site of the monitor
timestamp (Timestamp) : datetime of the event
updatedResource (ActiveMonitorResource) : resource concerned by the event
states (Array<ActiveMonitorState>) : data state at the time of the event
status (number)

ActiveMonitorMessage

A message received from ActiveMonitor websocket.

ActiveMonitorMessage

Type: Object

Properties
id (number)
read (boolean)
sender (string)
time (Timestamp)
title (string)
type (string)

ActiveMonitorMessageAnswerContent

ActiveMonitorMessageAnswerContent

Type: Object

ActiveMonitorMessageContent

Content of an ActiveMonitorMessage.

ActiveMonitorMessageContent

Type: Object

Properties
formFields (Array<any>) : example: [{ "id":"comment", "name":"Comment", "type":{ "name":"text", "informations":{}, "value":"Comment" }, "required":false, "hidden":false, "writable":true }]
candidates (Array<string>)
category (string)
description (string)
id (number)
name (string)
priority (number)

ActiveMonitorMessageId

ActiveMonitorMessageId

Type: (number | string | {id: (number | string)})

ActiveMonitorMessagesActionParameters

Display the ActiveMonitor Messages. It is displaying the number of unread messages in a badge.

ActiveMonitorMessagesActionParameters

Type: Object

Properties
passedConfig.itemsType ("messages")
passedConfig.readOnMessageOpening (boolean?)
passedConfig.serverUrl (Url)
passedConfig ({itemsType: "messages", readOnMessageOpening: boolean?, serverUrl: Url})
Example
{
  key: 'activemonitor-messages',
  args: {
    passedConfig.itemsType: /* "messages" */,
    passedConfig.readOnMessageOpening: /* boolean= */,
    passedConfig.serverUrl: /* Url */,
    passedConfig: /* {itemsType: "messages", readOnMessageOpening: boolean=, serverUrl: Url} */
  }
}

ActiveMonitorPeriod

String can be a timestamp or "now"

ActiveMonitorPeriod

Type: ("now" | string)

ActiveMonitorResource

Representation of a resource as seen by ActiveMonitor. For event coming from ActivePivot, keys are level unique names and values member unique names.

ActiveMonitorResource

Type: Object

ActiveMonitorServer

ActiveMonitorServer

Type: (Server & Object)

Properties
agents (AgentsApi)
alerts (AlertsApi)
messages (MessagesApi)
monitors (MonitorsApi)
parameters (ParametersApi)
workflows (WorkflowsApi)

ActiveMonitorServerParameters

ActiveMonitorServerParameters

Type: SavedServerParameters

ActiveMonitorState

ActiveMonitorState

Type: Object

Properties
id (string) : id of a datum
caption (string) : caption of a datum
value (number) : value of a datum
formattedValue (string) : caption of a datum value

ActivePivotConfiguration

ActivePivotConfiguration

Type: Object

Properties
createKpi (function (cubeName: string, kpiDefinition: KpiDefinition, permissions: Permissions): Promise<void>)
deleteKpi (function (cubeName: string, kpiName: string): Promise<void>)
executeDefinitionStatement (function (definition: MdxDefinition): Promise<void>)
getKpi (function (cubeName: string, kpiName: string): Promise<KpiDefinition>)
updateKpi (function (cubeName: string, kpiDefinition: KpiDefinition, permissions: Permissions): Promise<void>)

ActivePivotServer

Handle all the communications with an ActivePivot Server.

ActivePivotServer

Type: (Server & Object)

Properties
createDrillthroughQuery (function (mdx: Mdx, context: MdxContextValues, transformers: Array<Transformer>, additionalUpdateMode: UpdateMode): MdxQuery) : Creates an MdxQuery with a DRILLTHROUGH statement.
createSelectQuery (function (mdx: Mdx, context: MdxContextValues, transformers: Array<Transformer>, additionalUpdateMode: UpdateMode, refreshInterval: number, ranges: RangesConfiguration): MdxQuery) : Creates an MdxQuery with a SELECT statement.
createSelectQueryFromCube (function (cubeName: CubeName, context: MdxContextValues, transformers: Array<Transformer>, additionalUpdateMode: UpdateMode, refreshInterval: number, ranges: RangesConfiguration): MdxQuery) : Create a simple MdxQuery with a SELECT statement.
areMultiplePermissionsSupported (function (): Promise<boolean>)
configuration (ActivePivotConfiguration)
executeRawMdx (function (MdxQueryPayload): Promise<CellSet>)
getActiveMonitorServer (function (): (ActiveMonitorServer | void))
getContentServer (function (): (ContentServer | void))
getDiscovery (function (): DiscoveryCache)
memberCaptionProvider (MemberCaptionProvider)
queryDiscovery (function (): Promise<Discovery>)
refreshDiscovery (function (): Promise<Discovery>)

ActivePivotServerParameters

ActivePivotServerParameters

Type: (SavedServerParameters & Object)

Properties
activeMonitorServer (ActiveMonitorServer?)
contentServer (ContentServer?)

ActiveUI

ActiveUI

Type: Object

Properties
about (AboutApi)
data (DataApi)
dragAndDrop (DragAndDropApi)
getBookmarksApi (function (contentServerUrl: Url): BookmarksApi)
mdx (MdxApi)
queries (QueriesApi)
settings (SettingsManager)
theming (Theming)
widgets (WidgetsApi)

ActiveUIConsumer

A component to consume an instance of ActiveUI that is provided higher up in the component tree.

ActiveUIConsumer

Type: React.ComponentType<{children: function (activeUI: ActiveUI): React.Node}>

ActiveUIContext

The raw context used by ActiveUI.

ActiveUIContext

Type: Object

Properties
Consumer (React.ComponentType<{children: function (value: ActiveUI): React.Node}>)
Provider (React.ComponentType<{value: ActiveUI}>)

ActiveUIOptions

ActiveUIOptions

Type: Object

Properties
additionalLocales (Array<LocaleDescription>?) : List of locales to add to the default ones. - DEPRECATED
automaticRestoreStorageType (AutomaticRestoreStorageType?) : Type of storage used to store last state of the application and restore it at startup
contentServerRootFolderName (string?) : Custom name of the Content Server root folder.
defaultSettings (SettingsMap?) : Settings map that will be merged on top of the default one.
enableFullSizeEscapeShortcut (boolean?) : Enable exiting full-screen mode using the Escape key.
enableHistoryKeyboardShortcuts (boolean?) : Enable global undo/redo keyboard controls: Ctrl+Z/Cmd+Z for undo, Ctrl+Y/Cmd+Y or Ctrl+Shift+Z/Cmd+Shift+Z for redo
experimentalFlags (Array<string>?) : A list of experimental features to activate in ActiveUI. See the documentation for an exhaustive list of available features.
notifyUncaughtExceptions (boolean?) : Whether ActiveUI SDK should display an error notification when facing an uncaught exception, or let it propagate. Defaults to true .
plugins ({}?) : A map with plugin types as keys. Values are lists of PluginDescription s to be registered.
securityType (SerializedPlugin?) : The serialized authentication holder plugin to use. Refer to the Public Plugins page in the ActiveUI Developer documentation for a list of built-in implementations.
state (ApplicationState?) : Object that will be merged on top of the default initial state.
supportedLocales (Array<LocaleDescription>?) : List of the locales supported by the project.
synchronizeLocale (boolean?) : Set to false to disable server calls to synchronize locale.
fetchTranslation (FetchTranslation?)

ActiveUIProvider

A component to provide an instance of ActiveUI to child components.

ActiveUIProvider

Type: React.ComponentType<{activeUI: ActiveUI, children: React.Node}>

ActiveviamOrdinalColorScaleParameters

Color scale of size 10 created by ActiveViam with the following colors: turquoise blue, wisteria, cream can, celery, cinnabar, el salva, neon carrot, cabaret, governor bay, nepal

ActiveviamOrdinalColorScaleParameters

Type: Object

Example
{
  key: 'activeviam',
  args: {}
}

AddListener

AddListener

Type: function (listener: Listener<T>): RemoveListener

AddServerActionParameters

Opens the Add Server popup

AddServerActionParameters

Type: Object

Example
{
  key: 'add-server',
  args: {}
}

AddToFavoritesActionParameters

Adds a bookmark to the user's favorites.

AddToFavoritesActionParameters

Type: Object

Example
{
  key: 'add-to-favorites',
  args: {}
}

AddWidgetActionParameters

An action available with dashboards only, to display a popup to add widgets in a dashboard.

AddWidgetActionParameters

Type: Object

Example
{
  key: 'add-widget',
  args: {}
}

AgentsApi

AgentsApi

Type: Object

Properties
all (function (): Promise<ActiveMonitorAgentMap>) : Sends a discovery to the ActiveMonitor Server to get the available ActiveMonitor agents. Returns the promise for the discovery, with the list of agents on success
get (function (string): Promise<ActiveMonitorAgent>) : Gets an agent details given its name. Returns a promise with agent details

AlertAttributesImplementationStaticProperties

AlertAttributesImplementationStaticProperties

Type: Object

AlertsActionParameters

Display the ActiveMonitor Alerts. It is displaying the number of alerts in a badge.

AlertsActionParameters

Type: Object

Properties
passedConfig.itemsType ("alerts")
passedConfig.serverUrl (string?)
passedConfig ({itemsType: "alerts", serverUrl: string?})
Example
{
  key: 'activemonitor-alerts',
  args: {
    passedConfig.itemsType: /* "alerts" */,
    passedConfig.serverUrl: /* string= */,
    passedConfig: /* {itemsType: "alerts", serverUrl: string=} */
  }
}

AlertsApi

AlertsApi

Type: Object

Properties
all (function (AllAlertOptions): Promise<Array<ActiveMonitorAlert>>) : Gets all alerts recorded in an ActiveMonitor Server.
get (function (ActiveMonitorAlertId): Promise<ActiveMonitorAlert>) : Gets a single alert.
start (function (ActiveMonitorAlert): Promise<ActiveMonitorAlert>) : Starts a new alert. It creates it on server side. For this method, id attribute is ignored.
stop (function (ActiveMonitorAlertId): Promise<void>) : Stops an existing alert.
update (function (ActiveMonitorAlert): Promise<ActiveMonitorAlert>) : Updates an existing alert.
createFeed (function (): FeedInfo)

AllAlertOptions

AllAlertOptions

Type: Object

Properties
active (boolean?) : flag to only retrieve active alerts instead of all If not defined, all alerts are retrieved
from (ActiveMonitorPeriod) : Bottom boundary for the alert start or stop time.
to (ActiveMonitorPeriod) : Top boundary for the alert start or stop time.

AllMdxFilterSelectorParameters

Matches any filter

AllMdxFilterSelectorParameters

Type: Object

Example
{
  key: 'all',
  args: {}
}

AlphabeticalHeaderComparatorParameters

Sorts headers alphabetically.

AlphabeticalHeaderComparatorParameters

Type: Object

Example
{
  key: 'alphabetical',
  args: {}
}

AlternatePalette

Alternate colors are generated automatically by a shift of Hue in the HSL coordinates from the accent1Color and are then declined in shades.

This palette can be derived from the CorePalette and the ShadePalette.

AlternatePalette

Type: Object

Properties
alternateA1AccentColor (Color)
alternateA2AccentColor (Color)
alternateA3AccentColor (Color)
alternateB1AccentColor (Color)
alternateB2AccentColor (Color)
alternateB3AccentColor (Color)
alternateTextColor (Color)

AnyEvent

AnyEvent

Type: (SyntheticKeyboardEvent<> | SyntheticMouseEvent<> | SyntheticWheelEvent<>)

ApplicationState

Data structure used to configure the application at startup

ApplicationState

Type: Object

Properties
data.settings (SettingsMap?)
data ({settings: SettingsMap?}?)
environment.i18n.locales (Array<LocaleDescription>?)
environment.i18n.server.synchronize (boolean?)
environment.i18n.server ({synchronize: boolean?}?)
environment.i18n ({locales: Array<LocaleDescription>?, server: {synchronize: boolean?}?}?)
environment.security.type (SerializedPlugin?)
environment.security ({type: SerializedPlugin?}?)
environment.servers.contentServer.rootFolderName (string?)
environment.servers.contentServer ({rootFolderName: string?}?)
environment.servers ({contentServer: {rootFolderName: string?}?}?)
environment ({i18n: {locales: Array<LocaleDescription>?, server: {synchronize: boolean?}?}?, security: {type: SerializedPlugin?}?, servers: {contentServer: {rootFolderName: string?}?}?}?)

ApplicationStatus

ApplicationStatus

Type: ("RUNNING" | "OS_RUNNING" | "OS_STARTING" | "STOPPING" | "STOPPED" | "HALF_STOPPING" | "HALF_STOPPED" | "DELETING" | "DELETED" | "UNKNOWN")

ApproximateFormatterParameters

Formats axis tick labels into k/M/B notation. e.g. 1000 -> 1k

ApproximateFormatterParameters

Type: Object

Properties
decimal (number) : number of decimal points to include in the formatted number. Integers will have x number of 0's appended. e.g. decimal(2) 1000 -> 1.00k
negative (string) : if equal to "parentheses", negative numbers are displayed in parentheses. -1000 -> (1k) Otherwise negative numbers are displayed with a minus.
prefix (string) : string to prepend to tick label.
suffix (string) : string to append to tick label.
Example
{
  key: 'thousands',
  args: {
    decimal: /* number */,
    negative: /* string */,
    prefix: /* string */,
    suffix: /* string */
  }
}

ArgumentTypeValue

ArgumentTypeValue

Type: ("PLACE_HOLDER" | "SCALAR" | "KEYWORD" | "STRING")

Properties
PLACE_HOLDER (string) : Any semantically meaningful missing argument, for example the empty space in DrillDownLevel(Set_Expression,,Index)
SCALAR (string) : boolean, int, double, date, …
KEYWORD (string) : function keyword
STRING (string) : string (means will be surrounded by single quotes)

AsPercentage

Defaults to true, as the position of the popup is usually converted in percentage to adjust with window resizing. If a popup needs to really stay at the event pixels it should provide a false value to this parameter.

AsPercentage

Type: boolean

AuditTimeInfo

AuditTimeInfo

Type: Object

Properties
id (number)
timestamp (Timestamp)
username (Username?)

AugmentedActiveFilter

Represent a filter that impacts a MDX statement.

AugmentedActiveFilter

Type: (ActiveFilter & Object)

Properties
selector (any) : the selector pointing at this active filter.
index (number)
node (MdxNode)
remove (function (): SelectNode?)
setValue (function (FilterValueType): SelectNode)
source (FilterSource)

AuthenticationHolder

AuthenticationHolder

Type: SerializablePluginImplementation<AuthenticationHolderFactoryProperties>

AuthenticationHolderImplementationProperties

Exposes the authentication API that every part of ActiveUI requiring authentication can consume.

AuthenticationHolderImplementationProperties

Type: Object

Properties
getRequestOptions (function (url: Url): Promise<RequestOptions>?) : Resolves to the request options to use for each authenticated calls.
getSortedRoles (function (): SortedRoles) : Returns the roles of the currently logged in user.
getUsername (function (): Username?) : Returns the name of the currently logged in user.
invalidate (function (usedParameters: RequestOptions): Promise<void>?) : Called with the fetch parameters used in the request that was rejected by the server. The holder should try to get a new value either from the user or from a broker.
logout (function (keepLogin: boolean): Promise<void>) : Indicate that the user has logged out. If keepLogin is true , ActiveUI will remember the name of the user and autofill it in the login popup of the next session.

AuthenticationHolderImplementationStaticProperties

AuthenticationHolderImplementationStaticProperties

Type: Object

Properties
isSingleSignOn (boolean?) : True means that there is no need to logout from the servers .ActiveUI is connected to.

AutomaticRestoreOptions

If you turn on this feature, we advise you also provide the reset-to-default-view action.

AutomaticRestoreOptions

Type: Object

Properties
key (string) : The suffix of the key that will be used to store the initial value of the container.
promptBeforeRestore (boolean?) : When true , prompt the user to confirm restoring the initial value.

AutomaticRestoreStorage

AutomaticRestoreStorage

Type: MapStorage

AutomaticRestoreStorageType

AutomaticRestoreStorageType

Type: ("html5-local-storage" | "html5-session-storage")

AxisNode

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

AxisNode

Type: Object

Properties
elementType ("Axis")
expression (ExpressionNode)
name (string)
nonEmpty (boolean)
properties (Array<Todo>)

BasicAuthenticationHolderParameters

Resend Basic authentication for each REST call and uses cookies for WebSockets. Do not store any credentials. Will be asked again on reload.

BasicAuthenticationHolderParameters

Type: Object

Example
{
  key: 'basic',
  args: {}
}

BlackWhiteOrdinalColorScaleParameters

Color scale of size 2: black and white

BlackWhiteOrdinalColorScaleParameters

Type: Object

Example
{
  key: 'black-white',
  args: {}
}

BoldTotalRowStyleParameters

Uses bold font if the row corresponds to a parent aggregate.

BoldTotalRowStyleParameters

Type: Object

Example
{
  key: 'bold-total',
  args: {}
}

Bookmark

Bookmark

Type: Object

Properties
content (BookmarkContent)
i18n (BookmarkI18n?)
writable (boolean?)

BookmarkCategory

The type of bookmark.

BookmarkCategory

Type: ("folder" | "mdx" | "container")

BookmarkContent

BookmarkContent

Type: Object

Properties
description (string?)
name (BookmarkName)
value (any)

BookmarkDescription

BookmarkDescription

Type: (BookmarkContent & Object)

Properties
contentServerUrl (Url)
id (BookmarkId)
path (BookmarkPath)
pathCaption (string?)
writable (boolean?)

BookmarkI18n

BookmarkI18n

Type: Object<Locale, Bookmark>

BookmarkId

BookmarkId

Type: string

BookmarkMetaData

BookmarkMetaData

Type: Object

Properties
id (BookmarkId)
path (BookmarkPath)

BookmarkName

BookmarkName

Type: string

BookmarkPath

The file path to the bookmark on the content server.

BookmarkPath

Type: string

BookmarksApi

BookmarksApi

Type: Object

Properties
create (function (bookmark: Bookmark, parentPath: string, owners: PermissionGroups, readers: PermissionGroups): Promise<BookmarkMetaData>) : Create a bookmark. If owners/readers are unspecified, they default to an array containing the current username as single element.
delete (function (id: BookmarkId, path: BookmarkPath): Promise<void>) : Delete the bookmark identified by its BookmarkId and path.
findBookmark (function (predicate: function (BookmarkDescription): boolean): Promise<BookmarkDescription>) : Returns the first bookmark that matches a predicate, where the predicate takes as parameter a bookmark and returns a boolean.
findBookmarkIdByName (function (name: BookmarkName): Promise<BookmarkId>) : This function will iterate through the bookmarks and return the first bookmark id matching name .
getBookmark (function (id: BookmarkId): Promise<BookmarkDescription>) : Retrieve a bookmark identified by its BookmarkId .
getAllBookmarks (function (): Promise<Array<BookmarkDescription>>)

BookmarksManager

BookmarksManager

Type: Object

Properties
createBookmark (function (bookmark: Bookmark, parentPath: BookmarkPath, owners: PermissionGroups, readers: PermissionGroups): Promise<BookmarkMetaData>)
deleteBookmark (function (id: BookmarkId, path: BookmarkPath): Promise<void>)
deleteFolder (function (id: BookmarkId, path: BookmarkPath): Promise<void>)
editBookmark (function (id: BookmarkId, pathOrParentPath: BookmarkPath, updatedParentPath: string, content: Bookmark, owners: PermissionGroups, readers: PermissionGroups): Promise<BookmarkMetaData>)
findBookmarkPath (function (id: BookmarkId): Promise<string>)
getBookmark (function (id: BookmarkId): Promise<BookmarkDescription>)
getBookmarkContentFile (function (id: BookmarkId): Promise<ContentCSFile>)
getBookmarkI18nFile (function (id: BookmarkId): Promise<I18nCSFile>)
getBookmarkList (function (filterFn: function (ContentCSFile): boolean): Array<BookmarkDescription>)
getBookmarkStructureFile (function (path: BookmarkPath): Promise<StructureCSFile>)
getCurrentBookmarkContentFile (function (id: BookmarkId): (ContentCSFile | void))
getCurrentBookmarkI18nFile (function (id: BookmarkId): (I18nCSFile | void))
getCurrentBookmarkStructureFile (function (path: BookmarkPath): (StructureCSFile | RootStructureCSFile | void))
getEffectiveOwners (function (id: BookmarkId): PermissionGroups)
getEffectiveReaders (function (id: BookmarkId): PermissionGroups)
getNormalizedBookmark (function (bookmarkContentFile: ContentCSFile, bookmarkI18nFile: I18nCSFile, bookmarkStructureFile: StructureCSFile, id: BookmarkId): BookmarkDescription)
getStatus (function (): CacheStatus)
getTimestamp (function (): (number | void))
onBookmarksAvailable (function (): Promise<void>)
syncExists (function (id: BookmarkId): boolean)

BuiltInContainerCategory

The categories used by built-in containers.

BuiltInContainerCategory

Type: ("activemonitor" | "data" | "misc" | "query")

CachedQuerier

CachedQuerier

Type: Object

Properties
addListener (function (function (CacheStatus, T): void, boolean?): RemoveListener) : Add a listener callback, called with the status and the data when one of these two changes. The second argument indicates if the data should be fetched directly after calling this function, if not already loaded.
get (function (): Promise<T>)
getCurrent (function (): T)
getStatus (function (): CacheStatus)
refresh (function (): Promise<T>)

CacheStatus

CacheStatus

Type: ("notLoaded" | "loading" | "loaded" | "loadingFailed")

CanOverlayDisplayPayload

CanOverlayDisplayPayload

Type: Object

Properties
configuration (any) : The chart configuration, as written in its state.
data (Table) : The data received by the chart, as a Table.

CaptionCellRendererParameters

Render the caption contained in the cell.

CaptionCellRendererParameters

Type: Object

Example
{
  key: 'caption-renderer',
  args: {}
}

CaseExpressionNode

An MdxNode representing a CASE statement.

CaseExpressionNode

Type: Object

Properties
elementType ("CaseExpression")
elseExp (ExpressionNode)
match (ExpressionNode)

Catalog

Catalog

Type: Object

Properties
cubes (Array<Cube>)
name (CatalogName)

CatalogName

CatalogName

Type: string

CellEditorImplementationProperties

A cell editor that can be added in a table.

CellEditorImplementationProperties

Type: Object

Properties
isEditable (function (rowIndex: number, columnKey: string, data: Table, dataSource: DataSource, columnProps: TabularColumnProps): boolean) : called on every cell marked as 'edited' to know if the editor should be rendered or not.
renderEditor (function ({colKey: number, columnProps: TabularColumnProps, rowIdx: number}): React.Element<any>) : called on every cell for which isEditable has returned true.

CellEditorImplementationStaticProperties

CellEditorImplementationStaticProperties

Type: Object

CellFactoryImplementationProperties

Performs a manipulation on the columns of a table, for example to render several columns as one.

CellFactoryImplementationProperties

Type: Object

Properties
getColumnProps (function (columnProps: TabularColumnProps, columnInstance: any): any?) : A way to enrich the columnProps with a calculation that will only be run once for the whole column.
getRowHeight (function (rowIndex: number, minRowHeight: number, columnProps: TabularColumnProps): number?) : The specific row height, only called if hasCustomRowHeight returns true.
hasCustomRowHeight (function (): boolean?) : Whether the cell needs a higher height.
renderCell (function ({colKey: number, columnProps: TabularColumnProps, rowIdx: number}): React.Element<any>)
replaceCells (function (): boolean?) : Whether the original cells should be replaced or not. Defaults to true.
getDefaultOptions (function (): any?)

CellFactoryImplementationStaticProperties

CellFactoryImplementationStaticProperties

Type: Object

CellPosition

CellPosition

Type: Object

Properties
columnIndex (number) : the index of the column to which the described cell belongs.
rowIndex (number) : the index of the row to which the described cell belongs.

CellRendererImplementationProperties

Change the rendering of cells in a table.

CellRendererImplementationProperties

Type: Object

Properties
getCellStyle (function (rowIndex: number, columnProps: TabularColumnProps): {}?) : assign a CSS style to the cell. This style will be merged with the default style.
isAvailable (function ({colKey: number, columnProps: TabularColumnProps, rowIdx: number}): boolean?) : decide if the other methods of the plugin should be called (applies to getCellStyle AND renderCell). Returns true by default.
renderCell (function ({colKey: number, columnProps: TabularColumnProps, onCellRef: function (HTMLElement?): {}, rowIdx: number}): React.Element<any>) : render the content of the cell.

CellRendererImplementationStaticProperties

CellRendererImplementationStaticProperties

Type: Object

CellSet

CellSet

Type: Object

Properties
axes (Array<CellSetAxis>)
cells (Array<CellSetCell>)
cube (CubeName)
defaultMembers (Array<DefaultCellSetMember>)
epoch (number)

CellSetAxis

CellSetAxis

Type: Object

Properties
hierarchies (Array<HierarchyCoordinates>)
id (number)
maxLevelPerHierarchy (MaxLevelPerHierarchy)
positions (Array<Array<CellSetMember>>)

CellSetCell

CellSetCell

Type: Object

Properties
formattedValue (string)
ordinal (number)
properties (CellSetProperties)
value ((number | string))

CellSetMember

CellSetMember

Type: Object

Properties
captionPath (Array<string>)
namePath (Array<string>)
properties (CellSetProperties)

CellSetProperties

CellSetProperties

Type: Object<string, (null | string | number)>

ChartConfiguration

ChartConfiguration

Type: Todo

ChartElementStylerImplementationProperties

Merges the ouput style on top of the current style.

ChartElementStylerImplementationProperties

Type: Object

Properties
getStyle (Function) : function returning a style that will be merged on top of the input 'currentStyle'. This style will be applied to the chart element corresponding to the input data tuple.

ChartElementStylerImplementationStaticProperties

ChartElementStylerImplementationStaticProperties

Type: Object

ChartHandlerActionPayload

ChartHandlerActionPayload

Type: Object

Properties
comboChartUnderlyingMeasure (TableHeader?) : The measure associated with the chart node that is being hovered on. Only returns defined if the chart is a combo chart. Otherwise it will return undefined.
datum (TableTuple?) : The data associated to the element on which the action has been called. Is not defined when the user clicks in the background of the chart.
layerApi (WidgetApi) : The api for the layer that has been interacted with. If the interaction happened with the chart background, it points to the api of the first layer.
actionSituation ("chart-handler")
widgetApi (WidgetApi)

ChartOverlayImplementationProperties

Display an overlay over a chart.

ChartOverlayImplementationProperties

Type: Object

Properties
getCustomizableParameters (function (): Array<OverlayCustomizableParameter>) : These parameters will generate controls in the UI for the user to configure the overlay.
getDescription (function (): React.Element<any>) : The description of the overlay as React elements, to display a small summary of it.
render (function (renderOverlayPayload: RenderOverlayPayload): void) : The code ran by this method should render the overlay inside of the provided d3 selection.

ChartOverlayImplementationStaticProperties

ChartOverlayImplementationStaticProperties

Type: Object

Properties
canDisplay (function (canOverlayDisplayPayload: CanOverlayDisplayPayload): boolean) : Whether the overlay can be displayed on the current chart. This is used to filter the overlays that can be added by the user through the UI.

ChartPngExportActionParameters

An action to export the chart as a png.

ChartPngExportActionParameters

Type: Object

Properties
rasterizationCallback (function (): void) : An internal function registered in-memory, making this plugin tied to the specific chart workflow. This plugin is not usable out of the context built by the SDK.
Example
{
  key: 'chart-png-export',
  args: {
    rasterizationCallback: /* function (): void */
  }
}

ChartSelection

ChartSelection

Type: Array<string>

ChartSelectionHandlerImplementationProperties

Lets projects interact with the core chart selection.

ChartSelectionHandlerImplementationProperties

Type: Object

Properties
onChange (function (selection: ChartSelection, layerApi: WidgetApi, widgetApi: WidgetApi): void?) : Is called back each time the selection changes.
transform (function (selection: ChartSelection, layerApi: WidgetApi, widgetApi: WidgetApi): ChartSelection?) : Lets you apply a custom selection on the fly, instead of the default one. Note that returning undefined will cancel the selection.

ChartSelectionHandlerImplementationStaticProperties

ChartSelectionHandlerImplementationStaticProperties

Type: Object

ChartShowDataActionParameters

An action to display the data of the chart as a table.

ChartShowDataActionParameters

Type: Object

Example
{
  key: 'chart-show-data',
  args: {}
}

ChartTimeFormatterImplementationProperties

Format date/time members on chart axis

ChartTimeFormatterImplementationProperties

Type: Object

Properties
getFormatters (function (d3: D3Api, translator: Translator): Array<Formatter>)

ChartTimeFormatterImplementationStaticProperties

ChartTimeFormatterImplementationStaticProperties

Type: Object

ChartTooltipShowActionParameters

Display a tooltip for the chart widget.

ChartTooltipShowActionParameters

Type: Object

Properties
timeout (number) : The timeout after which the tooltip should appear.
Example
{
  key: 'chart-tooltip-show',
  args: {
    timeout: /* number */
  }
}

ChooseableFormatterImplementationStaticProperties

ChooseableFormatterImplementationStaticProperties

Type: Object

Properties
defaultParameters ({}?)
example.caption (string?)
example.value ((string | number))
example ({caption: string?, value: (string | number)})
isChoosableFromUI (true)

ClearDockActionParameters

Unload the current bookmark from the dock (or in other terms, clear the dock).

ClearDockActionParameters

Type: Object

Example
{
  key: 'clear-dock',
  args: {}
}

ClosePopup

ClosePopup()

Type: Function

CloudApplication

CloudApplication

Type: Object

Properties
getAccessLevel (function (): string)
getName (function (): string)
getPortalServerUrl (function (): Url)
getStatus (function (): ApplicationStatus)
getUrl (function (): Url)

Color

A CSS valid color: RGB(r,g,b), #hexa, colorName...

Color

Type: string

ColorAlternateRowStyleParameters

Uses the tabularAlternatingRowColor as a background on even-indexed rows.

ColorAlternateRowStyleParameters

Type: Object

Example
{
  key: 'color-alternate',
  args: {}
}

ColumnMergeHeaderCaptionProducerParameters

A caption producer that merges headers together, separated with a '/', like 'Desk / Currency'

ColumnMergeHeaderCaptionProducerParameters

Type: Object

Example
{
  key: 'columnMerge',
  args: {}
}

ColumnsSelectorImplementationProperties

A column selector, used for grouping table columns.

ColumnsSelectorImplementationProperties

Type: Object

Properties
select (function (headers: Array<TableHeader>, hiddenColumnsNames: Array<string>, dataSource: DataSource): Array<{key: string, selection: Array<TableHeader>}>) : Create one or several groups of columns, with a key for the group.

ColumnsSelectorImplementationStaticProperties

ColumnsSelectorImplementationStaticProperties

Type: Object

ComponentPalette

Contains colors used by ActiveUI components.

This palette can be derived from the CorePalette, the ShadePalette and the AlternatePalette.

ComponentPalette

Type: Object

Properties
actionButtonBadgeBackgroundColor (Color)
actionButtonBadgeTextColor (Color)
activeMonitor.activity.down (Color)
activeMonitor.activity.dying (Color)
activeMonitor.activity.up (Color)
activeMonitor.activity ({down: Color, dying: Color, up: Color})
activeMonitor ({activity: {down: Color, dying: Color, up: Color}})
activeMonitorAlertBoxShadowColor (Color)
activeMonitorMessageBoxShadowColor (Color)
alternateButtonColor (Color)
antd.background-color-base (Color)
antd.background-color-light (Color)
antd.body-background (Color)
antd.border-color-base (Color)
antd.border-color-split (Color)
antd.btn-default-bg (Color)
antd.btn-primary-color (Color)
antd.component-background (Color)
antd.disabled-bg (Color)
antd.disabled-color-dark (Color)
antd.disabled-color (Color)
antd.error-color (Color)
antd.heading-color (Color)
antd.highlight-color (Color)
antd.info-color (Color)
antd.input-bg (Color)
antd.layout-header-background (Color)
antd.primary-1 (Color)
antd.primary-color (Color)
antd.success-color (Color)
antd.text-color-secondary (Color)
antd.text-color (Color)
antd.warning-color (Color)
antd ({background-color-base: Color, background-color-light: Color, body-background: Color, border-color-base: Color, border-color-split: Color, btn-default-bg: Color, btn-primary-color: Color, component-background: Color, disabled-bg: Color, disabled-color-dark: Color, disabled-color: Color, error-color: Color, heading-color: Color, highlight-color: Color, info-color: Color, input-bg: Color, layout-header-background: Color, primary-1: Color, primary-color: Color, success-color: Color, text-color-secondary: Color, text-color: Color, warning-color: Color})
bookmarkButtonBadgeBackgroundColor (Color)
bookmarkButtonBadgeTextColor (Color)
bookmarkButtonCanvasColorOverride (Color)
bookmarkButtonForeColorOverride (Color)
bookmarkButtonPrimaryColorOverride (Color)
calendarDisabledDayBgColor (Color)
calendarDisabledDayTextColor (Color)
calendarDisabledSelectedDayBgColor (Color)
calendarGridLinesColor (Color)
calendarSelectedDayBgColor (Color)
calendarSelectedDayTextColor (Color)
calendarStandardTextColor (Color)
calendarTodayTextColor (Color)
calendarWeekdayTextColor (Color)
cellStyleConditionBackgroundColor (Color)
cellStyleConditionTextColor (Color)
cellStyleFlagsBackgroundColor (Color)
cellStyleMeasureTextColor (Color)
cellStyleSampleBackgroundColor (Color)
cellStyleToggleActiveBackgroundColor (Color)
cellStyleToggleActiveBorderColor (Color)
cellStyleToggleActiveBoxShadowColor (Color)
chartAddMappingDropHelperBackgroundColor (Color)
chartAttribute.color (Color)
chartAttribute.histogramBackgroundColor (Color)
chartAttribute.histogramStrokeColor (Color)
chartAttribute.lineColor (Color)
chartAttribute.lineTextColor (Color)
chartAttribute.pointColor (Color)
chartAttribute.pointStrokeColor (Color)
chartAttribute.splitHoverBackgroundColor (Color)
chartAttribute.strokeColor (Color)
chartAttribute.textColor (Color)
chartAttribute.textColorPrimary (Color)
chartAttribute ({color: Color, histogramBackgroundColor: Color, histogramStrokeColor: Color, lineColor: Color, lineTextColor: Color, pointColor: Color, pointStrokeColor: Color, splitHoverBackgroundColor: Color, strokeColor: Color, textColor: Color, textColorPrimary: Color})
chartAxisLineColor (Color)
chartAxisTextColor (Color)
chartGridStrokeColor (Color)
chartLayerColor (Color)
chartLegendColor (Color)
chartLegendDropHeaderBackgroundColor (Color)
chartMainLegendBlockBackgroundColor (Color)
chartMainLegendBlockTextColor (Color)
chartMainLegendHeaderBorderBottomColor (Color)
chartMappingActionsTextColor (Color)
chartMappingLabelTextColor (Color)
chartMissingMappingBackgroundColor (Color)
chartRegressionOverlayHelperColor (Color)
chartRegressionOverlayLineColor (Color)
chartTooltipBackgroundColor (Color)
chartTooltipKeyTextColor (Color)
chartTooltipTextColor (Color)
checkboxReadOnlyTextColor (Color)
codeMirrorNotValid (Color)
colorPickerBorderColor (Color)
colorPickerHoverBorderColor (Color)
commonBackgroundColor (Color)
commonTextColor (Color)
containerBodyTextColor (Color)
containerHeadBackgroundColor (Color)
containerHeadBorderBottomColor (Color)
containerHeadTitleTextColor (Color)
containerHoverBoxShadowColor (Color)
containerHoverSelectedBoxShadowColor (Color)
containerLoadErrorBackgroundColor (Color)
containerLoadErrorTextColor (Color)
containerRootBackgroundColor (Color)
containerSelectedBoxShadowColor (Color)
createKpiLabelActiveTextColor (Color)
createKpiLabelDisabledTextColor (Color)
dashboardContainerBackgroundColor (Color)
dashboardEditPopupBackgroundColor (Color)
dashboardEditPopupCancelBackgroundColor (Color)
dashboardEditPopupCancelBorderColor (Color)
dashboardHeadBackgroundColor (Color)
dashboardHeadTitleTextColor (Color)
dialogBackgroundColor (Color)
dropDownMenuCanvasColor (Color)
dropDownMenuSvgColor (Color)
dropDownMenuTextColor (Color)
editableListAccordionBackgroundColor (Color)
editableListAccordionBorderColor (Color)
editableListAddButtonLabelTextColor (Color)
editableListToggleActiveBackgroundColor (Color)
editableListToggleActiveBorderColor (Color)
editableListToggleActiveBoxShadowColor (Color)
editorBackgroundColor (Color)
editorDisabledBackgroundColor (Color)
editorDisabledTextColor (Color)
editorTextColor (Color)
embeddedFiltersBackgroundColor (Color)
emptyDockIconBackgroundColor (Color)
emptyDockTileBackgroundColor (Color)
emptyDockTileHighlightBackgroundColor (Color)
emptyDockTileSectionBackgroundColor (Color)
emptyDockTileSmallerSectionBgColor (Color)
errorBodyBackgroundColor (Color)
errorBorderColor (Color)
errorColor (Color)
errorTitleBackgroundColor (Color)
featuredValuesTextColor (Color)
fieldSetBackgroundColor (Color)
fieldSetHoverBackgroundColor (Color)
helperContainerBackgroundColor (Color)
iconPrimaryColor (Color)
inboxHeaderBgColor (Color)
inboxHeaderTextColor (Color)
kpiBreach (Color)
kpiGood (Color)
kpiRange.breach (Color)
kpiRange.good (Color)
kpiRange.lessGood (Color)
kpiRange.nearBreach (Color)
kpiRange.warning (Color)
kpiRange ({breach: Color, good: Color, lessGood: Color, nearBreach: Color, warning: Color})
kpiWarning (Color)
mappingDialogHeaderTitleTextColor (Color)
materialuiPaperBackgroundColor (Color)
mdxBlocks.compoundIdentifier (Color)
mdxBlocks.filter (Color)
mdxBlocks.function (Color)
mdxBlocks.level (Color)
mdxBlocks.measure (Color)
mdxBlocks.select.backgroundColor (Color)
mdxBlocks.select.color (Color)
mdxBlocks.select.section.backgroundColor (Color)
mdxBlocks.select.section.borderColor (Color)
mdxBlocks.select.section.color (Color)
mdxBlocks.select.section ({backgroundColor: Color, borderColor: Color, color: Color})
mdxBlocks.select ({backgroundColor: Color, color: Color, section: {backgroundColor: Color, borderColor: Color, color: Color}})
mdxBlocks ({compoundIdentifier: Color, filter: Color, function: Color, level: Color, measure: Color, select: {backgroundColor: Color, color: Color, section: {backgroundColor: Color, borderColor: Color, color: Color}}})
mdxEditorPopupContextBackgroundColor (Color)
mdxWizardHeadTextColor (Color)
mdxWizardLighterTextColor (Color)
mdxWizardTileBackgroundColor (Color)
nodeChooserBackgroundColor (Color)
nodeChooserBoxShadowColor (Color)
nodeChooserQueryFieldTextHighlightColor (Color)
parameterListModifiedParameterColor (Color)
parameterListPendingParameterColor (Color)
popupCommonBackground (Color)
popupCommonBorderBottomColor (Color)
popupCommonTitleBackgroundColor (Color)
popupCommonTitleTextColor (Color)
popupModalOverlayColor (Color)
primaryButtonColor (Color)
rulesEditorHeaderBgColor (Color)
rulesEditorHeaderTextColor (Color)
rulesEditorNewRulePendingColor (Color)
rulesEditorRulePendingColor (Color)
searchPathTextColor (Color)
secondaryButtonColor (Color)
tabularAlternatingRowColor (Color)
tabularHeaderBackgroundColor (Color)
tabularHeaderBorderColor (Color)
tabularHeaderSeparatorColor (Color)
tabularHeaderTextColor (Color)
tabularPinnSeparatorBackgroundColor (Color)
tabularRowHoveredBackgroundColor (Color)
tabularSelectedCellBoxShadowColor (Color)
tabularSelectionBackgroundColor (Color)
tabularSelectionBoxShadowColor (Color)
tabularSeparatorColor (Color)
textFieldDisabledBackgroundColor (Color)
textFieldDisabledTextColor (Color)
textFieldErrorBackgroundColor (Color)
textFieldErrorTextColor (Color)
textFieldInfoBackgroundColor (Color)
textFieldInfoTextColor (Color)
textFieldRegularBackgroundColor (Color)
textFieldRegularTextColor (Color)
textFieldValidBackgroundColor (Color)
textFieldValidTextColor (Color)
textFieldWarningBackgroundColor (Color)
textFieldWarningTextColor (Color)
toolTipBackgroundColor (Color)
toolTipTextColor (Color)
treeLeafDropHighlightBackgroundColor (Color)
treeNodeCaptionDisabledTextColor (Color)
treeNodeCaptionTextColor (Color)
treeNodeHoverBackgroundColor (Color)
unusedScaleTextColor (Color)
warningBodyBackgroundColor (Color)
warningBorderColor (Color)
warningTextColor (Color)
warningTitleBackgroundColor (Color)

CompoundIdentifierNode

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

CompoundIdentifierNode

Type: (UnknownCompoundIdentifierNode | DimensionCompoundIdentifierNode | HierarchyCompoundIdentifierNode | LevelCompoundIdentifierNode | MemberCompoundIdentifierNode | NamedSetCompoundIdentifierNode)

ConditionalFormattingActionParameters

Open a popup to format the current measure.

ConditionalFormattingActionParameters

Type: Object

Example
{
  key: 'conditional-formatting',
  args: {}
}

ConfirmationPopupParameters

A popup displaying a message, and asking for confirmation from the user

ConfirmationPopupParameters

Type: Object

Properties
cancelButtonText (TranslationPayload) : the cancel button text
content (TranslationPayload) : the message content of the confirmation popup
submitButtonText (TranslationPayload) : the submit button text
submitCallBack (function (): void) : the submit callback to exexute when the submit button is clicked
title (TranslationPayload) : the title to give to the Popup

ConstantChartOverlayParameters

An overlay that displays a line of constant value. Only available on charts with an x and y axis, and with y being a numerical axis.

ConstantChartOverlayParameters

Type: Object

Properties
color (string?) : The color of the regression line.
formatter (any?) : A formatter specification understood by d3: https://github.com/d3/d3-format/blob/master/README.md#api-reference This formatter is used to format the equation coefs + r^2, and X and Y when the chart scales have no formatters.
timeFormatter (any?) : A formatter used for the time in the tooltip, from the types.chartTimeFormatter plugin
value (number?) : The value to use for the regression line. Defaults to 0.
Example
{
  key: 'constant',
  args: {
    color: /* string= */,
    formatter: /* *= */,
    timeFormatter: /* *= */,
    value: /* number= */
  }
}

ContainerBody

The body of the bookmark. This is specific to each type of container.

ContainerBody

Type: any

ContainerCategory

The category in which the container should appear. If a string not part of the BuiltInContainerCategory is given, it should be added to the project translation.

ContainerCategory

Type: (BuiltInContainerCategory | string)

ContainerChildKey

ContainerChildKey

Type: string

ContainerFullValue

ContainerFullValue

Type: Object

Properties
description (string?)
name (BookmarkName?)
type ("container"?)
value (ContainerValue<any>)
writable (boolean?)

ContainerImplementationProperties

Projects should only use ReactContainerImplementationProperties.

ContainerImplementationProperties

Type: (ReactContainerImplementationProperties | CoreContainerImplementationProperties)

ContainerImplementationStaticProperties

Projects should only use ReactContainerImplementationStaticProperties.

ContainerImplementationStaticProperties

Type: (ReactContainerImplementationStaticProperties | CoreContainerImplementationStaticProperties)

ContainerProps

For more information about the controlled/uncontrolled distinction see https://reactjs.org/docs/uncontrolled-components.html.

See also the "Container" page in the docs for the current limitations of the controlled mode.

ContainerProps

Type: Object

Properties
automaticRestore (AutomaticRestoreOptions) : Only available when the container is mounted as a root. Meaning that it cannot be used for a container rendered as a child of another container.
childKey (ContainerChildKey?) : Required when the container is rendered as a child of another container. That's the key under which the API of the child container will be in the map returned by ContainerApi#getChildrenMap .
defaultValue (ContainerFullValue?) : Value in uncontrolled mode.
onApiChange (function (WidgetApi): void?) : Called everytime the API corresponding to the underlying container changes. It will be called after the container is done loading the first time and every time the underlying container is reloaded.
onChange (function (ContainerFullValue?): void?) : Called when the value of the underlying container changes. Only called once per loop in the event-loop.
value (ContainerFullValue?) : Value in controlled mode.

ContainerStyle

ContainerStyle

Type: Object

Properties
all (Style?)
body (Style?)
head.all (Style?)
head.title (Style?)
head ({all: Style?, title: Style?}?)

ContainerValue

ContainerValue

Type: Object

Properties
body (Body?) : Specific to each container.
actions (Array<SerializedPlugin>?)
actionStrictMode (boolean?)
containerKey (string)
contentServerUrl (Url?)
quickActions (Array<SerializedPlugin>?)
showTitleBar (boolean?)
style (ContainerStyle?)

ContentCSFile

ContentCSFile

Type: CSFile<{}, BookmarkContent>

ContentServer

Expose the API to interact with a Content Server. For all calls accepting owners and readers, if no permissions are given, they will default to the current username.

ContentServer

Type: (Server & Object)

Properties
canMove (function (): boolean) : Returns a boolean indicating whether the underlying Content Server supports moving files.
createFile (function (path: ContentServerPath, content: string, owners: PermissionGroups, readers: PermissionGroups): Promise<void>) : Create a new file in the specified directory, letting the server specify its name.
deleteFile (function (path: ContentServerPath, childrenOnly: boolean): Promise<void>) : Delete the file at the given path. If the file is a directory, its content will be recursively removed. Set childrenOnly to true to only remove a directory's children but not the directory itself.
exist (function (path: ContentServerPath): Promise<void>) : Resolved if the path exists and rejected otherwise.
getFile (function (path: ContentServerPath, recursive: number, metadata: boolean): Promise<void>) : Retrieve the file found at the given path. If the file is a directory, list all its accessible children, by default recursively. recursive is the maximum depth at which to retrieve children. -1 means that all available children are retrieved, 0 means that only the directory itself is retrieved. When metadata is true , only the metadata of the entries will be retrieved. Their content will be omitted.
mkDir (function (path: ContentServerPath, owners: PermissionGroups, readers: PermissionGroups, recursive: boolean): Promise<void>) : Create an empty directory at the given path. Set recursive to true to reate the directory and its parents if they do not exist.
moveFile (function (source: ContentServerPath, destination: ContentServerPath): Promise<void>) : Move an existing file to a different location.
report (function (payload: ReportingPayload): Promise<void>) : Trigger the generation of a report. If the feature is not enabled server-side, the returned promise will be rejected.
updateFile (function (path: ContentServerPath, content: string, owners: PermissionGroups, readers: PermissionGroups, overwrite: boolean, recursive: boolean): Promise<void>) : Create a file at the given path or update an existing one. If the file already exists and no content is given, only permissions will be updated. If the file already exists and overwrite is true , the existing content will be overwritten. Set recursive to true to create a directory and its parents. If false , then the parent must exist.
updatePermissions (function (path: ContentServerPath, owners: PermissionGroups, readers: PermissionGroups): Promise<void>) : Update the permissions of the file at the given path.
areMultiplePermissionsSupported (function (): Promise<boolean>)
bookmarksManager (BookmarksManager)
jwt (function (authString: string): Promise<JwtResult>)

ContentServerParameters

ContentServerParameters

Type: (SavedServerParameters & Object)

Properties
withBookmarksManager (boolean?)
withSettingsManager (boolean?)

ContentServerPath

A sequence of sections forming the full path to a directory or file.

ContentServerPath

Type: Array<ContentServerPathSection>

ContentServerPathSection

A directory or file name.

ContentServerPathSection

Type: string

ContextMenuImplementationProperties

ContextMenuImplementationProperties

Type: Object

Properties
getItems (function (translator: Translator, deserializer: Deserializer, renderMultiBinding: MultiBinding): Array<(ContextMenuItem | "separator")>)
hasItems (function (): boolean?) : Whether the menu has items to display or not.
load (function (renderMultiBinding: MultiBinding): void?) : Called when the menu is loaded in the UI.
unload (function (renderMultiBinding: MultiBinding): void?) : Called when the menu is unloaded from the UI.

ContextMenuImplementationStaticProperties

ContextMenuImplementationStaticProperties

Type: Object

CopyTableActionParameters

Copy to clipboard the underlying table. Only available if the underlying table is fully downloaded (i.e. not lazy loaded)

CopyTableActionParameters

Type: Object

Example
{
  key: 'copy-table',
  args: {}
}

CorePalette

Main part of the palette from which all the other colors can be derived.

CorePalette

Type: Object

Properties
accent1Color (Color)
alertColor (Color)
canvasColor (Color)
infoColor (Color)
primary1Color (Color)
textColor (Color)
textPrimaryContrastColor (Color)
validColor (Color)
warningColor (Color)

CreateActiveUI

Creates an instance of ActiveUI based on the given options.

CreateActiveUI

Type: function (options: ActiveUIOptions): ActiveUI

CreateFolderActionParameters

Open a popup to create a folder under the selected node.

CreateFolderActionParameters

Type: Object

Example
{
  key: 'create-folder',
  args: {}
}

CreateKpiActionParameters

An action to open the kpi editor, with some contextual information if available.

CreateKpiActionParameters

Type: Object

Example
{
  key: 'create-kpi',
  args: {}
}

createSerializable

Creates a serializable class from a plugin implementation description.

createSerializable
Parameters
description (SerializablePluginDescription<FactoryProperties, FactoryStaticProperties, ImplementationProperties, ImplementationStaticProperties, TypeParameters, ImplementationParameters>)
Returns
SerializablePluginImplementationClass<FactoryProperties, FactoryStaticProperties, TypeParameters, ImplementationParameters>

CreateStatementNode

An MdxNode representing a CREATE statement.

CreateStatementNode

Type: Object

Properties
cubeName (CubeName)
elementType ("Create")
evaluationType (Todo)
hiddenType (Todo)
session (Todo)

CSFile

CSFile

Type: Object

Properties
children ({}?)
entry (any)

CSFileEntry

CSFileEntry

Type: Object

Properties
canRead (boolean)
canWrite (boolean)
content (Content)
isDirectory (boolean)
lastEditor (PermissionGroup)
owners (PermissionGroups)
readers (PermissionGroups)
timestamp (number)

CssProperty

CssProperty

Type: string

CssValue

CssValue

Type: (string | number)

Cube

Cube

Type: Object

Properties
caption (string)
contextValues (Array<CubeContextValue>)
defaultMembers (Array<CubeMember>)
dimensions (Array<CubeDimension>)
kpis (Array<EnrichedCubeKpi>)
measureGroups (Array<CubeMeasureGroup>)
name (CubeName)
sets (Array<CubeSet>)

CubeContextValue

CubeContextValue

Type: Object

Properties
name (string)
value (string)

CubeContextValueDefinition

CubeContextValueDefinition

Type: Object

Properties
category (string?)
description (string?)
name (string)
type (string)

CubeDimension

CubeDimension

Type: Object

Properties
caption (string)
defaultHierarchy (HierarchyName)
description (string)
hierarchies (Array<CubeHierarchy>)
measureGroups ((Array<string> | void))
name (DimensionName)
type (("REGULAR" | "TIME"))
visible (boolean)

CubeDiscovery

CubeDiscovery

Type: Object

Properties
getCube (function (): Cube)
getCubeName (function (): CubeName)
getDefaultMeasureName (function (): MeasureName)
getDefaultMemberPath (function (HierarchyCoordinates): Array<string>)
getDimensionFromHierarchyName (function (HierarchyName): CubeDimension)
getFirstInterestingLevelName (function (HierarchyUniqueName): (LevelName | void))
getHierarchy (function (DimensionName, HierarchyName): (CubeHierarchy | void))
getHierarchyByUniqueName (function (HierarchyUniqueName): (CubeHierarchy | void))
getKpi (function (string, attributeName: string): (DiscoveryKpi | void))
getLevel (function (level: LevelCoordinates): CubeLevel)
getLevelDepth (function (DimensionName, HierarchyName, LevelName): number)
getMeasure (function (MeasureName): (EnrichedCubeMeasure | void))
getUnderlyingDiscovery (function (): Discovery)
isSlicingLevel (function (DimensionName, HierarchyName, LevelName): boolean)

CubeHierarchy

CubeHierarchy

Type: Object

Properties
caption (string)
folder (string?)
levels (Array<CubeLevel>)
name (HierarchyName)
slicing (boolean)
visible (boolean)

CubeKpi

CubeKpi

Type: Object

Properties
caption (string)
description (string)
expiry ((Mdx | void))
goal ((Mdx | void))
name (KpiName)
start ((Mdx | void))
status (Mdx)
statusPresenter ("Shapes")
trend ((Mdx | void))
value (Mdx)

CubeLevel

CubeLevel

Type: Object

Properties
caption (string)
name (LevelName)
type (("ALL" | "REGULAR" | "TIME"))

CubeMeasure

CubeMeasure

Type: Object

Properties
caption (string)
expression ((Mdx | void))
folder (string)
formatString ((string | void))
measureGroup ((string | void))
name (MeasureName)
type (string)
visible (boolean)

CubeMeasureGroup

CubeMeasureGroup

Type: Object

Properties
caption (MeasureGroupName)
description (string)
name (string)

CubeMember

CubeMember

Type: Object

Properties
captionPath (Array<string>)
dimension (DimensionName)
hierarchy (HierarchyName)
path (Array<string>)

CubeName

CubeName

Type: string

CubeSet

CubeSet

Type: Object

Properties
caption (string)
description (string)
expression (Mdx)
name (SetName)

CurrencyFormatterParameters

Formats axis tick labels into currency. e.g. 1000 -> $1,000.00

CurrencyFormatterParameters

Type: Object

Properties
decimal (number) : number of decimal points to include in the formatted number. Integers will have x number of 0's appended. e.g. decimal(2) 1000 -> $1,000.00
currencyCode (string) : three letter ISO code for which currency symbol to use. Undefined by default. If undefined, will take user's locale's currency code.
negative (string) : if equal to "parentheses", negative numbers are displayed in parentheses. -1000 -> ($1,000) Otherwise negative numbers are displayed with a minus.
Example
{
  key: 'currency',
  args: {
    decimal: /* number */,
    currencyCode: /* string */,
    negative: /* string */
  }
}

D310OrdinalColorScaleParameters

Color scale of size 10 provided by D3. See https://github.com/d3/d3-scale/blob/master/README.md#schemeCategory10

D310OrdinalColorScaleParameters

Type: Object

Example
{
  key: 'd3-10',
  args: {}
}

D320BOrdinalColorScaleParameters

Color scale of size 20 provided by D3. See https://github.com/d3/d3-scale/blob/master/README.md#schemeCategory20b

D320BOrdinalColorScaleParameters

Type: Object

Example
{
  key: 'd3-20b',
  args: {}
}

D320COrdinalColorScaleParameters

Color scale of size 20 provided by D3. See https://github.com/d3/d3-scale/blob/master/README.md#schemeCategory20c

D320COrdinalColorScaleParameters

Type: Object

Example
{
  key: 'd3-20c',
  args: {}
}

D320OrdinalColorScaleParameters

Color scale of size 20 provided by D3. See https://github.com/d3/d3-scale/blob/master/README.md#schemeCategory20

D320OrdinalColorScaleParameters

Type: Object

Example
{
  key: 'd3-20',
  args: {}
}

D3Api

The D3 api. See https://github.com/d3/d3/blob/master/API.md for more details.

D3Api

Type: any

DarkCeruleanThemeParameters

Built-in dark theme.

DarkCeruleanThemeParameters

Type: Object

Example
{
  key: 'dark-cerulean',
  args: {}
}

DataApi

API entry point for all data-related features.

DataApi

Type: Object

Properties
Table (TableConversion) : Expose utility functions to convert different data structure to a Table .
dateRecognizerTransformer (Todo)
functionTransformer (Todo)
geoCoderTransformer (Todo)
getExplicitMembersInfoFromFilters (function (dataSource: DataSource, filterSelector: MdxFilterSelector): (FiltersMembersContribution | void))
getLocationInfoFromTargetCell (function (payload: TabularHandlerActionPayload, defaultMembersPolicy: DefaultMembersPolicy): LocationInfo)
getLocationsInfoFromPayload (function (payload: TabularHandlerActionPayload, defaultMembersPolicy: DefaultMembersPolicy): LocationsInfo)
getLocationsInfoFromSelection (function (discovery: Discovery, cubeName: CubeName, table: Table, selection: TableSelection, dataIdsByColumnIndex: DataIdsByColumnIndex, defaultMembersPolicy: DefaultMembersPolicy): LocationsInfo)
setDateRecognizer (function (newDateRecognizer: DateRecognizer): void)
toTable (function (headers: Array<SimpleTableHeader>, content: Array<SimpleTableTuple>): Table)

DataIdsByColumnIndex

Mapping of the form {displayed column index} => {corresponding data columns indexes}

DataIdsByColumnIndex

Type: {}

DataSourceImplementationProperties

DataSourceImplementationProperties

Type: Object

Properties
createDataSource (function (): InternalDataSource)

DataSourceImplementationStaticProperties

DataSourceImplementationStaticProperties

Type: Object

DateRecognizer

DateRecognizer

Type: Object

Properties
isDate (function (o: any): boolean)
toDate (function (str: string): Date)

DebugLoggerParameters

A logger that logs everything, and adds timestamp and the caller to each message.

DebugLoggerParameters

Type: Object

Example
{
  key: 'debug',
  args: {}
}

DebugWidgetStateActionParameters

Open a popup that displays the internal state of the widget.

DebugWidgetStateActionParameters

Type: Object

Example
{
  key: 'debug-widget-state',
  args: {}
}

DefaultCellSetMember

DefaultCellSetMember

Type: Object

Properties
captionPath (Array<string>)
dimension (DimensionName)
hierarchy (HierarchyName)
path (Array<string>)

DefaultChartSelectionHandlerParameters

Default chart selection mechanism

DefaultChartSelectionHandlerParameters

Type: Object

Example
{
  key: 'default',
  args: {}
}

DefaultChartTimeFormatterParameters

Automatically format a date based on how much details the date contains. If the date contains milliseconds, the date will be formatted in milliseconds. If the date contains seconds, the date will be formatted in seconds. If the date contains minutes, the date will be formatted in minutes. If the date contains hours, the date will be formatted in hours. If the date contains days, the date will be formatted in days. If the date contains months, the date will be formatted in month. Otherwise the date will be formatted in years.

DefaultChartTimeFormatterParameters

Type: Object

Example
{
  key: 'default',
  args: {}
}

DefaultMembersPolicy

The policy that defines whether default members should be kept in the LocationMembers mapping that characterizes a LocationInfo.

DefaultMembersPolicy

Type: ("all" | "none" | "non-trivial")

DefaultSingleValueCoordinatesParameters

Reads from the cell {row: 0, column: 0}.

DefaultSingleValueCoordinatesParameters

Type: Object

Example
{
  key: 'default',
  args: {}
}

DefaultTableSelectionHandlerParameters

Default Tabular selection mechanism

DefaultTableSelectionHandlerParameters

Type: Object

Example
{
  key: 'default',
  args: {}
}

DeleteBookmarkActionParameters

Deletes a bookmark or a folder recursively. If the bookmark has been registered as user's favorite and the user has the right to edit that, it will also delete the favorite.

DeleteBookmarkActionParameters

Type: Object

Example
{
  key: 'delete-bookmark',
  args: {}
}

DeleteCalculatedMeasureActionParameters

An action to delete the a persisted measure, disabled if the user does not have the permissions to delete it.

DeleteCalculatedMeasureActionParameters

Type: Object

Example
{
  key: 'delete-calculated-measure',
  args: {}
}

DeleteKpiActionParameters

An action to delete the kpi, disabled if the user does not have the permissions to delete it.

DeleteKpiActionParameters

Type: Object

Example
{
  key: 'delete-kpi',
  args: {}
}

DeletePointValuesActionParameters

Open a popup to notify a user before deleting the selected rows.

DeletePointValuesActionParameters

Type: Object

Example
{
  key: 'delete-pointvalues',
  args: {}
}

DeleteServerActionParameters

Opens a popup to confirm the deletion of a server from the serversPool.

DeleteServerActionParameters

Type: Object

Example
{
  key: 'delete-server',
  args: {}
}

Dimensionality

Dimensionality

Type: Array<HierarchyCoordinates>

DimensionCompoundIdentifierNode

A CompoundIdentifierNode that represents a dimension.

DimensionCompoundIdentifierNode

Type: Object

Properties
dimension (DimensionName)
elementType ("CompoundIdentifier")
identifiers (Array<IdentifierNode>)
type ("dimension")

DimensionName

DimensionName

Type: string

Discovery

Information discovered from an ActivePivot server about what data is available.

Discovery

Type: Object

Properties
catalogs (Array<Catalog>) : the available catalogs, which include dimensions, hierarchies, and levels as well as other items such as KPIs
contextValues (Array<CubeContextValueDefinition>) : the available context values that statements can be executed with
url (Url?) : the URL of the ActivePivot server from which this information was fetched
timestamp (number)

DiscoveryCache

DiscoveryCache

Type: (CachedQuerier & Object)

Properties
getCurrentForCube (function (cubeName: CubeName, catalogName: CatalogName): CubeDiscovery)
getForCube (function (cubeName: CubeName, catalogName: CatalogName): Promise<CubeDiscovery>)

DiscoveryKpi

KPI object provided by a discovery REST call This describes a KPI from an MDX point of view.

DiscoveryKpi

Type: Object

Properties
name (string) : KPI name
caption (string?) : KPI caption
description (string?) : description of the KPI purpose
folder (string?) : folder containing the defined KPI
measureGroup (string?) : group to which the defined KPI belongs
parent (string?) : name of a parent KPI
weight (number?) : weight given to the defined KPI. This matters when the KPI has a parent.
value (string) : unique name of a measure representing a KPI value (numeric measure)
goal (string?) : unique name of a measure representing a KPI goal (numeric measure)
status (string?) : unique name of a measure representing a KPI status (numeric measure)
trend (string?) : unique name of a measure representing a KPI trend (numeric measure)
statusPresenter (string?) : keyword indicating how to represent a KPI status. Mandatory if a status is defined.
trendPresenter (string?) : keyword indicating haw to represent a KPI trend. Mandatory if a trend is defined

DndType

DndType

Type: ("bookmark" | "dataHeader" | "discovery" | "popup" | "layoutTile" | "mdx" | "tabularHeader" | "wizardTile")

DockActionPayload

DockActionPayload

Type: Object

Properties
actionSituation ("dock-action")
widgetApi (WidgetApi?)

DragAndDropApi

DragAndDropApi

Type: Object

Properties
types ({})

DrillthroughColumn

DrillthroughColumn

Type: Object

Properties
columnName (string)
functionName (string)

DrillthroughColumns

DrillthroughColumns

Type: Object

Properties
getOrderedColumnsDetails (function (): Array<DrillthroughColumn>)

DrillthroughDataSet

Data structure sent by ActivePivot containing the drillthrough result.

DrillthroughDataSet

Type: Object

Properties
epoch (number)

DrillthroughDataSetCell

DrillthroughDataSetCell

Type: (string | number)

DrillthroughDataSetHeader

DrillthroughDataSetHeader

Type: Object

Properties
caption (string)
name (string)
type (string)

DrillthroughDataSetResult

DrillthroughDataSetResult

Type: Object

Properties

DrillthroughDataSetRow

DrillthroughDataSetRow

Type: Array<DrillthroughDataSetCell>

DrillthroughStatementNode

An MdxNode representing a DRILLTHROUGH statement.

DrillthroughStatementNode

Type: Object

Properties
columns (Array<ExpressionNode>)
elementType ("Drillthrough")
firstRow (number)
maxRows (number)

DropStatementNode

A type of MdxNode.

DropStatementNode

Type: Object

Properties
cubeName (CubeName)
elementType ("Drop")
session (Todo)

EditBookmarkActionParameters

Opens a popup to edit a bookmark or a folder.

EditBookmarkActionParameters

Type: Object

Example
{
  key: 'edit-bookmark',
  args: {}
}

EditCalculatedMeasureActionParameters

Open a popup to edit a calculated measure and modify the MDX of the widget.

EditCalculatedMeasureActionParameters

Type: Object

Example
{
  key: 'edit-calculated-measure',
  args: {}
}

EditKpiActionParameters

An action to open the kpi editor, with some contextual information if available.

EditKpiActionParameters

Type: Object

Example
{
  key: 'edit-kpi',
  args: {}
}

EditSingleValueActionParameters

Open a popup to edit the current single value widget.

EditSingleValueActionParameters

Type: Object

Example
{
  key: 'edit-single-value',
  args: {}
}

EmptyTableCell

EmptyTableCell

Type: void

EmptyTableSelectionHandlerParameters

Handler that always returns an empty selection

EmptyTableSelectionHandlerParameters

Type: Object

Example
{
  key: 'empty',
  args: {}
}

EnrichedCubeMeasure

EnrichedCubeMeasure

Type: (CubeMeasure & Object)

Properties
permissions (Permissions)

ErrorsLoggerParameters

A logger that only logs errors.

ErrorsLoggerParameters

Type: Object

Example
{
  key: 'errors',
  args: {}
}

ExceptFiltersKeyMdxFilterSelectorParameters

Filters out the specified filters on top of using a key

ExceptFiltersKeyMdxFilterSelectorParameters

Type: Object

Properties
key (string)
selectorsToExcept (Array<SerializablePluginImplementation<MdxFilterSelectorFactoryProperties>>)
Example
{
  key: 'except-filters-key',
  args: {
    key: /* string */,
    selectorsToExcept: /* Array.<SerializablePluginImplementation.<MdxFilterSelectorFactoryProperties>> */
  }
}

ExpiryCellFactoryParameters

Renders a progress bar instead of the start and expiry columns of a KPI.

ExpiryCellFactoryParameters

Type: Object

Example
{
  key: 'expiry',
  args: {}
}

ExplicitHeaderComparatorParameters

Sorts headers in the same order as a given list.

ExplicitHeaderComparatorParameters

Type: Object

Properties
orderedColumns (OrderedColumns)
Example
{
  key: 'explicit',
  args: {
    orderedColumns: /* OrderedColumns */
  }
}

ExplicitOrdinalColorScaleParameters

Create a custom color scale that explicitly list all colors. Fallback to text color if no parameters are provided.

ExplicitOrdinalColorScaleParameters

Type: Object

Properties
colors (Array<Color>)
Example
{
  key: 'explicit',
  args: {
    colors: /* Array.<Color> */
  }
}

ExplicitThemeParameters

Theme reading its properties from its parameters.

ExplicitThemeParameters

Type: ThemeImplementationProperties

Example
{
  key: 'explicit',
  args: /* ThemeImplementationProperties */
}

Exports

The exports of '@activeviam/activeui-sdk'.

Exports

Type: Object

Properties
ActiveUIConsumer (ActiveUIConsumer)
ActiveUIContext (ActiveUIContext)
ActiveUIProvider (ActiveUIProvider)
Container (React.Component<ContainerProps>)
createActiveUI (CreateActiveUI)

ExpressionNode

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

ExpressionNode

Type: (LiteralNode | IdentifierNode | CompoundIdentifierNode | CaseExpressionNode | MdxFunctionNode | StringFormulaSpecificationNode)

FeaturedValuesHandlerActionPayload

FeaturedValuesHandlerActionPayload

Type: Object

Properties
actionSituation ("featured-values-handler")
columnIndex (number)
rowIndex (number)
widgetApi (WidgetApi)

FeaturedValuesTooltipShowActionParameters

Display a tooltip for the featured values widget.

FeaturedValuesTooltipShowActionParameters

Type: Object

Properties
timeout (number) : The timeout after which the tooltip should appear.
Example
{
  key: 'featured-values-tooltip-show',
  args: {
    timeout: /* number */
  }
}

Feed

Feed

Type: Object

Properties
restart (function (): void)
start (function (): void)
stop (function (): void)

FeedId

FeedId

Type: string

FeedInfo

FeedInfo

Type: Object

Properties
feed (Feed)
id (FeedId)

FetchTranslation

Takes locale and default "fetch translation" method and returns a promise resolving to the translation data

FetchTranslation

Type: function (Locale, function (): Promise<TranslationTree>): Promise<TranslationTree>

FieldChooserImplementationStaticProperties

FieldChooserImplementationStaticProperties

Type: Object

FilterMembers

FilterMembers

Type: Object<HierarchyUniqueName, Array<Member>>

FilterScopeEnum

Enum of the scope of widgets to apply filter on

FilterScopeEnum

Type: ("all" | "only-siblings" | "only-current-widget")

FiltersMembersContribution

An array corresponding to the intersection of the members included by each explicit filter for a given hierarchy.

FiltersMembersContribution

Type: Object

Properties
hasData (boolean) : false when there is no data for the equivalent effective filter for example if there are two filters on Currency, one on [EUR, GBP] and the other on [USD] , then the intersection has no data.
isAccurate (boolean) : indicates whether the members retrieved are guaranteed to contribute to the query's result. It is false as soon as there are non-explicit filters (or explicit filters in exclude mode) on the hierarchy.
members (FilterMembers)

FilterSource

The source of the filter. One of Slicers: 0, SubSelects: 1 or Server: 2.

FilterSource

Type: (0 | 1 | 2)

FirstColumnHeaderCaptionProducerParameters

This caption producer keeps the caption as it is in the first column of the group.

FirstColumnHeaderCaptionProducerParameters

Type: Object

Example
{
  key: 'firstColumn',
  args: {}
}

Formatter

Formatter

Type: Object

Properties
formatter (function (Date): TranslationResult)
predicate (function (Date): boolean)

FormatterImplementationProperties

Formats a caption into a specific format incorporating the user's locale.

FormatterImplementationProperties

Type: Object

Properties
format (function (value: (string | number), caption: string): string) : A function receiving the value and sometimes caption from the data and produces a caption to be displayed in the application. Sometimes the caption is undefined because the element to format does not come from the data. For example in the case of the formatter used for the axis of charts: On numerical axis, the values to format are for 'ticks', for which the values do not necessarily correspond to values in the data. Thus, a caption cannot be provided in that case.

FormatterImplementationStaticProperties

Use ChooseableFormatterImplementationStaticProperties or NotChooseableFormatterImplementationStaticProperties

FormatterImplementationStaticProperties

Type: (ChooseableFormatterImplementationStaticProperties | NotChooseableFormatterImplementationStaticProperties)

FormulaNode

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

FormulaNode

Type: Object

Properties
elementType ("Formula")
expression (ExpressionNode)
inlined ((boolean | void))
type (string)

FromClauseNode

An MdxNode representing a named cube for the FROM clause of a SelectNode. Does not represent a subselect expression in a FROM clause – that is represented by a SubSelectNode instead.

FromClauseNode

Type: Object

Properties
cubeName (CubeName)
elementType ("From")

FullPalette

Structure containing all the colors used by ActiveUI components. It is a merge of the sub-palettes:

It shares the same structure than the InputPalette but in this palette none of the properties are optional.

FullPalette

Type: (CorePalette & ShadePalette & AlternatePalette & ComponentPalette)

FullSizeActionParameters

Display widgets in full screen.

FullSizeActionParameters

Type: Object

Example
{
  key: 'full-size',
  args: {}
}

getBookmark

Retrieve a bookmark based on ID.

Parameters
id (BookmarkId) Bookmark ID
Returns
Promise<BookmarkDescription>: A Bookmark object.

GetCaptionProperty

GetCaptionProperty

Type: (GetReactCaptionProperty & Object)

Properties
getCaption (function (translator: Translator, headers: Array<TableHeader>, groupedHeadersIds: Array<number>, dataSource: DataSource): TranslationResult)

GetCaptionsProperty

GetCaptionsProperty

Type: (GetReactCaptionProperty & Object)

Properties
getCaptions (function (translator: Translator, headers: Array<TableHeader>, groupedHeadersIds: Array<number>, dataSource: DataSource): {captions: Array<TableHeaderCaption>, sizes: Array<number>?})

GetReactCaptionProperty

GetReactCaptionProperty

Type: Object

Properties
getReactCaption (function (translator: Translator, headers: Array<TableHeader>, groupedHeadersIds: Array<number>, dataSource: DataSource, data: Table, cellFactory: SerializableCellFactory): React.Node?)

GoogleChartOrdinalColorScaleParameters

Color scale of size 5 following Google Chart/ActivePivot Live 3 color scheme. It contains the following colors: mariner, tia maria, orange peel, la palma, flirt. See https://developers.google.com/chart/

GoogleChartOrdinalColorScaleParameters

Type: Object

Example
{
  key: 'google-chart',
  args: {}
}

HeaderCaptionProducerImplementationProperties

Produces captions based on the provided headers.

HeaderCaptionProducerImplementationProperties

Type: (GetCaptionProperty | GetCaptionsProperty)

HeaderCaptionProducerImplementationStaticProperties

HeaderCaptionProducerImplementationStaticProperties

Type: Object

HeaderComparatorImplementationProperties

Customizes the order in which tabular view and pivot table columns are displayed.

HeaderComparatorImplementationProperties

Type: Object

Properties
compare (function (h1: SortableTabularHeader, h2: SortableTabularHeader): number)

HeaderComparatorImplementationStaticProperties

HeaderComparatorImplementationStaticProperties

Type: Object

HideTooltipActionParameters

An action to hide any tooltip that is displayed in ActiveUI.

HideTooltipActionParameters

Type: Object

Example
{
  key: 'hide-tooltip',
  args: {}
}

HierarchyCompoundIdentifierNode

A CompoundIdentifierNode that represents a hierarchy.

HierarchyCompoundIdentifierNode

Type: Object

Properties
dimension (DimensionName)
elementType ("CompoundIdentifier")
hierarchy (HierarchyName)
identifiers (Array<IdentifierNode>)
type ("hierarchy")

HierarchyCoordinates

HierarchyCoordinates

Type: Object

Properties
dimension (DimensionName)
hierarchy (HierarchyName)

HierarchyGreaterIndexMdxFilterSelectorParameters

Matches filters with the provided hierarchy and an index greater than the one provided

HierarchyGreaterIndexMdxFilterSelectorParameters

Type: Object

Properties
hierarchy (string)
index (number)
Example
{
  key: 'hierarchy-greater-index',
  args: {
    hierarchy: /* string */,
    index: /* number */
  }
}

HierarchyKeyIndexMdxFilterSelectorParameters

Matches filters with the provided key, index and hierarchy

HierarchyKeyIndexMdxFilterSelectorParameters

Type: Object

Properties
hierarchy (string)
index (number)
key (string)
Example
{
  key: 'hierarchy-key-index',
  args: {
    hierarchy: /* string */,
    index: /* number */,
    key: /* string */
  }
}

HierarchyKeyMdxFilterSelectorParameters

Matches filters with the provided key and hierarchy

HierarchyKeyMdxFilterSelectorParameters

Type: Object

Properties
hierarchy (string)
key (string)
Example
{
  key: 'hierarchy-key',
  args: {
    hierarchy: /* string */,
    key: /* string */
  }
}

HierarchyKeyValueMdxFilterSelectorParameters

Matches filters with the provided key, filter value and hierarchy

HierarchyKeyValueMdxFilterSelectorParameters

Type: Object

Properties
hierarchy (string)
key (string)
value (FilterValue)
Example
{
  key: 'hierarchy-key-value',
  args: {
    hierarchy: /* string */,
    key: /* string */,
    value: /* FilterValue */
  }
}

HierarchyMdxFilterSelectorParameters

Matches filters with the provided hierarchy

HierarchyMdxFilterSelectorParameters

Type: Object

Properties
hierarchy (string)
Example
{
  key: 'hierarchy',
  args: {
    hierarchy: /* string */
  }
}

HierarchyName

HierarchyName

Type: string

HierarchyUniqueName

HierarchyUniqueName

Type: string

HtmlRendererImplementationProperties

Responsible for converting plain text to HTML.

HtmlRendererImplementationProperties

Type: Object

Properties
getPlaceholder (function (): ReactTranslationPayload) : Return a text to be translated and used to explain the features of the renderer.
toHtml (function (plainText: string): string) : Convert the plain text to HTML and must handle escaping so that custom JavaScript cannot be injected.

HtmlRendererImplementationStaticProperties

HtmlRendererImplementationStaticProperties

Type: Object

Properties
getCssRules (function (palette: FullPalette): {}?) : Return a map of CSS in JS rules to be applied to the rendered output. The keys of the map are CSS selectors that will be prefixed by a custom class so that they stay isolated to the div containing the rendered output. The values of the map are regular CSS properties expressed in JavaScript such as {color: 'blue'} . The CSS properties will be "autoprefixed" in order to work well in the different browsers. Example of map that can be returned: {p: {fontSize: '13px'}} .

I18nCSFile

I18nCSFile

Type: CSFile<{}, any>

IconImplementationProperties

Renders an icon. The expected output is any React element. For the list of available keys in the SDK, see the theme page of the Showcase application.

IconImplementationProperties

Type: Object

Properties
render (function (palette: CorePalette, props: any): React.Element<any>) : The render method of the icon. The props provided as the second argument might change depending on where the icon is rendered. We recomment to always propagate this props to the top-level component and to not try to use what is inside.

IconImplementationStaticProperties

IconImplementationStaticProperties

Type: Object

IdentifierNode

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

IdentifierNode

Type: Object

Properties
elementType ("Identifier")
quoting (QuotingValue)
value (string)

Internationalization

An object to expose the locale events and provide ActiveUI's translator implementation to an external application

Internationalization

Type: Object

Properties
addTranslationChangeListener (AddListener<TranslationTree>)
getTranslator (function (): Translator)
listLocales (function (): Array<LocaleDescription>)

JwtAuthenticationHolderParameters

Uses JWT for REST and cookies for WebSockets.

JwtAuthenticationHolderParameters

Type: Object

Example
{
  key: 'jwt',
  args: {}
}

JwtResult

JwtResult

Type: Object

Properties
data.token (string)
data ({token: string})

KeycloakAuthenticationHolderOptions

KeycloakAuthenticationHolderOptions

Type: Object

Properties
afterLoginPageName (string?) : The path to the page to call to ask the user to log-in again (after a token has expired for example), relative to the path of the application. Defaults to afterlogin.html .
logoutEndPointUrl (Url) : The endpoint URL to logout the current user.
tokenCacheMissSleepTime (number?) : Time in ms after which the application re-tries to retrieve a token from Keycloak if it failed the first time. This can happen due to clock offsets between the Keycloak server and the ActiveUI server. Defaults to 10000 .
tokenEndPointUrl (Url) : The endpoint URL to get a token.
whiteListedUrlPrefixes (Array<string>?) : URL prefixes for which the Keycloak token should not be included in the Authorization header. Calls to access resources protected by a Keycloak filter should not include the Keycloak token, as it would trigger an unwanted authentication flow, and lead to tokens not refreshing correctly. Defaults to [window.location.origin, logoutEndPointUrl] .
windowClosePollerInterval (number?) : Interval in ms to check if the user has closed the popup asking to log-in again. Defaults to 2000 .

KeycloakAuthenticationHolderParameters

Uses Keycloak for REST and cookies for WebSockets.

KeycloakAuthenticationHolderParameters

Type: Object

Properties
type (("Jwt" | "Bearer")?) : Will be used as a prefix before the token in the Authorization header. Defaults to Jwt .
Example
{
  key: 'keycloak',
  args: {
    type: /* ("Jwt"|"Bearer")= */,
    options: /* KeycloakAuthenticationHolderOptions */
  }
}

KeyMdxFilterSelectorParameters

Matches non server filters with the provided key

KeyMdxFilterSelectorParameters

Type: Object

Properties
key (string)
Example
{
  key: 'key',
  args: {
    key: /* string */
  }
}

KeyValueAsyncCache

KeyValueAsyncCache

Type: Todo

KeyValueTooltipEntries

KeyValueTooltipEntries

Type: Array<KeyValueTooltipEntry>

KeyValueTooltipEntry

KeyValueTooltipEntry

Type: Object

Properties
keyCaption (string?)
keyCaptionParameters (Object?)
keyCaptionPath (string?)
valueCaption (string?)
valueCaptionParameters (Object?)
valueCaptionPath (string?)

KeyValueTooltipParameters

KeyValueTooltipParameters

Type: Object

Properties

KpiDefinition

KpiDefinition

Type: Object

Properties
caption (string)
folder (string)
goal (Mdx)
name (string)
status (Mdx)
trend (Mdx)
value (Mdx)

KpiExpiryColumnsSelectorParameters

Groups together the start and expiry columns of a kpi

KpiExpiryColumnsSelectorParameters

Type: Object

Properties
groupByKpi (boolean?) : If true, there will be one group per kpi. Otherwise, all the kpis will be in the same group. Defaults to false.
Example
{
  key: 'kpi-expiry',
  args: {
    groupByKpi: /* boolean= */
  }
}

KpiExpiryHeaderCaptionProducerParameters

This caption producer is useful when the expiry column groups several expiries together (when the groupByKpi flag is true on the kpiExpiryColumnsSelector), because it displays 'kpiName Expiry'. It relies on the fact that the captions of the members that are crossjoined are displayed directly in the cell.

KpiExpiryHeaderCaptionProducerParameters

Type: Object

Example
{
  key: 'expiry',
  args: {}
}

KpiGoalColumnsSelectorParameters

Selects the columns that are the goal of a kpi.

KpiGoalColumnsSelectorParameters

Type: Object

Properties
groupByKpi (boolean?) : If true, there will be one group per kpi. Otherwise, all the kpis will be in the same group. Defaults to false.
Example
{
  key: 'kpi-goal',
  args: {
    groupByKpi: /* boolean= */
  }
}

KpiMonitorConfiguration

The monitor configuration that will be stringified

KpiMonitorConfiguration

Type: Object

Properties
context ({}) : list of context values
filter (string) : the filter to apply
mode (string) : the monitor mode (default CONTINUOUS)
period (number) : the monitor period
selection (string) : MDX selection to monitor

KpiName

KpiName

Type: string

KpiStatusCellFactoryParameters

Renders the customized cell of the status of a KPI status.

KpiStatusCellFactoryParameters

Type: Object

Example
{
  key: 'kpi-status',
  args: {}
}

KpiStatusCellRendererParameters

Render different icons for cell values value < -0.5, -0.5< value <0.5 and value > 0.5

KpiStatusCellRendererParameters

Type: Object

KpiStatusColumnsSelectorParameters

Groups together the status columns of a kpi.

KpiStatusColumnsSelectorParameters

Type: Object

Example
{
  key: 'kpi-status',
  args: {}
}

LeanDarkCeruleanThemeParameters

Built-in lean dark theme.

LeanDarkCeruleanThemeParameters

Type: Object

Example
{
  key: 'lean-dark-cerulean',
  args: {}
}

LeanLightCeruleanThemeParameters

Built-in lean light theme.

LeanLightCeruleanThemeParameters

Type: Object

Example
{
  key: 'lean-light-cerulean',
  args: {}
}

LevelCompoundIdentifierNode

A CompoundIdentifierNode that represents a level.

LevelCompoundIdentifierNode

Type: Object

Properties
dimension (DimensionName)
elementType ("CompoundIdentifier")
hierarchy (HierarchyName)
identifiers (Array<IdentifierNode>)
level (LevelName)
type ("level")

LevelCoordinates

LevelCoordinates

Type: (HierarchyCoordinates & Object)

Properties
level (LevelName)

LevelName

LevelName

Type: string

LightBluewoodThemeParameters

Old light theme.

LightBluewoodThemeParameters

Type: Object

Example
{
  key: 'light-bluewood',
  args: {}
}

LightCeruleanThemeParameters

Built-in light theme.

LightCeruleanThemeParameters

Type: Object

Example
{
  key: 'light-cerulean',
  args: {}
}

LinearChartOverlayParameters

An overlay displaying a line following the equation y = mx + b. Only available on charts with an x and y axis, and with y being a numerical axis.

LinearChartOverlayParameters

Type: Object

Properties
b (number?) : the b parameter, as in y = mx + b. Defaults to 0
bStep (number?) : The step for the UI control for b. Defaults to 1
color (string?) : The color of the regression line.
formatter (any?) : A formatter specification understood by d3: https://github.com/d3/d3-format/blob/master/README.md#api-reference This formatter is used to format the equation coefs + r^2, and X and Y when the chart scales have no formatters.
m (number?) : the m parameter, as in y = mx + b. Defaults to 0
mStep (number?) : The step for the UI control for m. Defaults to 0.1
timeFormatter (any?) : A formatter used for the time in the tooltip, from the types.chartTimeFormatter plugin
Example
{
  key: 'linear',
  args: {
    b: /* number= */,
    bStep: /* number= */,
    color: /* string= */,
    formatter: /* *= */,
    m: /* number= */,
    mStep: /* number= */,
    timeFormatter: /* *= */
  }
}

LinearNumericScaleProfileParameters

A linear profile, that returns the percentage of the value between the domain min and max.

LinearNumericScaleProfileParameters

Type: Object

Example
{
  key: 'linear',
  args: {}
}

LinearPiecewiseNumericScaleProfileParameters

A profile linear in 2 pieces, centered around middle.

LinearPiecewiseNumericScaleProfileParameters

Type: Object

Properties
middle (number) : The middle of the scale. Defaults to 0 .
Example
{
  key: 'linear-piecewise',
  args: {
    middle: /* number */
  }
}

Listener

Callback for listener on value<T>.

Listener

Type: function (value: T): void

LiteralNode

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

LiteralNode

Type: Object

Properties
elementType ("Literal")
value (string)

LoadBookmarkActionParameters

Loads a dashboard bookmark in a root container, opening a popup if several are available.

LoadBookmarkActionParameters

Type: Object

Example
{
  key: 'load-bookmark',
  args: {}
}

Locale

A string symbolizing a locale following the ISO/IEC 15897 specification, for example en-US.

Locale

Type: string

LocaleDescription

A object describing a locale

LocaleDescription

Type: Object

Properties
caption (string)
value (Locale)

LocationInfo

LocationInfo

Type: Object

Properties
measure (LocationMeasure?)
members (LocationMembers)

LocationMeasure

LocationMeasure

Type: Object

Properties
caption (string)
name (MeasureName)
value (TableCellValue?)

LocationMembers

LocationMembers

Type: Object<HierarchyUniqueName, Member>

LocationsInfo

LocationsInfo

Type: Array<LocationInfo>

LoggerImplementationProperties

A plugin to handle logging side-effect. It is called for every logging request in activeUI

LoggerImplementationProperties

Type: Object

LoggerImplementationStaticProperties

LoggerImplementationStaticProperties

Type: Object

Properties
handle (function (data: LoggingData, {formatter: LoggingFormatter, tags: LoggingTags}): void) : A function called every time a log operation is requested.

LogoutActionParameters

Logs the current user out. There is no requirement concerning its availability (it can be used anywhere).

LogoutActionParameters

Type: Object

Example
{
  key: 'logout',
  args: {}
}

LookupCellFactoryParameters

Renders an editable cell when the column displays a lookup.

LookupCellFactoryParameters

Type: Object

Example
{
  key: 'lookup',
  args: {}
}

LookupColumnsSelectorParameters

Selects the columns that correspond to a formula lookup("...").

LookupColumnsSelectorParameters

Type: Object

Example
{
  key: 'lookup',
  args: {}
}

ManualColumnsSelectorParameters

Creates one group of columns, according to the selection provided.

ManualColumnsSelectorParameters

Type: Object

Properties
selection (Array<string>) : The list of header values to group
key (string?) : The key to use as a reference of the column group, generated if not provided
Example
{
  key: 'manual',
  args: {
    selection: /* Array.<string> */,
    key: /* string= */
  }
}

MapStorage

MapStorage

Type: Object

Properties
clear (function (): void) : Empty the storage
getKeys (function (): Array<string>) : List all existing keys
read (function (string): any) : return an element from the storage
remove (function (string): void) : remove an element from the storage
size (function (): number) : return how many elements are currently present in the storage
write (function (string, any): void) : insert an element in the storage

MarkdownHtmlRendererParameters

Use the default preset of https://github.com/markdown-it/markdown-it to convert Markdown to HTML.

The linkify and typographer options are enabled.

MarkdownHtmlRendererParameters

Type: Object

Example
{
  key: 'markdown',
  args: {}
}

MaxLevelPerHierarchy

MaxLevelPerHierarchy

Type: Array<number>

Mdx

A string representing an MDX query or a subset of one. This type can represent a whole statement or just an expression – anything that could be parsed without more context than it being MDX.

Mdx

Type: string

Example
'SELECT\n  [Measures].[contributors.COUNT] ON COLUMNS\n  FROM [EquityDerivativesCube]'
'[Measures].[contributors.COUNT]'
'"a string in MDX"'
'123'

MdxApi

Manipulate Mdx (MDX), mostly via transforming it to a tree of MdxNodes.

Because MdxNodes are immutable, all functions within the MDX API that say they change an MDX Node (“add, “remove”, etc.) really just return a copy of the MDX Node with the described differences.

MdxApi

Type: Object

Properties
axes (MdxAxesApi)
base (MdxBaseApi)
cleaning (MdxCleaningApi)
create (MdxCreateApi)
definitions (Todo)
dimensions (Todo)
drillthrough (MdxDrillthroughApi)
filters (MdxFiltersApi)
formulas (MdxFormulasApi)
functions (MdxFunctionsApi)
getSnd (function (dataSource: MdxUsingDataSource): StatementAndDiscovery)
hierarchies (MdxHierarchiesApi)
kpi (MdxKpiApi)
levels (MdxLevelsApi)
measures (MdxMeasuresApi)
namedSets (MdxNamedSetsApi)
nodeMatcher (NodeMatcherFactory)
order (MdxOrderApi)
parsing (MdxParsingApi)
statements (MdxStatementsApi)
tabular (MdxTabularApi)
transform (function (mdx: Mdx, discovery: Discovery, sndTransformer: function (StatementAndDiscovery): StatementAndDiscovery): Mdx)
transformDataSource (function (dataSource: MdxUsingDataSource, sndTransformer: function (StatementAndDiscovery): StatementAndDiscovery): void)
transformStatement (function (mdx: Mdx, discovery: Discovery, nodeTransformer: function (SelectNode): SelectNode): Mdx)
tuples (MdxTuplesApi)
Static Members
transform
transformStatement
transformDataSource
getSnd

MdxAxesApi

Contains all the operations related to the axes of a Select statement. Axes can be split in two categories:

  • the SLICER axis corresponding to the WHERE part of an MDX statement
  • the main axes: COLUMNS, ROWS (the MDX specification includes more names like PAGES, CHAPTERS, SECTIONS but they are not supported by this API).
MdxAxesApi

Type: Object

Properties
getAxis (function (node: SelectNode, axisName: string): (AxisNode | void))
getAxisOfMeasuresHierarchy (function (snd: StatementAndDiscovery): (AxisNode | void))
getColumnsAxis (function (node: SelectNode): (AxisNode | void))
getColumnsAxisIndex (function (node: SelectNode): number)
getMeasuresAxis (function (snd: StatementAndDiscovery): (AxisNode | void))
getRowsAxis (function (node: SelectNode): (AxisNode | void))
getRowsAxisIndex (function (node: SelectNode): number)
getSlicerAxis (function (node: SelectNode): AxisNode)
hasAxis (function (node: SelectNode, axisName: string): boolean)
isMainAxisName (function (name: string): boolean)
listAxes (function (statement: SelectNode): Array<string>)
MEASURES_AXIS_NAME (string)
transformOnlyAxis (function (statement: SelectNode, axisName: string, transform: function (AxisNode): AxisNode, createIfNotExisting: function (): (AxisNode | void)): SelectNode)
updateNonEmptyOfAxis (function (mdxStatementNode: SelectNode, axisName: string, valueOfNonEmpty: boolean): SelectNode)
Static Members
MEASURES_AXIS_NAME
getAxis
hasAxis
getColumnsAxis
getColumnsAxisIndex
getRowsAxis
getRowsAxisIndex
getSlicerAxis
getMeasuresAxis
getAxisOfMeasuresHierarchy
listAxes
transformOnlyAxis
updateNonEmptyOfAxis
isMainAxisName

MdxBaseApi

Contains basic read/write operations on Mdx and MdxNodes.

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

Quoting

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

Predicates on MdxNodes

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

MdxBaseApi

Type: Object

Properties
createKeyword (function (string): LiteralNode)
createScalar (function (numberForMdx: (Mdx | number)): LiteralNode)
createSet (function (args: Array<ExpressionNode>): MdxFunctionNode)
createString (function (string): LiteralNode)
getAllCompoundIdentifiers (function (mdxNode: MdxNode): Array<CompoundIdentifierNode>)
getCubeName (function (statement: (MdxNode | Mdx)): (CubeName | void))
getEmptyCubeStatement (function (CubeName, discovery: Discovery): MdxNode)
getIdentifiersValues (function (CompoundIdentifierNode): Array<string>)
getMeasureCompoundIdentifierName (function (MemberCompoundIdentifierNode): MeasureName)
getMeasureCompoundIdFilter (function (measureIn: boolean): function (MdxNode): boolean)
getMeasureName (any)
getMemberName (function (Mdx): (string | void))
getSetSize (function (MdxNode): (number | null))
isAFunction (function (MdxNode): boolean)
isAKpiFunction (function (MdxNode): boolean)
isALookupFunction (function (MdxNode): boolean)
isAnInfixFunction (function (MdxNode): boolean)
isARegularFunction (function (MdxNode): boolean)
isAxis (function (MdxNode, name: string): boolean)
isCase (function (MdxNode): boolean)
isColumnsAxis (function (MdxNode): boolean)
isCompoundIdentifier (function (MdxNode): boolean)
isDimension (function (MdxNode): boolean)
isDrillthrough (function (MdxNode): boolean)
isEquivalentToCrossjoin (function (MdxNode): boolean)
isEquivalentToUnion (function (MdxNode): boolean)
isExplicitSet (function (MdxNode): boolean)
isFormula (function (MdxNode): boolean)
isFunction (function (MdxNode, name: string): boolean)
isHierarchy (function (MdxNode): boolean)
isInfixFunction (function (MdxNode, name: string): boolean)
isLevel (function (MdxNode): boolean)
isLiteral (function (MdxNode): boolean)
isMeasure (function (MdxNode): boolean)
isMeasureCompoundIdentifier (function (MdxNode): boolean)
isMember (function (MdxNode): boolean)
isNamedSet (function (MdxNode): boolean)
isNamedSetCompoundId (function (MdxNode): boolean)
isNegativeNumber (function (MdxNode): boolean)
isNull (function (MdxNode): boolean)
isNumber (function (MdxNode): boolean)
isNumericAndOnColsAxis (function (TableHeader): boolean)
isOnRows (function (TableHeader): boolean)
isPlaceHolder (function (MdxNode): boolean)
isPositiveNumber (function (MdxNode): boolean)
isRegularFunction (function (MdxNode, name: string): boolean)
isRowsAxis (function (MdxNode): boolean)
isSameCompoundIdentifier (function (cId1: CompoundIdentifierNode, cId2: CompoundIdentifierNode): boolean)
isScalar (function (MdxNode): boolean)
isSelect (function (MdxNode): boolean)
isSet (function (MdxNode): boolean)
isSlicerAxis (function (MdxNode): boolean)
isString (function (MdxNode): boolean)
isSubSelect (function (MdxNode): boolean)
isTuple (function (MdxNode): boolean)
isUnknownCompoundId (function (MdxNode): boolean)
isWhen (function (MdxNode): boolean)
quote (function (): Mdx)
unquote (function (Mdx): Array<string>)
updateSnD (function (snd: StatementAndDiscovery, transform: function (SelectNode): SelectNode): StatementAndDiscovery)
Static Members
getMemberName(pathStr)
updateSnD
isCompoundIdentifier
isDimension
isHierarchy
isLevel
isNamedSetCompoundId
isUnknownCompoundId
isMember
isLiteral
isPlaceHolder
isAFunction
isARegularFunction
isAnInfixFunction
isSet
isExplicitSet
isDrillthrough
isSelect
isSubSelect
isFormula
isNamedSet
isCase
isWhen
isScalar
isString
isNull
isAxis
isColumnsAxis
isRowsAxis
isSlicerAxis
isAKpiFunction
isFunction
isRegularFunction
isInfixFunction
isALookupFunction
isPositiveNumber
isNegativeNumber
isNumber
isMeasureCompoundIdentifier
isMeasure
isTuple
isEquivalentToCrossjoin
isEquivalentToUnion
quote(path)
unquote(str)
getMeasureCompoundIdentifierName
getMeasureName
getIdentifiersValues
createSet
createString
createScalar
createNumber
createKeyword
getCubeName
getAllCompoundIdentifiers
getMeasureCompoundIdFilter
isSameCompoundIdentifier
getSetSize
getEmptyCubeStatement
isNumericAndOnColsAxis
isOnRows
getPrimitiveValue

MdxCellStylerParameters

The default plugin for converting MDX cell properties to CSS.

MdxCellStylerParameters

Type: Object

MdxCleaningApi

Provides functions to clean a parsed tree and simplify it.

MdxCleaningApi

Type: Todo

MdxColor

A string or number representing the color. Example: 'rgb(0, 0, 255)' or 16711680 means blue.

MdxColor

Type: (string | number)

MdxContextValue

MdxContextValue

Type: (string | number | boolean)

MdxContextValueKey

MdxContextValueKey

Type: string

MdxContextValues

MdxContextValues

Type: Object<MdxContextValueKey, MdxContextValue>

Properties
mdx.hiddengrandtotals (string?)
mdx.hiddensubtotals (string?)

MdxCreateApi

Contains functions to create MDX nodes.

MdxCreateApi

Type: Object<string, Todo>

Properties
createAxis (function (name: string, nonEmpty: boolean, expression: ExpressionNode, properties: Array<MdxNode>): AxisNode)
Static Members
createAxis(name, nonEmpty, expression, properties)

MdxDefinition

The definition of a configuration

MdxDefinition

Type: Object

Properties
statement (string) : a mdx configuration statement
owners (PermissionGroups?) : a list of roles/users that can edit the configuration
readers (PermissionGroups?) : a list of roles/users that can read the configuration

MdxDrillthroughApi

Contains all the drillthrough statement related functions.

MdxDrillthroughApi

Type: Todo

Static Members
getAvailableColumnsStatement
hasAnySelectedColumn
getSelectFromTuple
getStatementFromSelect
getTuple

MdxFiltersApi

Contains functions to manipulate filters of an MDX query.

The main object used to manipulate the filters of an MDX statement is called ActiveFilter. Active here means that this filter is currently in use in a statement, as opposed to the class Filter which describes a type of filter, outside of any statement context.

MdxFiltersApi

Type: Todo

MdxFilterSelectorImplementationProperties

MdxFilterSelector are used to retrieve one or more filters matching a specific set of conditions in order to manipulate it: read, write, remove...

MdxFilterSelectorImplementationProperties

Type: Object

Properties
matches (function (activeFilter: AugmentedActiveFilter<any>): boolean) : return true if and only if the provided filter matches the selector's condition

MdxFilterSelectorImplementationStaticProperties

MdxFilterSelectorImplementationStaticProperties

Type: Object

MdxFormulasApi

Contains all functions about calculated members.

MdxFormulasApi

Type: Todo

MdxFunctionNode

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

MdxFunctionNode

Type: Object

Properties
arguments (Array<ExpressionNode>)
elementType ("Function")
name (string)
syntax (SyntaxValue)

MdxFunctionsApi

Allows reading and manipulating the MDX functions used in a statement.

MdxFunctionsApi

Type: Todo

MdxHeaderCaptionProducerParameters

A caption producer relying on an MDX dataSource, useful for producing synthetic headers when grouping columns.

MdxHeaderCaptionProducerParameters

Type: Object

Example
{
  key: 'mdxHeaderCaption',
  args: {}
}

MdxHierarchiesApi

Contains all the logic for hierarchies transformations.

MdxHierarchiesApi

Type: Todo

MdxKpiApi

Contains all the operations related to KPIs and their functions.

MdxKpiApi

Type: Todo

MdxLevelsApi

Contains all the logic for levels transformations.

MdxLevelsApi

Type: Todo

MdxMeasuresApi

Contains all the basic read/write operations about MDX measures.

MdxMeasuresApi

Type: Todo

MdxNamedSetsApi

Contains functions for manipulating named sets.

MdxNamedSetsApi

Type: Object

Properties
addNamedSet (function (snd: StatementAndDiscovery, name: string, expression: Mdx, axis: string, position: number, nonEmptyAxis: boolean): StatementAndDiscovery)
Static Members
addNamedSet

MdxNode

The AST node representing an Mdx (MDX) string. The only property common to all nodes is elementType.

The MdxApi provides functions for creating and manipulating MdxNode objects.

MdxNodes should never be mutated.

MdxNode

Type: (ExpressionNode | AxisNode | FromClauseNode | FormulaNode | CreateStatementNode | DrillthroughStatementNode | DropStatementNode | MemberPropertyDefinitionNode | RefreshStatementNode | SelectNode | WhenClauseNode)

MdxOrderApi

Contains the methods to read or change the ordering in a statement. Ordering in MDX is controlled using the Order function.

MdxOrderApi

Type: Object

Properties
getAxisOrder (function (parsedSelectStatement: SelectStatementNode, axisName: string): (void | {expression: ExpressionNode, mode: OrderModeLiteralNode}))
getOrderingLevelFromFormula (function (orderingFormula: FormulaNode, cubeDiscovery: CubeDiscovery): (LevelName | void))
getOrderNode (function (node: MdxNode): (OrderFunctionNode | null))
order (function (node: ExpressionNode, orderingExpression: ExpressionNode, orderMode: OrderModeLiteralNode): ExpressionNode)
orderAxis (function (parsedSelectStatement: SelectNode, axisName: string, orderingExpression: string, orderMode: OrderMode): SelectNode)
removeOrder (function (parsedSelectStatement: SelectNode, axisName: string): SelectNode)
Static Members
order
orderAxis
getOrderNode
getAxisOrder
getOrderingLevelFromFormula
removeOrder

MdxParsingApi

Responsible for the conversion between MDX strings (Mdx) and their equivalent trees of nodes (MdxNode).

MdxParsingApi

Type: Object

Properties
isParseable (function (Mdx): boolean)
parseExpression (function (expression: Mdx, discovery: Discovery, context: {cubeName: CubeName?}): MdxNode)
toString (function (node: MdxNode, options: MdxPrinterOptions): Mdx)
Static Members
parseExpression
isParseable
toString

MdxPrinterOptions

MdxPrinterOptions

Type: Object

Properties
glue (StringDeepJoiner?) : If you want, you can override this function that collects together pieces of text to produce one big string.
glueArgs (boolean?) : If true, argument lists are separate by only the comma character, like “(a,b)”. If false, argument lists are also printed on separate lines, like “(a,\n b)”. Defaults to false.
indent (boolean?) : Whether to automatically indent each line of the printed MDX. Defaults to false.
notEmpty (function (Mdx): boolean?) : If you want, you can override this function that accepts an MDX string and returns a boolean representing whether it should be considered “not empty”.

MdxQuery

A MDX query on a given server.

A MdxQuery has two ids: clientId and serverId:

  • clientId: a unique id among all the queries in this loaded ActiveUI application. Used to find again a query in the queries pool. This id is assigned when the query is created and never changes. This is the same ID we will use to match the server 'streamId' notion.
  • serverId: a id that changes every time the mdx or the context values of this query change. This is the id we send to the server so that we can match WebSocket queries updates with their corresponding query state (especially drop updates that we receive just after having changed the MDX for instance because they are not consistent with the cellSet we expect to have with this MDX). This id is also unique among all running queries in this loaded ActiveUI application.
MdxQuery

Type: Object

Properties
addListener (function (function (Table): void): RemoveListener)
cancel (function (): void)
dispose (function (): void)
executeOnceAndGetPromise (function (): Promise<CellSet>)
getContext (function (): MdxContextValues)
getId (function (): QueryId)
getMdx (function (): Mdx)
getRanges (function (): Ranges)
getRefreshInterval (function (): number)
getUpdateMode (function (): UpdateMode)
hasStarted (function (): boolean)
isRealTime (function (): boolean)
refresh (function (): void)
refreshAndGetPromise (function (): Promise<CellSetMessage?>)
refreshPeriodically (function (number): MdxQuery)
setContext (function (MdxContextValues): MdxQuery)
setMdx (function (Mdx): MdxQuery)
setRanges (function (Ranges): MdxQuery)
setRefreshInterval (function (number): void)
start (function (UpdateMode?, number?): MdxQuery)
stop (function (): MdxQuery)
toggle (function (): MdxQuery)
update (function (Mdx, MdxContextValues, UpdateMode, number): MdxQuery)

MdxQueryDescription

MdxQueryDescription

Type: Object

Properties
contextValues (MdxContextValues?)
mdx (Mdx)
serverUrl (Url?)
updateMode (UpdateMode)

MdxQueryPayload

MdxQueryPayload

Type: Object

Properties
context (MdxContextValues?)
mdx (Mdx)

MdxStatementsApi

Contains the functions used to manipulate the different type of MDX statements that can be encountered (Select, Drillthrough Select).

MdxStatementsApi

Type: Todo

MdxTabularApi

Contains additional functions used for the tabular representation of a CellSet.

MdxTabularApi

Type: Todo

MdxTuplesApi

Contains all the operations related to MDX tuples.

MdxTuplesApi

Type: Todo

MeasureExpressionImplementationProperties

MeasureExpressionImplementationProperties

Type: Object

Properties
renderEditor (function ({_multiBinding: MultiBinding, additionalMeasuresCompoundIds: Array<CompoundIdentifierNode>, cubeName: string, serverUrl: Url}): React.Node)

MeasureExpressionImplementationStaticProperties

MeasureExpressionImplementationStaticProperties

Type: Object

MeasureGroupName

MeasureGroupName

Type: string

MeasureName

MeasureName

Type: string

Member

Member

Type: Object

Properties
captions (Array<string>)
positionInTuple.axis (("ROWS" | "COLUMNS"))
positionInTuple.coordinate (number)
positionInTuple ({axis: ("ROWS" | "COLUMNS"), coordinate: number})

MemberCaptionProvider

MemberCaptionProvider

Type: Object

Properties
getCaption (function (cubeName: CubeName, memberUniqueName: MemberUniqueName): string)
getCaptionPromise (function (cubeName: CubeName, memberUniqueName: MemberUniqueName): Promise<string>)
invalidate (function (): void)
setCaption (function (cubeName: CubeName, memberUniqueName: MemberUniqueName, caption: string): void)

MemberColumnsSelectorParameters

Creates a group of columns containing all the levels representing members (as opposed to measures).

MemberColumnsSelectorParameters

Type: Object

Example
{
  key: 'member',
  args: {}
}

MemberCompoundIdentifierNode

A CompoundIdentifierNode that represents a member.

MemberCompoundIdentifierNode

Type: Object

Properties
dimension (DimensionName)
elementType ("CompoundIdentifier")
hierarchy (HierarchyName)
identifiers (Array<IdentifierNode>)
level (LevelName)
path (Array<string>)
type ("member")

MemberFilterActionParameters

Open a popup to filter on the current column

MemberFilterActionParameters

Type: Object

Properties
forceEdit (boolean) : to force the edition, and not remove the filter
scope (string) : the scope of widgets to apply filter on. Accepted values are: 'all', 'only-siblings', and 'only-current-widget'. Defaults to 'only-current-widget' if not specified.
Example
{
  key: 'member-filter',
  args: {
    forceEdit: /* boolean */,
    scope: /* string */
  }
}

MemberPathAsString

The path of a member within its hierarchy.

MemberPathAsString

Type: string

Example
'[AllMember].[EUR]' // for the member with full unique name [Currency].[Currency].[ALL].[AllMember].[EUR]

MemberPropertyDefinitionNode

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

MemberPropertyDefinitionNode

Type: Object

Properties
elementType ("MemberPropertyDefinition")
expression (ExpressionNode)
name (string)

MemberUniqueName

MemberUniqueName

Type: string

MessagesApi

MessagesApi

Type: Object

Properties
all (function (): Promise<Array<ActiveMonitorMessage>>) : Gets all messages for the connected user.
createFeed (function (): FeedInfo)
delete (function (ActiveMonitorMessageId): Promise<void>)
markAsRead (function (ActiveMonitorMessageId): Promise<void>)

Monitor

Monitor

Type: Object

Properties
createdAt (AuditTimeInfo)
creator (Username)
deletedAt (AuditTimeInfo?)
description (string)
during (number)
id (string)
name (string)
site (string)
type (string)
workflowScheme (string)

MonitorAttributesImplementationStaticProperties

MonitorAttributesImplementationStaticProperties

Type: Object

MonitorConfiguration

MonitorConfiguration

Type: Object

MonitorLocation

MonitorLocation

Type: Object

Properties
id (string?)
name (string?)
site (string?)

MonitorPath

Either a site or "site/id"

MonitorPath

Type: (MonitorSite | string)

MonitorReport

MonitorReport

Type: Object

Properties
lastActivityTime (Timestamp)
lastEventTime (Timestamp)
monitor (Monitor)
statistics (MonitorStatistics)

MonitorsApi

MonitorsApi

Type: Object

Properties
all (function ((MonitorSite | void)): Promise<Array<Monitor>>) : Gets monitors of a given site. Use undefined to get monitors from all sites
getReports (function ((MonitorPath | MonitorLocation | void)): Promise<Array<MonitorReport>>) : Gets reports for monitors of a given site. Use undefined to get monitors from all sites
update (function (Monitor): Promise<Monitor>) : Updates a monitor definition. This uses the site and id stored in the monitor definition to build the update URL.
create (function (Monitor): Promise<Monitor>)
createFeed (function (): FeedInfo)
delete (function ((MonitorPath | MonitorLocation)): Promise<void>)
get (function ((MonitorPath | MonitorLocation)): Promise<Monitor>)
getHistory (function ((MonitorPath | MonitorLocation)): Promise<Array<Monitor>>)
getReport (function ((MonitorPath | MonitorLocation)): Promise<MonitorReport>)

MonitorSite

MonitorSite

Type: string

MonitorStatistics

MonitorStatistics

Type: Object

Properties
green (number)
red (number)
yellow (number)

MonitorStatusCellFactoryParameters

Renders the customized cell of the status of a monitor.

MonitorStatusCellFactoryParameters

Type: Object

MonoAccentOrdinalColorScaleParameters

Color scale of size 1 based on the current theme accent color

MonoAccentOrdinalColorScaleParameters

Type: Object

Example
{
  key: 'mono-accent',
  args: {}
}

MonoTextOrdinalColorScaleParameters

Color scale of size 1 based on the current theme text color

MonoTextOrdinalColorScaleParameters

Type: Object

Example
{
  key: 'mono-text',
  args: {}
}

NamedSetCompoundIdentifierNode

A CompoundIdentifierNode that represents a named set.

NamedSetCompoundIdentifierNode

Type: Object

Properties
elementType ("CompoundIdentifier")
identifiers (Array<IdentifierNode>)
namedSet (SetName)
type ("namedSet")

NestedStringArrays

An array that contains strings or arrays of strings or arrays of arrays of strings, etc.

NestedStringArrays

Type: Array<(string | NestedStringArrays)>

NewBookmarkBuilderBasedOnDock

A builder that displays a widget configured through a fluent interface

new NewBookmarkBuilderBasedOnDock(containerKey: any, activeUI: any)

Extends ABuilderBasedOnDock

Parameters
containerKey (any)
activeUI (any)
Instance Members
withKey(containerKey)
notWritable()
withTitleBar()
withoutTitleBar()
withMenuOnLeft()
withMenuOnRight()
withName(name)
withStyle(style)
withContentServerUrl(contentServerUrl)
withActions(actions)
withQuickActions(actions)
withBookmarkBody(bookmarkBody)
withBookmark(bookmark)
withActionStrictMode(mode)
toBookmark()

NodeMatcher

Create this with NodeMatcherFactory to get a fluent API for matching nodes in a parsed statement. See the NodeMatcherFactory documentation for examples.

Most methods on this object return another NodeMatcher, so you can chain them to perform multiple checks on a node and its children. The results of each match are ANDed together; for OR conditions, use the .or() method.

There are methods to match against attributes of the node, such as .isFunction('Generate'), or against children of the node, such as .subArg(0, firstArgMatcher => firstArgMatcher.isScalar()). If the method you want is not defined, you can match against whatever property of a node you want within a .customMatch call.

At the end of the chain, call .matches() to get a boolean result. If you need more information about the match success or failure, call .matchDetails() on the NodeMatcher.

A NodeMatcher is stateless. You can save a partially-constructed NodeMatcher and construct two different matchers based on it.

NodeMatcher

Type: Object

Properties
containsArgs (function (): NodeMatcher)
customMatch (function (nodeShouldMatchCallback: function ($Subtype<MdxNode>, NodeMatcher): boolean): NodeMatcher)
hasNArguments (function (n: number): NodeMatcher)
hasNCases (function (n: number): NodeMatcher)
isCase (function (): NodeMatcher)
isCompoundIdentifier (function (): NodeMatcher)
isFunction (function (): NodeMatcher)
isLevelCompoundIdentifier (function (): NodeMatcher)
isLiteral (function (): NodeMatcher)
isMeasure (function (): NodeMatcher)
isNegativeNumber (function (): NodeMatcher)
isNull (function (): NodeMatcher)
isNumber (function (): NodeMatcher)
isPositiveNumber (function (): NodeMatcher)
isScalar (function (): NodeMatcher)
isString (function (): NodeMatcher)
isWhen (function (): NodeMatcher)
matchDetails (function (): {matchFailReason: (string | null), node: MdxNode})
matches (function (): boolean)
or (function (): NodeMatcher)
subArg (function (argN: number, argMatcherCallback: NodeMatcherTransformer): NodeMatcher)
subCase (function (caseN: number, caseMatcherCallback: NodeMatcherTransformer): NodeMatcher)
subElse (function (elseCaseMatcherCallback: NodeMatcherTransformer): NodeMatcher)
subEveryArg (function (argMatcherCallback: NodeMatcherTransformer): NodeMatcher)
subThen (function (thenMatcherCallback: NodeMatcherTransformer): NodeMatcher)
subWhenCondition (function (whenMatcherCallback: NodeMatcherTransformer): NodeMatcher)
Static Members
subArg(argN, argMatcherCallback)
subEveryArg(argMatcherCallback)
subCase(caseN, caseMatcherCallback)
subElse(elseCaseMatcherCallback)
subWhenCondition(whenMatcherCallback)
subThen(thenMatcherCallback)
customMatch(nodeShouldMatchCallback)
matches()
matchDetails()
or()

NodeMatcherFactory

Provides a fluent API to match nodes in a parsed statement. Pass an MdxNode to this function to create a NodeMatcher that lets you write tests for the node and its children.

At the end of the chain, call .matches() to get a boolean result. If you need more information about the match success or failure, call .matchDetails() on the NodeMatcher.

NodeMatcherFactory

Type: function (MdxNode): NodeMatcher

Example
const nodeMatcher = activeUI.mdx.nodeMatcher(node);
const nodeIsAComparingFilterFunction = nodeMatcher
  .isFunction("Filter")
  .hasNArguments(2)
  .subArg(1, conditionMatcher =>
    conditionMatcher.isFunction("<", ">", "<=", ">=").hasNArguments(2)
  )
  .matches();
const isStringOrNullMatcher = activeUI.mdx.nodeMatcher(node).isString().or().isNull();
if (isStringOrNullMatcher.matches()) {
  console.log(node, 'is a string or is NULL');
} else {
  throw new Error('please pass a valid MdxNode');
}

NodeMatcherTransformer

A function that takes a NodeMatcher and returns a NodeMatcher. Usually a function like this will just call chaining methods on the given NodeMatcher to add checks, and return the new matcher.

NodeMatcherTransformer

Type: function (NodeMatcher): NodeMatcher

NoopLoggerParameters

A logger that does not log anything. This is to be used CAREFULLY, because it does not even log errors.

NoopLoggerParameters

Type: Object

Example
{
  key: 'noop',
  args: {}
}

NotChooseableFormatterImplementationStaticProperties

NotChooseableFormatterImplementationStaticProperties

Type: Object

Properties
defaultParameters ({}?)
isChoosableFromUI (false?)

NumericColumnsSelectorParameters

Creates a group of columns containing all the levels presenting measures (as opposed to members).

NumericColumnsSelectorParameters

Type: Object

Example
{
  key: 'numeric',
  args: {}
}

NumericScaleProfileImplementationProperties

A plugin used when computing numerical scales, in order to customize the mapping of a value on a scale.

NumericScaleProfileImplementationProperties

Type: Object

Properties
scale (function (value: number, domain: Array<number>): number) : For a given value and domain, return a value between 0 and 1, that will represent the percentage on the scale.

NumericScaleProfileImplementationStaticProperties

NumericScaleProfileImplementationStaticProperties

Type: Object

OpenAlertActionParameters

Opens a popup with the details of an alert.

OpenAlertActionParameters

Type: Object

Example
{
  key: 'open-alert',
  args: {}
}

OpenDrillthroughActionParameters

Opens a popup to choose where to display a drillthrough widget containing the result of the drillthrough on the given cell.

OpenDrillthroughActionParameters

Type: Object

Example
{
  key: 'open-drillthrough',
  args: {}
}

OpenMessageActionParameters

Opens a popup with the details of a message.

OpenMessageActionParameters

Type: Object

Example
{
  key: 'open-message',
  args: {}
}

openMonitorAction

openMonitorAction

OpenMonitorActionParameters

Opens a popup with the details of an alert.

OpenMonitorActionParameters

Type: Object

Example
{
  key: 'open-monitor',
  args: {}
}

OptimizedOrdinalColorScaleParameters

Color scale of size 9 inspired from http://www.mulinblog.com/a-color-palette-optimized-for-data-visualization/

OptimizedOrdinalColorScaleParameters

Type: Object

Example
{
  key: 'optimized',
  args: {}
}

OptionsForTranslation

OptionsForTranslation

Type: Object

Properties
textParameters (TranslationParameters?)
textPath (TranslationPath)

OptionsForTranslationSupportingReact

OptionsForTranslationSupportingReact

Type: Object

Properties
textParameters (ReactTranslationParameters?)
textPath (TranslationPath)

OrderDirection

OrderDirection

Type: ("ASC" | "DESC")

OrderedColumns

OrderedColumns

Type: Array<TabularHeaderKey>

OrderFunctionNode

An MdxFunctionNode that represents a call to the Order function.

OrderFunctionNode

Type: (MdxFunctionNode & Object)

Properties
name ("Order")

OrderMode

OrderMode

Type: ("ASC" | "DESC" | "BASC" | "BDESC")

OrderModeLiteralNode

A LiteralNode that represents one of the OrderMode strings.

OrderModeLiteralNode

Type: (LiteralNode & Object)

Properties
type ("STRING")
value (OrderMode)

OrdinalColorScaleImplementationProperties

Provide a set of colors given a set of values. Can be used to associate a particular color to a particular value

OrdinalColorScaleImplementationProperties

Type: Object

Properties
compute (function (values: Array<any>): Array<Color>) : the list of values for which a mapping should be found. Can be used to avoid mapping two values to the same color. Will loop cyclically if not enough color provided.

OrdinalColorScaleImplementationStaticProperties

OrdinalColorScaleImplementationStaticProperties

Type: Object

Properties
defaultParameters ({}?)

OriginalHeaderComparatorParameters

Keeps the headers in the same order than in the data table.

OriginalHeaderComparatorParameters

Type: Object

Example
{
  key: 'original',
  args: {}
}

OverlayCustomizableParameter

OverlayCustomizableParameter

Type: Object

Properties
caption (ReactTranslationPayload) : The caption to display next to the UI control.
name (string) : The name of the parameter, that will be written in the plugin parameters.
type (string) : The type of UI control.
value ((string | number)) : The default value to use for the UI control.

Parameter

Parameter

Type: Object

Properties
name (ParameterName)
pointValues (Array<PointValue>)

ParameterChanges

ParameterChanges

Type: Object

Properties
additions (Array<PointValue>?)
deletions (Array<ParameterReference>?)
name (string)
updates (Array<ParameterFromTo>?)

ParameterFromTo

ParameterFromTo

Type: Object

Properties
to (PointValue)

ParameterName

ParameterName

Type: string

ParameterQuery

ParameterQuery

Type: Object

Properties
parameter (ParameterName)
period.from (ActiveMonitorPeriod)
period.to (ActiveMonitorPeriod)

ParameterQueryResult

ParameterQueryResult

Type: Object

Properties
addedOrUpdatedPointValues (Array<PointValue>)
deletedPointValues (Array<PointValue>)
updatesTimestamp (Timestamp)

ParameterReference

ParameterReference

Type: Object

Properties
audit (number)
pointValue (number)

ParametersApi

ParametersApi

Type: Object

Properties
all (function (): Promise<Array<ParameterName>>) : Gets the name of all parameters ever having a defined point value.
get (function (ParameterName, boolean): Promise<Parameter>) : Gets the definition of a parameter. Optional flag to include pending point values in the definition.
query (function (Array<ParameterQuery>, boolean): Promise<Array<ParameterQueryResult>>) : Gets the changes that occurred for multiple parameters in a given time window. flag to include pending changes in the differencial view.
deleteWithoutWorkflow (function (ParameterName): Promise<void>) : Delete all values for a parameter. This will use the Repository api that does not trigger any workflow.
deleteAllWithoutWorkflow (function (): Promise<void>) : Delete all parameter entries from the repository. This will use the Repository api that does not trigger any workflow.
delete (function (ParameterName): Promise<void>) : Delete all values for a parameter. This will use the Repository api that does not trigger any workflow.
getEffective (function (ParameterName): Promise<Parameter>) : Gets the effective definition of a parameter: a parameter definition with only effective point values.
getHistory (function (ParameterName): Promise<Array<PointValue>>) : Gets the history of a parameter as the list of all versions of point values it owns.
suggest (function ((ParameterChanges | Array<ParameterQuery>), boolean?): Promise<(ParameterChanges | Array<ParameterQueryResult>)>) : Suggests updates for parameters. This will use ActiveMonitor workflows to perform the changes. Second parameter us a useUpdates flag indicating if the change definitions are full parameter definitions or update definitions to be merged.
createFeed (function (): FeedInfo)

PercentageFormatterParameters

Formats axis tick labels into a percentage format. e.g. .1 -> 10%

PercentageFormatterParameters

Type: Object

Properties
decimal (number) : number of decimal points to include in the formatted number. Integers will have decimal number of 0's appended. e.g. decimal(2) .1 -> 10.00%
Example
{
  key: 'percentage',
  args: {
    decimal: /* number */
  }
}

PermissionGroup

PermissionGroup

Type: (Username | Role)

PermissionGroups

PermissionGroups

Type: Array<PermissionGroup>

Permissions

Permissions

Type: Object

Properties
owners (PermissionGroups)
readers (PermissionGroups)

PivotTableToggleGrandTotalActionParameters

Show / Hide the grand total on rows

PivotTableToggleGrandTotalActionParameters

Type: Object

Example
{
  key: 'pivot-table-toggle-grand-total',
  args: {}
}

PivotTableToggleSubTotalsActionParameters

Show / Hide the sub total on rows

PivotTableToggleSubTotalsActionParameters

Type: Object

Example
{
  key: 'pivot-table-toggle-subtotals',
  args: {}
}

PluginDescription

PluginDescription

Type: Object

Properties
createProperties (function (parameters: PluginParameters<any, any>, activeUI: ActiveUI): {}?) : Should return an object matching the type of the corresponding plugin properties.
key (PluginKey) : Used to reference this plugin implementation. This key will be used to declare the plugin in the configuration of a component. The couple (type, key) should be unique among your project to avoid any conflicts.
parametersSerializationFn (PluginParametersSerializationFn?) : Needs to be given when the implementation requires some parameters.
staticProperties ({}?) : Should be an object matching the type of the corresponding plugin static properties.

PluginDescriptionWithType

A PluginDescription with an additional type property.

PluginDescriptionWithType

Type: (PluginDescription & Object)

Properties
type (PluginType)

PluginKey

PluginKey

Type: string

PluginParameters

The implementation has access to a merged object containing the type and implementations parameters.

PluginParameters

Type: (ImplementationParameters & TypeParameters)

PluginParametersSerializationFn

Indicates how to serialize and deserialize the parameters of a plugin implementation. For example: s13n => [{name: 'myParameter', sn: s13n.number}]

PluginParametersSerializationFn()

Type: Function

PluginType

PluginType

Type: string

PointValue

PointValue

Type: Object

Properties
activation (Timestamp?)
coordinates ({})
createdAt (AuditTimeInfo)
deletedAt (AuditTimeInfo?)
expiration (Timestamp?)
id (number)
name (string)
pending (boolean)
value (number)

PopupEventBus

PopupEventBus

Type: Object

Properties
addEventListener (function (type: any, callback: function (): void): function (): void)
dispatch (function (type: any): void)

PopupImplementationProperties

Create a popup, to be used in the UI.

PopupImplementationProperties

Type: Object

Properties
additionalBindings (function (): Array<{binding: BindingWrapper, name: string}>)
isModal (boolean?)
multiBindingInit (function (multiBinding: MultiBinding, parameters: any, activeUI: ActiveUI): void?)
render (function (multiBinding: MultiBinding, defaultClosePopup: ClosePopup): React.Element<any>)
shouldRender (function (parameters: any): boolean)

PopupImplementationStaticProperties

PopupImplementationStaticProperties

Type: Object

PopupOptions

Optional behaviors that can be customized on the popup.

PopupOptions

Type: Object

Properties
afterClose (function (): void?) : a function to execute after closing the popup
autoClose (boolean?) : if true, closes the popup whenever the user clicks outside of it. Keep the popup open otherise
closePopup (ClosePopup?) : a function to call to close the popup instead of the default one
decorate (function (PopupReactClass): React.ComponentType<any>?)
initialSize (PopupSize?)
isModal (boolean?)
isResizable (boolean?)
multiBindingInit (function (multiBinding: MultiBinding, parameters: any, activeUI: ActiveUI): void?)

PopupPluginBuilder

PopupPluginBuilder

Type: Object

Properties
register (function (): PopupContent) : register and create the serializable Popup, not allowing for overrides
registerOverride (function (): PopupContent) : register and create the serializable Popup as an override
withAutoClose (function (): PopupPluginBuilder) : auto close when clicking outside of the Popup
withCancel (function (cancelCallback: Todo, cancelText: string): PopupPluginBuilder) : Add action for popup cancel buttoncreate
withKey (function (key: string): PopupPluginBuilder) : the key for the plugin
withReactClass (function (PopupClass: Todo): PopupPluginBuilder) : the React class to use for the content of the Popup
withSubmit (function (submitCallback: Todo, submitText: string): PopupPluginBuilder) : Add action for popup submit button
withStyle (function (style: {}): PopupPluginBuilder) : the style for the Popup
withTitle (function (title: string): PopupPluginBuilder) : the title to give to the Popup
withShouldRender (function (shoudRenderFn: function (): boolean): PopupPluginBuilder) : should the popup render or not, based on the return value of the function
withCheckedParameters (function (parametersFunction: PluginParametersSerializationFn): PopupPluginBuilder) : the parameters function
withoutDrag (function (): PopupPluginBuilder) : Removes the drag feature of the Popup

PopupReactClass

PopupReactClass

Type: Class

PopupWidgetBuilder

The PopupBuilder

PopupWidgetBuilder

Type: Object

Properties
inBinding (function (bindingName: string): PopupWidgetBuilder) : private
withKey (function (key: string): PopupWidgetBuilder) : The Popup plugin key
withDeserializedParameters (function (parameters: {}): PopupWidgetBuilder) : The Popup parameters, deserialized, to pass to the popup factory
withParameters (function (parameters: {}): PopupWidgetBuilder) : The Popup parameters, already serialized, to pass to the popup factory
anchoredFrom (function (e: AnyEvent, asPercentage: AsPercentage): PopupWidgetBuilder) : Set where the popup position should be anchored from. The position is extracted from the mouse event, meant to be used by the popup to render
asModal (function (): PopupWidgetBuilder) : Call if the background should become grey behind the popup
create (function (): (function (): void | void)) : Create the popup. Return a function to close the popup

PortalServer

PortalServer

Type: (Server & Object)

Properties
startApplication (function (string): Promise<void>) : Start an application and return a promise which will resolve when the application is in a started state
stopApplication (function (string, string): Promise<void>) : Stop an application providing its name and the reason of the stop (used for audit purposes). Return a promise which will resolve when the application is in a stopped state
fetchApplications (function (): Promise<void>)
getApplication (function (string): CloudApplication)
getApplications (function (): Array<CloudApplication>)

PortalServerParameters

PortalServerParameters

Type: (SavedServerParameters & Object)

Properties
contentServer (ContentServer)

PublishCalculatedMeasureActionParameters

Open a popup to publish a calculated measure, moving its definition from the widget’s MDX to the content server.

PublishCalculatedMeasureActionParameters

Type: Object

Example
{
  key: 'publish-calculated-measure',
  args: {}
}

QueriesApi

API entry point for all queries to remote servers.

QueriesApi

Type: Object

Properties
createStaticDataQuery (function (): StaticDataQuery)
queriesPool (QueriesPool)
serversPool (ServersPool)

QueriesPool

QueriesPool

Type: Object

Properties
addQuery (function (Query): QueryId)
getQueries (function (): Array<Query>)
getQuery (function (QueryId): Query)

Query

Query

Type: Todo

QueryEditorActionParameters

Open a popup to edit the mdx and context values of the widget

QueryEditorActionParameters

Type: Object

Properties
readOnly (boolean) : A flag to make the mdx and context values read-only
Example
{
  key: 'query-editor',
  args: {
    readOnly: /* boolean */
  }
}

QueryId

QueryId

Type: number

QuotingValue

QuotingValue

Type: ("QUOTED" | "UNQUOTED" | "AMP_QUOTED")

Properties
QUOTED (string) : Quoted identifier, for example [Geography] .
UNQUOTED (string) : Unquoted identifier, for example Geography .
AMP_QUOTED (string) : Identifier quoted with an ampersand to indicate a key value, for example the second segment in [Geography].&[France] .

Range

For a given axis, the actual slice of the server result that will be passed to the client on the network.

Range

Type: Object

Properties
from (number)
to (number)

RangeConfiguration

Example: for the rows axis, a thresholdPercentage of 0.1 for a chunkSize of 2000 means that the initial table will load the rows 0 to 2000, and when scrolling past row 1800, a new chunk of 2000 rows centered on 1800 will be downloaded from 800 to 2800, and so on. To disable lazy loading, set chunkSize to -1 and any thresholdPercentage.

RangeConfiguration

Type: Object

Properties
chunkSize (number) : how many rows/columns are downloaded
thresholdPercentage (number) : defines when to trigger a new range update.

Ranges

For each axis, the actual range of results that is being queried from the server.

Ranges

Type: Object

Properties
column (Range?)
row (Range?)

RangesConfiguration

On the client side, configure the lazy-loading of featured values, pivot tables and tabular views for each axis, i.e. the ability to defer the download of a subset of the results at the time the user is scrolling through them.

RangesConfiguration

Type: Object

Properties
column (RangeConfiguration?)

RawFormatterParameters

Formats axis tick labels to show just the numerical value without any group separation or other decoration 1,000,000 -> 1000000

RawFormatterParameters

Type: Object

Example
{
  key: 'raw',
  args: {}
}

ReactContainerApi

ReactContainerApi

Type: Object

Properties
bindQuery (function (Query): function (): void) : Add the query to the list of this container's data sources. Returns a function to unbind the query. This should be called synchronously when the container mounts, otherwise it might not be picked up by some widgets on the dashboard (e.g. Mdx Editor).
getChildrenMap (function (): {})
getDataSources (function (): Array<DataSource>)
getValue (function (): ReactContainerBody)
setValue (function (ReactContainerBody): void)

ReactContainerBody

A serializable object.

ReactContainerBody

Type: Object

ReactContainerComponentProps

ReactContainerComponentProps

Type: Object

Properties
containerApi (ReactContainerApi)
onChange (function (ReactContainerBody): void)

ReactContainerImplementationProperties

Nothing, everything declared in ReactContainerImplementationStaticProperties.

ReactContainerImplementationProperties

Type: