Types
AccessLog
Property | Type | Description |
---|---|---|
id | string | |
lastOpened | number |
Action
The Redux actions dispatched by Atoti UI to update its state.
- ActivePageChangedAction
- ActiveToolChangedAction
- DashboardLoadedAction
- DashboardUnloadedAction
- DashboardUpdatedAction
- DashboardSavedAction
- ExpandDataModelTreeAction
- CollapseDataModelTreeAction
- IsOpenDashboardPopupVisibleAction
- IsSettingsPopupVisibleAction
- IsPresentingAction
- StatusNotificationAddedAction
- StatusNotificationSettledAction
- StatusNotificationRemovedAction
- IsDeferredAction
- ResourcesPanelChangedAction
- WidgetSelectedAction
- ExpandedFolderPathsInHomePageAction
ActionProps
- WidgetActionProps<WidgetState, SelectionType>
- WidgetInDashboardActionProps<WidgetState, SelectionType>
ActivePageChangedAction
Redux action to change the active dashboard page. See activePageKey
in State.
Property | Type | Description |
---|---|---|
pageKey | string | |
type | "activePageChanged" |
ActivePivotClient
Provides methods to interact with an ActivePivot server:
-
Allows to run MDX queries against ActivePivot via a websocket.
-
Allows to perform REST calls against ActivePivot.
Property | Type | Description |
---|---|---|
serverVersion | string | The server's version. |
serviceVersion | ServiceVersion | The version of the APIs offered by the server's REST and websocket endpoints. |
url | string | The server's URL. |
calculatedMembers | { [cubeName: string]: { calculatedMembers?: { [name: string]: { owners: string[]; readers: string[]; }; }; isLoading: boolean; error?: Error; }; } | The list of calculated members per cube, if they are already loaded. See loadCalculatedMembers . |
connectionStatus | ConnectionStatus | The current connection status of the client. |
dataModel | DataModel | undefined | The DataModel if it is already loaded. See loadDataModel . |
dataModelLoadingError | DataModelLoadingError | undefined | The error received from the server in case the data model could not be loaded. |
drillthroughColumns | { [cubeName: string]: { drillthroughColumns?: DrillthroughColumn[]; isLoading: boolean; error?: Error; }; } | The list of DrillthroughColumn per cube, if they are already loaded. See loadDrillthroughColumns . |
isDataModelLoading | boolean | Whether the DataModel is still loading. |
Method | Description |
---|---|
addCalculatedMembersListener | Deprecated: Use subscribeToCalculatedMembers instead. |
addConnectionStatusListener | Deprecated: Use subscribeToConnectionStatus instead. |
addDataModelListener | Deprecated: Use subscribeToDataModel instead. |
addDrillthroughColumnsListener | Deprecated: Use subscribeToDrillthroughColumns instead. |
addQueryListener | Deprecated: Use subscribeToQuery instead. |
addQueryResultListener | Deprecated: Use subscribeToQueryResult instead. |
connect | Asynchronously connects the client to the ActivePivot server's query streaming service. Resolves immediately if the client is already connected. |
createCalculatedMember | Asynchronously creates a calculated member in the cube identified by cubeName . |
createKpi | Asynchronously creates a Kpi in the cube identified by cubeName . |
deleteCalculatedMember | Asynchronously deletes a calculated member from the cube identified by cubeName . |
deleteKpi | Asynchronously deletes a Kpi from the cube identified by cubeName . |
disconnect | Disconnects the client from the ActivePivot server's query streaming service. |
getQuery | Returns the Query identified by queryId if it exists. |
getQueryResult | Returns the latest QueryResult for the Query identified by queryId . |
loadCalculatedMembers | Asynchronously returns the calculated members defined in the cube identified by cubeName . The loaded calculated members are then accessible using addCalculatedMembersListener . |
loadDataModel | Asynchronously loads the DataModel, making it available through ActivePivotClient. Can be called several times to load an up-to-date version. |
loadDrillthroughColumns | Asynchronously loads the list of DrillthroughColumn for cube cubeName , making it available through ActivePivotClient. |
refreshQuery | Re-executes a paused query once. |
removeCalculatedMembersListener | Deprecated: Use subscribeToCalculatedMembers instead. |
removeConnectionStatusListener | Deprecated: Use subscribeToConnectionStatus instead. |
removeDataModelListener | Deprecated: Use subscribeToDataModel instead. |
removeDrillthroughColumnsListener | Deprecated: Use subscribeToDrillthroughColumns instead. |
removeQueryListener | Deprecated: Use subscribeToQuery instead. |
removeQueryResultListener | Deprecated: Use subscribeToQueryResult instead. |
setQuery | Updates the Query identified by queryId or register it if it did not exist. Marks the query as loading and sends a message to the server. |
subscribeToCalculatedMembers | Registers callback to be called when the calculated members of the cube identified by cubeName change. |
subscribeToConnectionStatus | Registers callback to be called whenever the client status changes. |
subscribeToDataModel | Registers callback to be called whenever the data model changes. |
subscribeToDrillthroughColumns | Registers callback to be called whenever the drillthrough columns change. |
subscribeToQuery | Registers callback to be called whenever the Query identified by queryId is updated. |
subscribeToQueryResult | Registers callback to be called whenever a new QueryResult is received for the Query identified by queryId . |
updateCalculatedMember | Asynchronously updates a calculated member in the cube identified by cubeName . |
ActiveToolChangedAction
Redux action to change the active tool. See activeToolKey
in State.
Property | Type | Description |
---|---|---|
toolKey | string | null | |
type | "activeToolChanged" |
Activity
Information about the past usage of Atoti by the current user. Useful to provide shortcuts to recently used elements, and more. Regroups all pieces of information stored on the Content Server, belonging to a user and which are not settings.
Property | Type | Description |
---|---|---|
lastUsedCube | { cubeName: CubeName; serverKey: string; } | The name and the server key of the last cube selected by the user. It controls which cube is targeted when creating a new widget. |
recentlyOpenedDashboards | AccessLog[] | The ids of the dashboards recently opened by the current user, ordered by last opened |
userFilters | Filter<T>[] | Filters attached to the current user and applying to all dashboards she visits. |
userQueryContext | QueryContextEntry[] | Query context attached to the current user and applying to all dashboards they visit. |
ActivityListener
Deprecated
Use ContentClient.getActivity()
and ContentClient.subscribeToActivity()
instead.
(value: Activity[K]) => void