> ## Documentation Index > Fetch the complete documentation index at: https://docs.activeviam.com/llms.txt > Use this file to discover all available pages before exploring further. # Types ## AccessLog | Property | Type | Description | | :--------- | :----- | :---------- | | id | string | | | lastOpened | number | | ## Action The Redux actions dispatched by Atoti UI to update its state. * [ActiveToolChangedAction](types#activetoolchangedaction) * [ActiveToolChangedAndDataModelExpandedAction](types#activetoolchangedanddatamodelexpandedaction) * [DashboardLoadedAction](types#dashboardloadedaction) * [DashboardUnloadedAction](types#dashboardunloadedaction) * [DashboardUpdatedAction](types#dashboardupdatedaction) * [DashboardSavedAction](types#dashboardsavedaction) * [OpenCommandPaletteAction](types#opencommandpaletteaction) * [CloseCommandPaletteAction](types#closecommandpaletteaction) * [ExpandDataModelTreeAction](types#expanddatamodeltreeaction) * [CollapseDataModelTreeAction](types#collapsedatamodeltreeaction) * [IsMoveDashboardModalVisibleAction](types#ismovedashboardmodalvisibleaction) * [IsOpenDashboardPopupVisibleAction](types#isopendashboardpopupvisibleaction) * IsSaveDashboardAsModalVisibleAction * IsShareDashboardModalVisibleAction * [IsSettingsPopupVisibleAction](types#issettingspopupvisibleaction) * [IsToolsPanelExpandedAction](types#istoolspanelexpandedaction) * [IsPresentingAction](types#ispresentingaction) * [StatusNotificationAddedAction](types#statusnotificationaddedaction) * [StatusNotificationSettledAction](types#statusnotificationsettledaction) * [StatusNotificationRemovedAction](types#statusnotificationremovedaction) * [IsDeferredAction](types#isdeferredaction) * [ResourcesPanelChangedAction](types#resourcespanelchangedaction) * [WidgetSelectedAction](types#widgetselectedaction) * [ExpandedFolderPathsInHomePageAction](types#expandedfolderpathsinhomepageaction) * [WidgetsPanelClosedAction](types#widgetspanelclosedaction) * [WidgetsPanelOpenedAction](types#widgetspanelopenedaction) * [WidgetsPanelWidthChangedAction](types#widgetspanelwidthchangedaction) * [SelectionWithinWidgetClearedAction](types#selectionwithinwidgetclearedaction) * [SelectionWithinWidgetChangedAction](types#selectionwithinwidgetchangedaction) * ContentClientAction * MultiAtotiClientAction ## ActionProps * [WidgetActionProps](types#widgetactionprops)\ * [WidgetInDashboardActionProps](types#widgetindashboardactionprops)\ ## ActiveToolChangedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to change the active tool tab. See `activeToolKey` in [State](types#state). | Property | Type | Description | | :------- | :------------------ | :---------- | | toolKey | string \| null | | | type | "activeToolChanged" | | ## ActiveToolChangedAndDataModelExpandedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to expand the data model and change the active tool. See `activeToolKey` in [State](types#state). | Property | Type | Description | | :------- | :-------------------------------------- | :---------- | | toolKey | string \| null | | | type | "activeToolChangedAndDataModelExpanded" | | ## 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](types#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](types#accesslog)\[] | The ids of the dashboards recently opened by the current user, ordered by last opened | | userFilters | [Filter](types#filter)\\[] | Filters attached to the current user and applying to all dashboards she visits. | | userQueryContext | [QueryContextEntry](types#querycontextentry)\[] | Query context attached to the current user and applying to all dashboards they visit. | ## ADataModelNode A node in a data model tree, under a cube. | Property | Type | Description | | :----------- | :------ | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | cubeName | string | | | serverKey | string | | ## AdvancedFilter * [FilterOnTopBottomMembers](types#filterontopbottommembers) * [FilterOnLowerOrGreaterValues](types#filteronlowerorgreatervalues) * [FilterOnValuesRange](types#filteronvaluesrange) * [FilterOnLowerOrGreaterCaptions](types#filteronlowerorgreatercaptions) * [FilterOnCaptionsRange](types#filteroncaptionsrange) * [FilterOnCaptionContaining](types#filteroncaptioncontaining) * [FilterOnExistenceOfValue](types#filteronexistenceofvalue) * [FilterOnRecentDates](types#filteronrecentdates) ## AdvancedFilterType * "topBottomMembers" * "lowerOrGreaterValue" * "valuesRange" * "lowerOrGreaterCaptions" * "captionsRange" * "captionsContaining" * "existenceOfValue" * "recentDates" ## AFieldStyle The style applied to the values of a [Measure](types#measure) or the members of a [Hierarchy](types#hierarchy) in the target widget. | Property | Type | Description | | :--------------- | :--------------------------------- | :---------- | | dateFormat | string | | | numberFormat | [NumberFormat](types#numberformat) | | | numberOfDecimals | number | | ## AFilter A filter is always contextual to a hierarchy [HierarchyCoordinates](types#hierarchycoordinates) & [PinnableFilter](types#pinnablefilter) & \{
   isExclusionFilter?: boolean;
   nonVisualTotals?: boolean;
} ## AFolderPermissionUpdateParams The type of the part of the argument of contentClient.updateFolderPermissions that is always accepted by the method, whether or not the update is recursive. | Property | Type | Description | | :----------------- | :------------------------------- | :---------- | | id | string | | | pathToParentFolder | string\[] | | | type | [ContentType](types#contenttype) | | ## AllMeasuresInMapping A tile in the widget mapping, representing all measures. | Property | Type | Description | | :------- | :------------ | :---------- | | type | "allMeasures" | | ## Allowlist A list of strings representing allowed entities, e.g. which tools should be shown in Atoti, or "\*" if there are no restrictions. * T\[] * "\*" ## AMdxCompoundIdentifier The common attributes shared by all types of [MdxCompoundIdentifier](types#mdxcompoundidentifier). | Property | Type | Description | | :---------- | :-------------------------------------- | :---------- | | elementType | "CompoundIdentifier" | | | identifiers | [MdxIdentifier](types#mdxidentifier)\[] | | ## AMetaData | Property | Type | Description | | :------- | :------ | :---------- | | isFolder | boolean | | | name | string | | ## ANode | Property | Type | Description | | :----------- | :------ | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | ## APlugin Type extended by every plugin type. Each plugin must specify its key and can come with its own translations. | Property | Type | Description | | :----------- | :--------------------------------------------------------------------------------------- | :---------- | | key | string | | | translations | \{
   \[locale: string]: [TranslationTree](types#translationtree)\;
} | | ## ApplicationMenu A menu that is displayed in the header of the application. * [ApplicationSubMenu](types#applicationsubmenu) * [ApplicationMenuItem](types#applicationmenuitem) ## ApplicationMenuItem A menu item that is displayed in the header of the application. | Property | Type | Description | | :------- | :----- | :---------- | | key | string | | | Method | Description | | :---------- | :---------- | | useMenuItem | | ## ApplicationSubMenu A submenu within the menu in the header of the application. The children can be more submenus, or menu items. | Property | Type | Description | | :------- | :------------------------------------------ | :---------- | | key | string | | | children | [ApplicationMenu](types#applicationmenu)\[] | | | Method | Description | | :---------- | :---------- | | useMenuItem | | ## Argument * "PLACE\_HOLDER" /\*\* \* boolean, int, double, date, … \*/ * "SCALAR" /\*\* \* function keyword \*/ * "KEYWORD" /\*\* \* string (means will be surrounded by single quotes) \*/ * "STRING" ## ASettingDefinition Attributes common to all types of setting definitions. | Property | Type | Description | | :----------- | :------------------------------------------ | :---------- | | defaultValue | V | | | key | K | | | searchTokens | string\[] | | | translations | [PerLocale](types#perlocale)\ | | ## ASettingTranslations \{
   title: string;
   description: string;
} ## AtotiClient Provides methods to interact with an Atoti server: * Allows to run MDX queries via a websocket. * Allows to perform REST calls. | Property | Type | Description | | :-------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- | | serverVersion | string | The server's version. | | serviceVersion | [ServiceVersion](types#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](types#connectionstatus) | The current connection status of the client. | | dataModel | [DataModel](types#datamodel) \| undefined | The [DataModel](types#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](types#drillthroughcolumn)\[];
     isLoading: boolean;
     error?: Error;
  };
} | The list of [DrillthroughColumn](types#drillthroughcolumn) per cube, if they are already loaded. See loadDrillthroughColumns. | | isDataModelLoading | boolean | Whether the [DataModel](types#datamodel) is still loading. | | namedSets | \{
   \[cubeName: string]: \{
     namedSets?: \{
       \[name: string]: \{
         owners: string\[];
         readers: string\[];
      };
    };
     isLoading: boolean;
     error?: Error;
  };
} | The list of named sets per cube, if they are already loaded. See loadNamedSets. | | Method | Description | | :----------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | cancelQuery | Cancels the [Query](types#query) identified by queryId. Unregisters the query and marks it as canceled by setting isCanceled to true. | | connect | Asynchronously connects the client to the Atoti 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](types#kpi) in the cube identified by cubeName. | | createNamedSet | Asynchronously creates a named set in the cube identified by cubeName. | | deleteCalculatedMember | Asynchronously deletes a calculated member from the cube identified by cubeName. | | deleteKpi | Asynchronously deletes a [Kpi](types#kpi) from the cube identified by cubeName. | | deleteNamedSet | Asynchronously deletes a named set from the cube identified by cubeName. | | disconnect | Disconnects the client from the Atoti server's query streaming service. | | getQuery | Returns the [Query](types#query) identified by queryId if it exists. The returned query includes an optional isCanceled flag indicating whether the query was canceled. | | getQueryResult | Returns the latest [QueryResult](types#queryresult) for the [Query](types#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](types#datamodel), making it available through [AtotiClient](types#atoticlient). Can be called several times to load an up-to-date version. | | loadDrillthroughColumns | Asynchronously loads the list of [DrillthroughColumn](types#drillthroughcolumn) for cube cubeName, making it available through [AtotiClient](types#atoticlient). | | loadNamedSets | Asynchronously returns the named sets defined in the cube identified by cubeName. The loaded named sets are then accessible using subscribeToNamedSets. | | refreshQuery | Re-executes a paused query once. | | setQuery | Updates the [Query](types#query) identified by queryId or register it if it did not exist. Marks the query as loading and sends a message to the server. If passed, the initialHeaders received during the first call for this query are added to the "REGISTER" websocket message. initialHeaders received on subsequent calls are disregarded. Indeed, the ones attached to the "REGISTER" message are then also attached to the following "UPDATE" messages for this query. | | 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. | | subscribeToNamedSets | Registers callback to be called when the named sets of the cube identified by cubeName change. | | subscribeToQuery | Registers callback to be called whenever the [Query](types#query) identified by queryId is updated. | | subscribeToQueryResult | Registers callback to be called whenever a new [QueryResult](types#queryresult) is received for the [Query](types#query) identified by queryId. | | updateCalculatedMember | Asynchronously updates a calculated member in the cube identified by cubeName. | ## AtotiClientConstructorArgs Arguments for creating an [AtotiClient](types#atoticlient) instance. If no store is provided, one is created internally. See [createAtotiClient](functions#createatoticlient). | Property | Type | Description | | :------------- | :----------------------------------------- | :---------- | | pingPeriod | number | | | requestInit | RequestInit | | | serverVersion | string | | | serviceVersion | [ServiceVersion](types#serviceversion) | | | store | [AtotiClientStore](types#atoticlientstore) | | | url | string | | ## AtotiClientStore The store in which the client reads and writes its state. See [AtotiClientConstructorArgs](types#atoticlientconstructorargs). [StaticStore](types#staticstore)\ ## AttributeRole Attribute roles define what happens when the user switches from one type of widget to another. For instance, when the user switches from a pivot table to a line chart, the fields belonging to each role are mapped to the attributes of the same role in the target widget. In the case of a line chart `xAxis` is `primaryOrdinal`, `values` is `primaryNumeric`, `splitBy` is `secondaryOrdinal` and `secondaryValues` (values mapped to the secondary Y axis) is `secondaryNumeric`. In the case of a pivot table `rows` is `primaryOrdinal`, `measures` is `primaryNumeric` and `columns` is `secondaryOrdinal`. * "primaryNumeric" * "primaryOrdinal" * "secondaryNumeric" * "secondaryOrdinal" * "subplot" ## AWidgetState The state of any widget. Note that each individual widget plugin typically extends this type. If linked to a saved widget, contains a reference to its `id` and the `version` that was used when the copy was made. See [WidgetMetaData](types#widgetmetadata) IsLinkedToSavedWidget extends true ? [AWidgetState](types#awidgetstate)\ & \{
   version: number;
   id: string;
   hasDivergedFromOriginal: boolean;
} : \{
   isFullScreen?: boolean;
   filters?: [Filter](types#filter)\\[];
   filterFolders?: [FilterFolder](types#filterfolder)\[];
   queryContext?: [QueryContextEntry](types#querycontextentry)\[];
   name?: string;
   widgetKey: string;
   behavior?: WidgetBehavior;
} ## Axis | Property | Type | Description | | :------------------- | :------------------------------------------------------------------------------------------------------------------------------ | :---------- | | hierarchies | \{
   dimension: [DimensionName](types#dimensionname);
   hierarchy: [HierarchyName](types#hierarchyname);
}\[] | | | id | [AxisId](types#axisid) | | | maxLevelPerHierarchy | number\[] | | | positions | [Member](types#member)\[]\[] | | | range | [AxisRange](types#axisrange) | | ## AxisId * -1 * 0 * 1 * 2 * 3 * 4 ## AxisName * "SLICER" * "COLUMNS" * "0" * "ROWS" * "1" * "PAGES" * "CHAPTERS" * "SECTIONS" ## AxisRange | Property | Type | Description | | :--------- | :------ | :---------- | | from | number | | | to | number | | | axisLength | number | | | entireAxis | boolean | | ## BaseDashboardPageState The base state of a dashboard page. `content` contains the state of each leaf. \{
   name: string;
   filters?: [Filter](types#filter)\\[];
   filterFolders?: [FilterFolder](types#filterfolder)\[];
   queryContext?: [QueryContextEntry](types#querycontextentry)\[];
   content: \{
     \[leafKey: string]: WidgetStateType;
  };
} ## BasicDashboardProps | Property | Type | Description | | :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------ | | activePageKey | string | | | className | string | Deprecated: Will be removed in 5.3. | | initialPageState | Omit\<[DashboardPageState](types#dashboardpagestate), "name"> | | | isExportingToPDF | boolean | | | LeafComponent | ComponentType\ | | | onActivePageChange | (newActivePageKey: string) => void | | | onChange | (newState: [DashboardState](types#dashboardstate)) => void | | | onLoaded | () => void | | | onSelectionChange | (newSelection: \{
   pageKey: string;
   leafKey: string;
   selection: [SelectionWithinWidget](types#selectionwithinwidget);
}) => void | | | onWidgetSelected | (newSelectedLeafKey: string) => void | | | selectedLeafKey | string | | | selection | \{
   \[pageKey: string]: \{
     \[leafKey: string]: [SelectionWithinWidget](types#selectionwithinwidget);
  };
} | | | state | [DashboardState](types#dashboardstate) | | | style | CSSProperties | Deprecated: Will be removed in 5.3. | | tabBarExtraContent | ReactNode | | | tabsBarLeftExtraContent | ReactNode | | ## CalculatedMeasureEditionHandlers The handlers called upon editing a calculated measure. | Property | Type | Description | | :-------------------------------------- | :--------------------------------------- | :---------- | | onAfterCalculatedMeasureSaved | CalculatedMeasureSubmitCallback\<"cube"> | | | onAfterCalculatedMeasureSavedAndApplied | CalculatedMeasureSubmitCallback\<"cube"> | | ## CalendarFilter * [FilterOnDateRange](types#filterondaterange)\ * [FilterOnTimePeriodToDate](types#filterontimeperiodtodate) * [FilterOnPreviousOrNextTimePeriods](types#filteronpreviousornexttimeperiods) * [FilterOnSeasonalPattern](types#filteronseasonalpattern) ## CalendarFilterType * "timePeriodToDate" * "previousOrNextTimePeriods" * "dateRange" * "seasonalPattern" ## Catalog | Property | Type | Description | | :------- | :------------------------------------------------------------------------------------------------------------------------ | :---------- | | cubes | T extends "raw" ? [Cube](types#cube)\<"raw">\[] : \{
   \[cubeName: string]: [Cube](types#cube)\<"indexed">;
} | | | name | string | | ## CatalogNode A data model tree node representing a catalog | Property | Type | Description | | :----------- | :-------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | type | "catalog" | | ## Cell | Property | Type | Description | | :------------- | :------------------------------------------------------------------------------------------------------- | :---------- | | formattedValue | string | | | ordinal | number | | | properties | \{
   \[key in [CellProperty](types#cellproperty)]?: null \| string \| number \| undefined;
} | | | value | number \| string | | ## CellPlugin Plugin useful for cell Components usable on table widgets. | Property | Type | Description | | :----------- | :--------------------------------------------------------------------------------------- | :---------- | | key | string | | | translations | \{
   \[locale: string]: [TranslationTree](types#translationtree)\;
} | | | Cell | ForwardRefExoticComponent\> | | ## CellPluginForCellSetTable Most used variant of [CellPlugin](types#cellplugin), suitable for table widgets representing a [CellSet](types#cellset). [CellPlugin](types#cellplugin)\<[CellSetTableCellProps](types#cellsettablecellprops)> ## CellProperty Properties attached to each cell in a [CellSet](types#cellset). In Atoti UI, these properties are used for styling. See [https://learn.microsoft.com/en-us/analysis-services/multidimensional-models/mdx/mdx-cell-properties-using-cell-properties?view=asallproducts-allversions](https://learn.microsoft.com/en-us/analysis-services/multidimensional-models/mdx/mdx-cell-properties-using-cell-properties?view=asallproducts-allversions) * "BACK\_COLOR" * "FORE\_COLOR" * "FONT\_NAME" * "FONT\_FLAGS" * "FONT\_SIZE" * "FORMAT\_STRING" ## CellProps Type extended by the props of [CellPlugin](types#cellplugin) `Cell` components. | Property | Type | Description | | :------------------ | :----------------------------- | :---------- | | caption | string | | | className | string | | | columnIndex | number | | | height | number | | | isColumnFrozen | boolean | | | isRowFrozen | boolean | | | isSticky | boolean | | | isVirtualized | boolean | | | left | number | | | parentTotalRowIndex | number | | | rowIndex | number | | | size | "small" \| "medium" \| "large" | | | style | CSSProperties | | | top | number | | | value | string \| number | | | width | number | | | wrapText | boolean | | ## CellSet | Property | Type | Description | | :------------- | :-------------------------------------- | :---------- | | axes | [Axis](types#axis)\[] | | | cells | [Cell](types#cell)\[] | | | cube | [CubeName](types#cubename) | | | defaultMembers | [DefaultMember](types#defaultmember)\[] | | | epoch | number | | ## CellSetAxesSelection The tuples and levels corresponding to the selected positions (which can be headers in a table or ticks on a chart's axes). * \{ id: [AxisId](types#axisid); hierarchies?: (([LevelCoordinates](types#levelcoordinates) * \{
   dimensionName: "Measures";
   hierarchyName: "Measures";
}) &
\{
   isFullySelected?: boolean;
})\[];
positions?: [Tuple](types#tuple)\[];
positionIndices?: number\[];
fullySelectedPositionIndices?: [Set](types#set)\;
}\[] ## CellSetCellsSelection The tuple and value corresponding to each selected [Cell](types#cell) (which can be body cells in a table, or points on a chart). * \{ tuple: [Tuple](types#tuple); value?: number * string; }\[] ## CellSetSelection A selection of cells, positions and levels in a [CellSet](types#cellset). \{
   axes?: [CellSetAxesSelection](types#cellsetaxesselection);
   cells?: [CellSetCellsSelection](types#cellsetcellsselection);
} ## CellSetTableBodyCellProps The props of body cells in a [CellSetTable](components#cellsettable). [LoadingTableCellProps](types#loadingtablecellprops) & [DerivedCellSetTableBodyCellProps](types#derivedcellsettablebodycellprops) & CellSetTableCellPropsFromAxis ## CellSetTableCellProps The props of cells in a [CellSetTable](components#cellsettable). * [LoadingTableCellProps](types#loadingtablecellprops) * [CellSetTableBodyCellProps](types#cellsettablebodycellprops) * [CellSetTableHeaderCellProps](types#cellsettableheadercellprops) * [CellSetTableStaticHeaderCellProps](types#cellsettablestaticheadercellprops) ## CellSetTableHeaderCellProps The props of header cells in a [CellSetTable](components#cellsettable). [LoadingTableCellProps](types#loadingtablecellprops) & [DerivedCellSetTableHeaderCellProps](types#derivedcellsettableheadercellprops) & CellSetTableCellPropsFromAxis ## CellSetTableStaticHeaderCellProps The props of static header cells in a [CellSetTable](components#cellsettable). [LoadingTableCellProps](types#loadingtablecellprops) & [DerivedCellSetTableStaticHeaderCellProps](types#derivedcellsettablestaticheadercellprops) ## CellStylePlugin Plugin useful to provide style to cells in table widgets. | Property | Type | Description | | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------- | | key | string | | | translations | \{
   \[locale: string]: [TranslationTree](types#translationtree)\;
} | | | withCellStyle | \(CellComponent: ForwardRefExoticComponent\>) => ForwardRefExoticComponent\ & RefAttributes\> | | ## CellStylePluginForCellSetTable Most used variant of [CellStylePlugin](types#cellstyleplugin), suitable for table widgets representing a [CellSet](types#cellset). [CellStylePlugin](types#cellstyleplugin)\<[CellSetTableCellProps](types#cellsettablecellprops)> ## CheckboxSettingDefinition The definition of a setting editable via a checkbox. | Property | Type | Description | | :----------- | :------------------------------------------ | :---------- | | defaultValue | V | | | key | K | | | searchTokens | string\[] | | | translations | [PerLocale](types#perlocale)\ | | | type | "checkbox" | | ## Client Parent interface for Atoti Server/Content Server/ActiveMonitor clients. | Property | Type | Description | | :------------- | :------------------------------------- | :---------------------------------------------------------------------------- | | serverVersion | string | The server's version. | | serviceVersion | [ServiceVersion](types#serviceversion) | The version of the APIs offered by the server's REST and websocket endpoints. | | url | string | The server's URL. | ## Clients | Property | Type | Description | | :------- | :------------------------------------------------------------------------- | :---------- | | atoti | \{
   \[serverKey: string]: [AtotiClient](types#atoticlient);
} | | | content | [ContentClient](types#contentclient) | | ## CloseCommandPaletteAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to close the command palette. See `isCommandPaletteVisible` in [State](types#state). | Property | Type | Description | | :------- | :-------------------- | :---------- | | type | "closeCommandPalette" | | ## CollapseDataModelTreeAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to collapse the data model tree. See `isDataModelTreeExpanded` in [State](types#state). | Property | Type | Description | | :------- | :---------------------- | :---------- | | type | "collapseDataModelTree" | | ## Color A string representing a color. string ## CompositeHierarchyInMapping A tile in the widget mapping, representing 2 hierarchies glued together. This can be created through a "drill down" action on a pivot table. | Property | Type | Description | | :---------- | :------------------------------------------------------------------------------------------------------------------ | :---------- | | hierarchies | ([LevelCoordinates](types#levelcoordinates) & \{
   expandedDownTo?: [LevelName](types#levelname);
})\[] | | | type | "compositeHierarchy" | | ## ConditionalStyle Contains a conditional format and the conditions under which to apply it. The condition is described with 1 or 2 keys. When there are 2 keys, they are necessarily a pair of lt(e)/gt(e), matching all values between or outside 2 limits. | Property | Type | Description | | :------- | :------------ | :---------- | | eq | number | | | gt | number | | | gte | number | | | lt | number | | | lte | number | | | neq | number | | | style | CSSProperties | | ## Configuration Object describing how Atoti UI is configured. In particular, it describes which [Plugin](types#plugin)s are registered, which has an impact both on the application functionalities and on the bundle size. | Property | Type | Description | | :------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | applicationName | string | | | extraVersions | \{
   \[name: string]: string \| ReactNode;
} | The extra software versions that will be displayed in the about popup below the Atoti UI and Atoti Server(s) versions. | | higherOrderComponents | ((wrappedComponent: ComponentType) => ComponentType)\[] | Higher-order components (HOCs) wrapping the application. In particular, it allows to provide React contexts.See [https://reactjs.org/docs/higher-order-components.html](https://reactjs.org/docs/higher-order-components.html) | | initialDashboardPageState | Omit\<[DashboardPageState](types#dashboardpagestate), "name"> | | | isBrandSignatureVisible | boolean | | | leftApplicationMenu | [ApplicationMenu](types#applicationmenu)\[] | Controls the menu items on the left of the header. They are usually specific to dashboards. | | modals | \{
   \[modalKey: string]: ComponentType\;
} | | | pathToHome | string | The path to the Atoti home page. | | pluginRegistry | [PluginRegistry](types#pluginregistry) | | | rightApplicationMenu | [ApplicationMenu](types#applicationmenu)\[] | Controls the menu items on the right of the header. They are typically always available. | | routes | RouteObject\[] | | | settings | ([SettingDefinition](types#settingdefinition)\ \| [SettingsGroup](types#settingsgroup))\[] | | | storeEnhancers | StoreEnhancer\[] | Redux store enhancers, allowing extensions to hook into the state of Atoti UI.It can be used by an extension to: - inject its own state into Atoti UI, so that the extension itself and other extensions can consume it - react to actions dispatched by Atoti UI or other extensionsThe store enhancers are composed, which allows to split state management on a per-extension basis.See [https://redux.js.org/usage/configuring-your-store#extending-redux-functionality](https://redux.js.org/usage/configuring-your-store#extending-redux-functionality) | | themes | \{
   \[themeKey: string]: Partial\<[Theme](types#theme)> &
   \{
     primaryColor: [Color](types#color);
  };
} | | | tools | [Tool](types#tool)\[] | | | widgetLoadingOverlay | ComponentType\<[LoadingOverlayProps](types#loadingoverlayprops)> | An overlay shown while a widget is loading. | ## ConnectionStatus The connection status of an AWebSocketClientImpl. When "connected", streaming queries can be run against it. * "disconnected" * "connecting" * "connected" ## ContainingMode * "startsWith" * "doesNotStartWith" * "endsWith" * "doesNotEndWith" * "contains" * "doesNotContain" ## ContentClient Provides methods to interact with the Content Server. | Property | Type | Description | | :------------- | :------------------------------------- | :---------------------------------------------------------------------------- | | serverVersion | string | The server's version. | | serviceVersion | [ServiceVersion](types#serviceversion) | The version of the APIs offered by the server's REST and websocket endpoints. | | url | string | The server's URL. | | Method | Description | | :---------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | createFile | Asynchronously creates a dashboard or a widget file on the Content Server. Returns its id. | | createFolder | Asynchronously creates a dashboard or a widget folder on the Content Server. Returns its id. | | deleteFile | Asynchronously deletes a dashboard or a widget file on the Content Server. | | deleteFilesAndFolders | Asynchronously deletes the selected files and folders of type on the Content Server. | | deleteFolder | Asynchronously deletes a dashboard or a widget folder on the Content Server. | | exportFilesAndFolders | Asynchronously returns: - a flat map containing all content entries (recursively) below the passed ids on the Content Server. - the tree structure of these entries under the exported folder. This method is only compatible with content service versions of 7 and above. The passed ids must refer to entries in a single folder, located at pathToParentFolder. | | fetchFile | Asynchronously returns the content of a dashboard or a widget file on the Content Server. Includes the file's metadata unless withMetaData: false is given, in which case pathToParentFolder is optional. | | fetchThumbnail | Asynchronously returns the thumbnail at path if it exists, undefined otherwise. | | fetchThumbnails | Asynchronously returns all accessible thumbnails in pathToParentFolder. Does not return thumbnails of subfolders. Returns a record object where values are the thumbnail images and keys are the ids of the files they relate to. | | getActivity | Returns the value of the activity identified by activityKey if it exists. | | getArePermissionsLoaded | Returns whether the permissions have been loaded by loadPermissions | | getAreSettingsLoaded | Returns whether the settings have been loaded by loadSettings | | getPermission | Returns the value of the permission identified by permissionKey, along with a flag indicating whether it is explicitly set in one of the permission files impacting the user. | | getSetting | Returns the value of the setting identified by settingKey if it exists. | | getTree | Returns the dashboards, widgets, or filters tree, if it is already loaded. | | importFilesAndFolders | Asynchronously imports the given files and folders into the Content Server. These files and folders must all be under the same parent folder. This method is only compatible with content service versions of 7 and above. | | loadActivity | Asynchronously loads the [Activity](types#activity) of the current user and makes it available via getActivity. If the activity file's content is not a valid JSON object, a default empty activity object is loaded. | | loadPermissions | Asynchronously loads the permissions, making them available via getPermission. If one of the permissions file's content is not a valid JSON object, loads a set of default permissions values instead. | | loadSettings | Asynchronously loads the settings, making them available via getSetting. If one of the settings file's content is not a valid JSON object, loads a set of default settings values instead. | | loadTree | Asynchronously loads the tree of all accessible dashboards, widgets, or filters. | | moveFiles | Asynchronously moves files from a same folder into a different folder on the Content Server. | | subscribeToActivity | Registers callback to be called whenever the value of the activity identified by activityKey is updated. | | subscribeToPermission | Registers callback to be called whenever the value of the permission identified by permissionKey is updated. | | subscribeToSetting | Registers callback to be called whenever the value of the setting identified by settingKey is updated. | | subscribeToSettings | Registers callback to be called whenever the value of the settings is updated. | | subscribeToTree | Registers callback to be called whenever the dashboards, widgets, or filters tree is reloaded. | | updateActivity | Saves the new version of the user's [Activity](types#activity) on the Content Server. | | updateFile | Asynchronously updates an existing dashboard or widget file on the Content Server. | | updateFilePermissions | Asynchronously updates an existing dashboard or widget file's permissions on the Content Server. | | updateFolder | Asynchronously updates an existing dashboard or widget folder on the Content Server. | | updateFolderPermissions | Asynchronously updates an existing folder's access permissions on the Content Server. If recursive is set to true, also updates the folder's descendants access permissions. | | updatePermission | Deprecated: Only admin users can update permissions, so the method is of no use. If needed, use the \[Content Server's REST API]\([https://docs.activeviam.com/engine/rest/6.1.20/content-server-rest-api](https://docs.activeviam.com/engine/rest/6.1.20/content-server-rest-api)) instead, or edit the permission files manually in Atoti Admin UI. Asynchronously updates the value of the permission identified by key for the given user. Requires being authenticated as a user with admin privileges. | | updateSetting | Asynchronously updates the value of the user setting identified by key for the given user. | | updateSettings | Asynchronously updates the user settings. | ## ContentClientConstructorArgs Arguments for creating a [ContentClient](types#contentclient) instance. If no store is provided, one is created internally. See [createContentClient](functions#createcontentclient). \{
   url: string;
   serverVersion: string;
   serviceVersion: [ServiceVersion](types#serviceversion);
   requestInit?: RequestInit;
   store?: [ContentClientStore](types#contentclientstore)\;
} ## ContentClientStore The store in which the client reads and writes its state. See [ContentClientConstructorArgs](types#contentclientconstructorargs). [StaticStore](types#staticstore)\, ContentClientAction\> ## ContentEntry An entry on the content server. \{
   isDirectory?: boolean;
   owners: string\[];
   readers: string\[];
   content?: Content;
} &
(T extends "response" ? \{
   canRead: boolean;
   canWrite: boolean;
   isDirectory: boolean;
   lastEditor: string;
   timestamp: number;
} : unknown) Remarks: The properties of the content entry vary on whether it is sent in an API request or received in an API response. See [https://docs.activeviam.com/engine/rest/6.1.20/content-server-rest-api/retrieves-the-entry-found-at-the-given-path](https://docs.activeviam.com/engine/rest/6.1.20/content-server-rest-api/retrieves-the-entry-found-at-the-given-path) for more information on the ContentEntry response shape. See [https://docs.activeviam.com/engine/rest/6.1.20/content-server-rest-api/performs-an-operation-on-the-content-service](https://docs.activeviam.com/engine/rest/6.1.20/content-server-rest-api/performs-an-operation-on-the-content-service) for more information on the ContentEntry request shape. ## ContentNode | Property | Type | Description | | :----------- | :---------------------------------------------------------------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | entry | [ContentEntry](types#contententry)\<[AMetaData](types#ametadata)> | | | id | string | | | metaData | MetaData | | | type | [ContentNodeType](types#contentnodetype) | | ## ContentNodeType * "file" * "folder" * "server" ## ContentRecord | Property | Type | Description | | :------- | :------------------------------------------------------------------------------------------ | :---------- | | children | \{
   \[childName: string]: [ContentRecord](types#contentrecord)\;
} | | | entry | [ContentEntry](types#contententry)\ | | ## ContentType * "dashboard" * "widget" * "filter" ## ContextValueDefinition | Property | Type | Description | | :---------- | :----- | :---------- | | category | string | | | description | string | | | name | string | | | type | string | | ## CoreSettings Flat map containing the preferences of the user regarding the behavior of various parts of Atoti. | Property | Type | Description | | :---------------------------------------------- | :------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | "dataModel.isSimplified" | boolean | When true, redundant/unactionable nodes of the data model tree are hidden: dimensions and the level of "single level hierarchies". When false, the data model tree displays the data model as it is. | | "drillthrough.defaultSelectedColumns" | \{
   \[cubeName: string]: [DrillthroughColumnUniqueName](types#drillthroughcolumnuniquename)\[];
} | The set of columns that are selected by default when opening a drillthrough table, per cube. If none are specified for a given cube, all the available drillthrough columns in this cube are selected. | | "filters.default.hiddenHierarchies" | string\[] | The unique names of hierarchies hidden from the default filters section of the Filters tab. In the format: \[Dimension].\[Hierarchy]. | | "filters.hideMissingHierarchiesAlert" | boolean | Whether the missing filter hierarchies alert banner is displayed on widgets when there exists a filter whose dimension or hierarchy does not exist on the target cube. | | "lastUsedCube.isEnabled" | boolean | Whether the last used cube by a user is taken into account when defaulting to a cube. The order of precedence is: cube used in the mdx -> last used cube -> first available cube. | | "mdx.doesIncludeCalculatedMembers" | boolean | Whether calculated members are requested in MDX queries. Changing this setting only affects the queries generated by future user interactions. It does not have any impact on already saved widgets and dashboards. | | "search.maxResults" | number | The maximum number of search results. | | "slicingHierarchies.defaultMemberSelectionMode" | "single" \| "multiple" | The default selection mode for the members of slicing hierarchies. Single by default. | | "smartFiltering.ignoredHierarchies" | string\[] | The unique names of the hierarchies to ignore in the smart filtering context: - When adding a filter on an ignored hierarchy, all members are displayed for selection. - When adding a filter on another hierarchy, the filters on the ignored hierarchy are \*not\* taken into account to retrieve the list of members displayed for selection.This can typically be used to disable smart filtering for an analysis hierarchy. | | "smartFiltering.isEnabled" | boolean | Whether smart filtering is enabled. True by default. If switched to false, smart filtering is completely disabled for all hierarchies of all cubes. Smart filtering is the fact that, when the user opens the "Filter on" popover, only the members that exist in the scope of the filters they set above are presented to them. When it is disabled, all members are shown in this popover, even though filtering on some of them can make the widget empty because there is no data for these members in combination with the other filters already applied to the widget. Smart filtering can also be disabled on a per hierarchy basis, using the smartFiltering.ignoredHierarchies setting. | | "smartFiltering.nonEmptyEvaluationMeasureName" | [NonEmptyEvaluationMeasureSetting](types#nonemptyevaluationmeasuresetting) | See [NonEmptyEvaluationMeasureSetting](types#nonemptyevaluationmeasuresetting) | | "style.members" | \{
   \[tupleKey: string]: CSSProperties;
} | The styles to be applied to the chart traces corresponding to each of the given tupleKeys. | | "table.animations.areEnabled" | boolean | Whether changes in tables are highlighted with green and red animations. | | "table.animations.duration" | number | The duration in seconds of the table animation. | | "table.animations.threshold" | number \| \{
   \[measureName: "default" \| string]: number;
} | The threshold per measure of when changes in tables are highlighted by animations. When provided, animations only occur when the difference between the previous and the refreshed value is above the threshold. If just a number, then it is a global threshold for all measures. | | "table.copyColumnHeadersAsASingleRow" | boolean | Whether the table rows representing column headers are joined into a single row when copying and pasting data into another application such as Excel. | | "table.defaultSize" | "small" \| "medium" \| "large" | The default size of table widgets. Controls the column widths and the row heights. | | "table.focusCell.color" | string | The color used for the focus cell highlight when hovering or clicking on a table cell. A CSS color string: either a palette CSS variable (e.g. var(--atoti-color-red-3)) or a hex color (e.g. #FF5733). | | "table.focusCell.shape" | "row" \| "column" \| "both" | The shape of the focus cell highlight when a table cell is selected. This attribute can also be configured on a per table basis, using its behavior tab. | | "table.focusCell" | boolean | Whether the full row and column are highlighted when hovering or clicking on a table cell. This attribute can also be configured on a per table basis, using its behavior tab. | | "table.headers.wrap" | boolean | Whether the text content of table headers wrap to the next line if it contains multiple words and is too long, or if sticks to a single line and has an ellipsis instead. This attribute can also be configured on a per table basis, using its style tab. | | "table.rowNumbers" | boolean | Whether row numbers are present by default on tables. These row numbers can also be hidden or shown on a per table basis, using its style tab. | | "table.tooltips" | boolean | Whether tooltips are present by default on numeric table cells. These tooltips can also be hidden or shown on a per table basis, using its style tab. | | "totals.areAddedByDefault" | boolean | Whether totals are added by default when a hierarchy is added to a widget. Totals can still be added or removed from a widget using the "Totals" context menu item. | | "unsavedChangesPopup.isEnabled" | boolean | Whether a warning popup is displayed when leaving a dashboard with unsaved changes. | | csvSeparator | string | The separator used between cells when converting to CSV. | | homePageLayout | "grid" \| "list" | The layout mode for the homepage. | | theme | "light-activeviam" \| "dark-activeviam" \| string | Controls the style of all Atoti UI components. Must be "light-activeviam", "dark-activeviam" or the key of a theme provided through configuration.themes. See [Configuration](types#configuration). | ## Cube | Property | Type | Description | | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- | | caption | string | | | contextValues | T extends "raw" ? [DefaultContextValue](types#defaultcontextvalue)\[] : \{
   \[defaultContextValueName: string]: [DefaultContextValue](types#defaultcontextvalue);
} | | | defaultMembers | [DefaultMember](types#defaultmember)\[] | | | dimensions | T extends "raw" ? [Dimension](types#dimension)\<"raw">\[] : \{
   \[dimensionName: string]: [Dimension](types#dimension)\<"indexed">;
} | | | kpis | T extends "raw" ? [Kpi](types#kpi)\[] : \{
   \[kpiName: string]: [Kpi](types#kpi);
} | | | measureGroups | T extends "raw" ? [MeasureGroup](types#measuregroup)\[] : \{
   \[measureGroupName: string]: [MeasureGroup](types#measuregroup);
} | | | measures | T extends "raw" ? [Measure](types#measure)\[] : \{
   \[measureName: string]: [Measure](types#measure);
} | | | name | [CubeName](types#cubename) | | | sets | T extends "raw" ? [Set](types#set)\[] : \{
   \[setName: string]: [Set](types#set);
} | | ## CubeName string ## CubeNode A data model tree node representing a cube | Property | Type | Description | | :----------- | :------ | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | name | string | | | serverKey | string | | | type | "cube" | | ## CurriedCellSetTableCellProps The props of CellSet table cells, which are curried by the [CellSetTable](components#cellsettable) Component. | Property | Type | Description | | :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | cells | CellSetTableCell\[]\[] | The cells forwarded to the underlying Table component. The dimensions of the array include the frozen rows and columns. Only the cells of the body are filled, as the rendering of the header cells depend on more information, present in the metaData. | | columnHeaderIndices | \{
   hierarchyIndex: number;
   levelIndex: number;
}\[] | Represents the level corresponding to each frozen row of the column header. | | columnIndexImpactingRowStyle | number | The index of the column whose conditional formatting impacts full rows, if applicable. | | columnsAxis | [Axis](types#axis) \| undefined | | | cube | [Cube](types#cube) | | | data | [CellSet](types#cellset) | | | defaultMeasure | [DefaultMember](types#defaultmember) | | | hierarchyIndicesInCellSet | [HierarchyIndicesInCellSet](types#hierarchyindicesincellset) | | | indexOfMeasureOnSlicer | number | | | isRowHeaderTree | boolean | | | loadedRange | [Range2D](types#range2d) | | | mapping | [DataVisualizationWidgetMapping](types#datavisualizationwidgetmapping) | | | memberPropertyKeys | string\[] | | | numberOfColumnsInBody | number | | | numberOfFrozenColumns | number | | | numberOfFrozenRows | number | | | numberOfRowsInBody | number | | | rowHeaderIndices | \{
   hierarchyIndex: number;
   levelIndex: number;
}\[] | | | rowsAxis | [Axis](types#axis) | | | slicerAxis | [Axis](types#axis) | | | sort | \{
   orderMode: [OrderMode](types#ordermode) \| undefined;
   tupleCoordinates?: [TupleCoordinates](types#tuplecoordinates);
   levelCoordinates?: [LevelCoordinates](types#levelcoordinates);
} | | | staticHeaderCoordinatesOnColumns | [TableStaticHeaderCoordinates](types#tablestaticheadercoordinates)\[] | | | staticHeaderCoordinatesOnRows | [TableStaticHeaderCoordinates](types#tablestaticheadercoordinates)\[] | | | staticHeadersOnColumns | [TableStaticHeader](types#tablestaticheader)\[] | | | staticHeadersOnRows | [TableStaticHeader](types#tablestaticheader)\[] | | | styleImpactingRows | [AFieldStyle](types#afieldstyle) | The style impacting full rows, if applicable. It corresponds to the style of the tupleImpactingRowStyle from [TableWidgetStyle](types#tablewidgetstyle). For instance, if the table has currencies and measures on columns, the this tuple can be (EUR, delta.SUM). | | areFrozenColumnsIgnored | boolean | Deprecated: Will be removed in 5.3. If the table is resized and becomes so thin that frozen columns would be larger than its total width, then they can be ignored so that the user can still scroll horizontally in order to see the columns to the right. This prop allows to control this behavior. | | isExpandable | (tuple: [Tuple](types#tuple)) => boolean | | | isExpanded | (tuple: [TupleCoordinates](types#tuplecoordinates)) => boolean | | | onExpansionChanged | (tuple: [Tuple](types#tuple), toLevel: [LevelCoordinates](types#levelcoordinates), isExpanding: boolean) => void | | | onSortChanged | () => void | | | widgetState | [DataVisualizationWidgetState](types#datavisualizationwidgetstate) | | ## CurriedDrillthroughTableCellProps The props of cells in drillthrough table that are curried by the DrillthroughTable Component. | Property | Type | Description | | :------------- | :------------------------------------------------------------------------------------------- | :---------- | | headerCaptions | [DrillthroughDataSetHeaderCell](types#drillthroughdatasetheadercell)\[] | | | headerValues | [DrillthroughDataSetHeaderCell](types#drillthroughdatasetheadercell)\[] | | | onSortChanged | () => void | | | sort | \{
   orderMode: "ASC" \| "DESC";
   drillthroughColumnUniqueName: string;
} | | | widgetState | [DrillthroughTableWidgetState](types#drillthroughtablewidgetstate) | | ## CustomFilter | Property | Type | Description | | :------- | :----------------------------------------------------------------------- | :---------- | | mdx | T extends "deserialized" ? [MdxExpression](types#mdxexpression) : string | | | type | "custom" | | ## DashboardContent The content of a dashboard file on the Content Server. Omit\<[DashboardState](types#dashboardstate)\<"serialized">, "name"> ## DashboardLoadedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to change the state of the dashboard when it is loaded. If `hasUnsavedChanges` is equal to `true`, considers the loaded dashboard as unsaved. | Property | Type | Description | | :---------------- | :------------------------------------- | :---------- | | dashboardState | [DashboardState](types#dashboardstate) | | | hasUnsavedChanges | boolean | | | type | "dashboardLoaded" | | ## DashboardMetaData The content of a dashboard meta data file on the Content Server, representing this dashboard in the dashboards tree. [AMetaData](types#ametadata) ## DashboardPageState The state of a dashboard page. [RecursiveDashboardPageState](types#recursivedashboardpagestate)\ ## DashboardSavedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to mark the current dashboard as saved. It does not actually save the action on the Content Server. See `dashboard` and `lastSavedDashboardHash` in [State](types#state). | Property | Type | Description | | :------------- | :------------------------------------- | :---------- | | dashboardState | [DashboardState](types#dashboardstate) | | | type | "dashboardSaved" | | ## DashboardState The state of a dashboard. `pages` contains the state of each page. \{
   filters?: [Filter](types#filter)\\[];
   filterFolders?: [FilterFolder](types#filterfolder)\[];
   pinnedDefaultFilters?: [HierarchyCoordinates](types#hierarchycoordinates)\[];
   queryContext?: [QueryContextEntry](types#querycontextentry)\[];
   name?: string;
   pages: \{
     \[pageKey: string]: [DashboardPageState](types#dashboardpagestate)\;
  };
   pagesOrder: string\[];
} ## DashboardUnloadedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to unload the dashboard. This action resets the undo/redo history. See `dashboard` in [State](types#state). | Property | Type | Description | | :------- | :------------------ | :---------- | | type | "dashboardUnloaded" | | ## DashboardUpdatedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to change the state of the dashboard. See `dashboard` in [State](types#state). | Property | Type | Description | | :---------------- | :----------------------------------------------------------- | :---------- | | dashboardState | [DashboardState](types#dashboardstate) | | | newSelectedWidget | \{
   leafKey: string;
   pageKey: string;
} | | | type | "dashboardUpdated" | | ## DataModel Describes the data contained in a server. | Property | Type | Description | | :------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- | | catalogs | T extends "raw" ? [Catalog](types#catalog)\<"raw">\[] : \{
   \[catalogName: string]: [Catalog](types#catalog)\<"indexed">;
} | | | contextValues | T extends "raw" ? [ContextValueDefinition](types#contextvaluedefinition)\[] : \{
   \[contextValueDefinitionName: string]: [ContextValueDefinition](types#contextvaluedefinition);
} | | ## DataModelClickListener A listener on data model tree clicks, called whenever a node is clicked in the [DataModelTree](components#datamodeltree). (node: [DataModelNode](types#datamodelnode), event: DataModelClickEvent) => void ## DataModelNode A data model tree node * [CatalogNode](types#catalognode) * [CubeNode](types#cubenode) * [DimensionNode](types#dimensionnode) * [HierarchyNode](types#hierarchynode) * [HierarchyFolderNode](types#hierarchyfoldernode) * [KpiPropertyNode](types#kpipropertynode) * [KpiNode](types#kpinode) * [KpiFolderNode](types#kpifoldernode) * [KpisRootNode](types#kpisrootnode) * [LevelNode](types#levelnode) * [MeasuresFolderNode](types#measuresfoldernode) * [MeasureNode](types#measurenode) * [ServerNode](types#servernode) * [SetNode](types#setnode) * [SetsRootNode](types#setsrootnode) ## DataModelTreePropsBase | Property | Type | Description | | :-------- | :----------------------------------------------------------------------- | :---------------------------------------------------------------------- | | cubeName | [CubeName](types#cubename) | | | mdx | [MdxSelect](types#mdxselect) \| [MdxDrillthrough](types#mdxdrillthrough) | If provided, mdx controls which cube options are disabled. | | serverKey | string | | ## DataOverrides Plotly overrides relative to the traces. | Property | Type | Description | | :-------------------- | :---------------------------------------------------------------------- | :---------- | | additionalTraces | [Trace](types#trace)\[] | | | commonTraceOverride | Partial\<[Trace](types#trace)> | | | overridesByTraceIndex | Partial\<[Trace](types#trace)>\[] | | | overridesByTraceKey | \{
   \[traceKey: string]: Partial\<[Trace](types#trace)>;
} | | ## DataVisualizationMappingField A field in a data visualization widget's mapping. * [AllMeasuresInMapping](types#allmeasuresinmapping) * [MeasureInMapping](types#measureinmapping) * [KpiPropertyInMapping](types#kpipropertyinmapping) * [HierarchyInMapping](types#hierarchyinmapping) * [CompositeHierarchyInMapping](types#compositehierarchyinmapping) * [NamedSetInMapping](types#namedsetinmapping) ## DataVisualizationStyle Style attributes of a data visualization widget. | Property | Type | Description | | :------- | :----------------------------------------------------- | :---------- | | headers | \{
   \[tupleKey: string]: CSSProperties;
} | | | measures | \{
   \[measureName: string]: FieldStyle;
} | | | tuples | \{
   \[tupleKey: string]: CSSProperties;
} | | ## DataVisualizationWidgetMapping The attributes to fields mapping, specific to a given type of data visualization widget. Contains deserialized fields. For example: ``` { rows: [ { type: "hierarchy", dimensionName: "Currency", hierarchyName: "Currency", levelName: "Currency" } ] } ``` ## DataVisualizationWidgetState | Property | Type | Description | | :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | areFiltersDrivenByMdx | boolean | Whether the filters applied to the query when it is sent to the server are driven by: 1. widgetState.query.mdx (when true). It allows users to write filters as they like in the query tab. 2. dashboardState.filters, pageState.filters and widgetState.filters (when false). It allows a single source of truth for dashboard and page filters, preventing bugs.Defaults to false.In practice it is set to true when the user submits an MDX query in the query tab. It it set to false when filters are changed using other UI elements, such as the content or filters tab. | | query | Partial\<[Query](types#query)\> | | | serverKey | string | | | shouldUseDefaultColumns | MdxType extends [MdxDrillthrough](types#mdxdrillthrough) ? boolean : never | Whether the columns specified in the drillthrough.defaultSelectedColumns setting are used in the drillthrough query. It is useful when performing a drillthrough from another widget, as it allows to create the drillthrough widget right away, while triggering the query only once the default columns have been fetched. | | behavior | Behavior | | | mapping | T extends "serialized" ? [SerializedDataVisualizationWidgetMapping](types#serializeddatavisualizationwidgetmapping) : [DataVisualizationWidgetMapping](types#datavisualizationwidgetmapping) | | | style | Style | | | switchedTo | string | | ## DefaultContextValue | Property | Type | Description | | :------- | :----- | :---------- | | name | string | | | value | string | | ## DefaultMember | Property | Type | Description | | :---------- | :----------------------------------- | :---------- | | captionPath | string\[] | | | dimension | [DimensionName](types#dimensionname) | | | hierarchy | [HierarchyName](types#hierarchyname) | | | path | string\[] | | ## DerivedCellSetTableBodyCellProps The props specific to body cells in a [CellSetTable](components#cellsettable). | Property | Type | Description | | :--------- | :------------------------------------------------------------------------------------------------------- | :---------- | | properties | \{
   \[key in [CellProperty](types#cellproperty)]?: null \| string \| number \| undefined;
} | | | tuple | [Tuple](types#tuple) \| null | | ## DerivedCellSetTableHeaderCellProps The props specific to header cells in a [CellSetTable](components#cellsettable). | Property | Type | Description | | :------------- | :--------------------------- | :---------- | | headerDepth | number | | | hierarchyIndex | number | | | levelIndex | number | | | positionIndex | number | | | tuple | [Tuple](types#tuple) \| null | | ## DerivedCellSetTableStaticHeaderCellProps The props specific to static header cells in a [CellSetTable](components#cellsettable). | Property | Type | Description | | :---------------------- | :----------------------------------------------------------------- | :---------- | | staticHeaderCoordinates | [TableStaticHeaderCoordinates](types#tablestaticheadercoordinates) | | ## Dimension | Property | Type | Description | | :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- | | caption | string | | | defaultHierarchy | [HierarchyName](types#hierarchyname) | | | description | string | | | hierarchies | T extends "raw" ? [Hierarchy](types#hierarchy)\<"raw">\[] : \{
   \[hierarchyName: string]: [Hierarchy](types#hierarchy)\<"indexed">;
} | | | measureGroups | string\[] | | | name | [DimensionName](types#dimensionname) | | | type | string | | | visible | boolean | | ## DimensionName The readable name of a dimension in a cube. string For example: ```tsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} const dimensionName = "Geography"; ``` ## DimensionNode A data model tree node representing a dimension | Property | Type | Description | | :----------- | :--------------------------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | cubeName | string | | | serverKey | string | | | dimension | [Dimension](types#dimension) | | | type | "dimension" | | ## DrillthroughColumn The drillthrough column as described by the server | Property | Type | Description | | :------- | :------------------------------------------------------------------------------------ | :---------- | | caption | string | | | name | [DrillthroughColumnUniqueName](types#drillthroughcolumnuniquename) | | | type | "String" \| "double" \| "int" \| "long" \| "LocalDate" \| "LocalDateTime" \| "Object" | | | visible | boolean | | ## DrillthroughColumnUniqueName A unique identifier for a drillthrough column. string ## DrillthroughDataSet | Property | Type | Description | | :------- | :---------------------------------------------------------------------- | :---------- | | headers | [DrillthroughDataSetHeaderCell](types#drillthroughdatasetheadercell)\[] | | | rows | [DrillthroughDataSetRow](types#drillthroughdatasetrow)\[] | | ## DrillthroughDataSetCell * string * number * Record\ ## DrillthroughDataSetHeaderCell Drillthrough's result column header description as returned by the server | Property | Type | Description | | :------- | :------------------------------------------------------------------------------------ | :---------- | | caption | string | | | name | string | | | type | "String" \| "double" \| "int" \| "long" \| "LocalDate" \| "LocalDateTime" \| "Object" | | ## DrillthroughDataSetRow [DrillthroughDataSetCell](types#drillthroughdatasetcell)\[] ## DrillthroughResult Drillthrough query result as returned by the server | Property | Type | Description | | :------- | :----------------------------------------------- | :---------- | | epoch | number | | | result | [DrillthroughDataSet](types#drillthroughdataset) | | ## DrillthroughSelection A selection of cells and/or headers in a [DrillthroughResult](types#drillthroughresult). | Property | Type | Description | | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------- | | columns | \{
   header: [DrillthroughDataSetHeaderCell](types#drillthroughdatasetheadercell);
   cells: [DrillthroughDataSetCell](types#drillthroughdatasetcell)\[];
}\[] | | | headers | [DrillthroughDataSetHeaderCell](types#drillthroughdatasetheadercell)\[] | | ## DrillthroughTableCellProps The props of cells in a drillthrough table [CellProps](types#cellprops) & [CurriedDrillthroughTableCellProps](types#currieddrillthroughtablecellprops) ## DrillthroughTableWidgetState * [WidgetWithQueryState](types#widgetwithquerystate)\<[MdxDrillthrough](types#mdxdrillthrough)> & \{
   initialCubeName?: [CubeName](types#cubename);
   columnWidths?: \{
     \[drillthroughColumnUniqueName: string]: number;
  }; sort?: \{ orderMode: "ASC" * "DESC"; drillthroughColumnUniqueName: string; }; style?: [TableWidgetStyle](types#tablewidgetstyle); } ## EditorProps Props received by content and style tabs. [ActionProps](types#actionprops)\ & \{
   isActive?: boolean;
} ## ElementType Used for switching when visiting * "Drillthrough" * "Select" * "SubSelect" * "Axis" * "CaseExpression" * "CompoundIdentifier" * "Formula" * "Function" * "From" * "Identifier" * "Literal" * "MemberPropertyDefinition" * "When" ## ErrorInQueryResult | Property | Type | Description | | :--------- | :----------------------------------------------------------- | :---------- | | errorChain | \{
   type: string;
   message: string;
}\[] | | | stackTrace | string | | ## ExpandDataModelTreeAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to expand the data model tree. See `isDataModelTreeExpanded` in [State](types#state). | Property | Type | Description | | :------- | :-------------------- | :---------- | | type | "expandDataModelTree" | | ## ExpandedFolderPathsInHomePageAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to expand and collapse folders on the homepage. See `expandedFolderPathsInHomePage` in [State](types#state). | Property | Type | Description | | :---------------------------- | :------------------------------------- | :---------- | | expandedFolderPathsInHomePage | string\[]\[] | | | type | "expandedFolderPathsInHomePageUpdated" | | ## ExpansionAction An action of expansion in a tree. | Property | Type | Description | | :------- | :--------------------- | :------------------------------------------------- | | path | number\[] | the path to the node that the user interacted with | | type | "expand" \| "collapse" | whether the node was expanded or collapsed | ## ExtendedSettings Utility type to derive the type of the settings map, extended through `configuration.settings`. See [Configuration](types#configuration). [CoreSettings](types#coresettings) & \{
   \[SettingIterator in SettingDefinitions\[number] as SettingIterator\["key"]]: SettingIterator\["defaultValue"];
} For example: ```ts theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} import { ExtendedSettings, SettingDefinition, useSetting, } from "@activeviam/atoti-ui-sdk"; const myCheckboxSetting: SettingDefinition<"myCheckbox"> = { key: "myCheckbox", type: "checkbox", defaultValue: false, translations: { "en-US": { title: "My checkbox", description: "This is my checkbox", }, }, }; export const settingDefinitions = [myCheckboxSetting]; type MyExtendedSettings = ExtendedSettings; function useMySettings() { const [coreSettingValue] = useSetting("dataModel.isSimplified"); const [checkboxValue] = useSetting( "myCheckbox", ); return { coreSettingValue, checkboxValue, }; } ``` ## ExtensionModule The entrypoint module of an Atoti UI extension. | Property | Type | Description | | :------- | :--------------------------------------------------------------- | :---------- | | activate | (params: [Configuration](types#configuration)) => Promise\ | | ## FieldUniqueName * "ALL\_MEASURES" * [LevelUniqueName](types#leveluniquename) * [MeasureUniqueName](types#measureuniquename) * [KpiPropertyIdentifier](types#kpipropertyidentifier) * "namedSet" ## FileListMenuItemProps | Property | Type | Description | | :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------- | | contentTree | [ContentRecord](types#contentrecord) | | | contentType | [ContentType](types#contenttype) | | | getFileOrFolderUrl | (id: string, metaData: [AMetaData](types#ametadata)) => string \| undefined | | | onAfterSubmit | OnAfterSubmit | | | onEditStarted | (id: string) => void | | | pathToParentFolder | [ServerPath](types#serverpath) | | | selectedFilesAndFolders | (\{
   id: string;
   record: [ContentRecord](types#contentrecord)\<[AMetaData](types#ametadata)>;
} \| \{
   doesRepresentServer: true;
})\[] | | ## Filter * [AdvancedFilter](types#advancedfilter) * [FilterOnMembers](types#filteronmembers) * [CalendarFilter](types#calendarfilter)\ * [CustomFilter](types#customfilter)\ ## FilterFolder A dynamic group of filters corresponding to the saved filter folder identified by `id`. [PinnableFilter](types#pinnablefilter) & \{
   id: string;
} ## FilterMetaData The content of a filter meta data file on the Content Server, representing a filter in the filters tree. \{
   name: string;
   isFolder?: boolean;
} ## FilterOnCaptionContaining A filter on the members of a level of a hierarchy with a caption starting, ending, containing (or not) the given string. | Property | Type | Description | | :------------- | :------------------------------------- | :---------- | | containingMode | [ContainingMode](types#containingmode) | | | levelName | [LevelName](types#levelname) | | | token | string | | | type | "captionsContaining" | | For example: Filter on employees with a last name alphabetically containing "son". ## FilterOnCaptionsRange A filter on the members of a level of a hierarchy with a caption alphabetically between the given limits. | Property | Type | Description | | :--------- | :--------------------------- | :---------- | | isBetween | boolean | | | levelName | [LevelName](types#levelname) | | | lowerToken | string | | | type | "captionsRange" | | | upperToken | string | | For example: Filter on employees with a last name alphabetically between "L" and "O". ## FilterOnDateRange A filter on a range of dates (only available for hierarchies of type `time`). | Property | Type | Description | | :------------ | :-------------------------------------------------------------------- | :---------- | | endDate | T extends "deserialized" ? Date : string & typia.tags.Format\<"date"> | | | isRollingDate | boolean | | | isSingleDate | boolean | | | levelName | [LevelName](types#levelname) | | | startDate | T extends "deserialized" ? Date : string & typia.tags.Format\<"date"> | | | type | "dateRange" | | For example: Filter on transactions between "2021/12/01" and "2021/12/20". ## FilterOnExistenceOfValue A filter on the members of a level of a hierarchy with an existing value for the given measure. | Property | Type | Description | | :---------- | :------------------------------- | :---------- | | doesExist | boolean | | | levelName | [LevelName](types#levelname) | | | measureName | [MeasureName](types#measurename) | | | type | "existenceOfValue" | | For example: Filter on countries with a known GDP. ## FilterOnLowerOrGreaterCaptions A filter on the members of a level of a hierarchy with a caption alphabetically before or after a given limit. | Property | Type | Description | | :----------------- | :--------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | | levelName | [LevelName](types#levelname) | | | lowerOrGreaterMode | [LowerOrGreaterMode](types#lowerorgreatermode) | The values "Equal" and "NotEqual" are deprecated and will be removed in Atoti UI 5.3. Use a [FilterOnMembers](types#filteronmembers) instead. | | token | string | | | type | "lowerOrGreaterCaptions" | | For example: Filter on employees with a last name alphabetically after "H". ## FilterOnLowerOrGreaterValues A filter on the members of a level of a hierarchy with a value of a given measure lower or greater than a defined limit. | Property | Type | Description | | :------------------ | :--------------------------------------------- | :---------- | | levelName | [LevelName](types#levelname) | | | lowerOrGreaterLimit | number | | | lowerOrGreaterMode | [LowerOrGreaterMode](types#lowerorgreatermode) | | | measureName | [MeasureName](types#measurename) | | | type | "lowerOrGreaterValue" | | For example: Filter on countries with a GDP above 500B\$. ## FilterOnMembers A filter on explicitly defined members of a hierarchy. | Property | Type | Description | | :---------------- | :--------------------- | :---------- | | includeAllMembers | boolean | | | members | string\[]\[] | | | selectionMode | "single" \| "multiple" | | | type | "members" | | For example: Filter on Currency = Dollar ## FilterOnPreviousOrNextTimePeriods A filter on a range of dates relative to the current date, either in the past or future, for a specified number of days, weeks, quarters, months or years. Only available for hierarchies of type `time`. | Property | Type | Description | | :------------------ | :--------------------------------------------- | :---------- | | levelName | [LevelName](types#levelname) | | | numberOfTimePeriods | number | | | previousOrNextMode | [PreviousOrNextMode](types#previousornextmode) | | | timePeriod | [TimePeriod](types#timeperiod) | | | type | "previousOrNextTimePeriods" | | For example: Filter on transactions from the previous 2 months or the next 5 weeks. ## FilterOnRecentDates | Property | Type | Description | | :------------------ | :--------------------------- | :---------- | | levelName | [LevelName](types#levelname) | | | numberOfRecentDates | number | | | type | "recentDates" | | ## FilterOnSeasonalPattern A filter on recurring calendar periods regardless of the year. Only available for hierarchies of type `time`. [AFilter](types#afilter) & \{
   type: "seasonalPattern";
   levelName: [LevelName](types#levelname);
} & SeasonalPatternPeriod For example: Filter on every Monday and Wednesday, or every Q1 and Q3. ## FilterOnTimePeriodToDate A filter on a range of dates from the beginning of the selected time period (for example month, quarter or year) to the current date. Only available for hierarchies of type `time`. | Property | Type | Description | | :--------- | :----------------------------- | :---------- | | levelName | [LevelName](types#levelname) | | | timePeriod | [TimePeriod](types#timeperiod) | | | type | "timePeriodToDate" | | For example: Filter on transactions between the first day of the current year and today. ## FilterOnTopBottomMembers A filter on the n members of a level of a hierarchy with the lowest or highest value for a measure. | Property | Type | Description | | :------------ | :----------------------------------- | :---------- | | levelName | [LevelName](types#levelname) | | | limit | number | | | measureName | [MeasureName](types#measurename) | | | scope | [FilterScope](types#filterscope) | | | topBottomMode | [TopBottomMode](types#topbottommode) | | | type | "topBottomMembers" | | For example: Filter on the 3 best selling products of each category ## FilterOnValuesRange A filter on the members of a level of a hierarchy with a value of a given measure between or outside the given limits. | Property | Type | Description | | :---------- | :------------------------------- | :---------- | | isBetween | boolean | | | levelName | [LevelName](types#levelname) | | | lowerLimit | number | | | measureName | [MeasureName](types#measurename) | | | type | "valuesRange" | | | upperLimit | number | | For example: Filter on countries with a GDP between 200 and 500B\$. ## FilterScope * "overall" * "ofEachParent" ## FilterType * "members" * [CalendarFilterType](types#calendarfiltertype) * [AdvancedFilterType](types#advancedfiltertype) * "custom" ## FolderPermissionUpdateParams * [SimpleFolderPermissionUpdateParams](types#simplefolderpermissionupdateparams) * [RecursiveFolderPermissionUpdateParams](types#recursivefolderpermissionupdateparams) ## FormulaType * "SET" * "MEMBER" ## GenericIndenter | Property | Type | Description | | :------- | :------------------------------ | :---------- | | indent | (needSpace?: boolean) => string | | | newLine | (needSpace?: boolean) => string | | | unindent | () => void | | ## GridRange **Deprecated** Use [Range2D](types#range2d) instead. [Range2D](types#range2d) ## Hierarchy | Property | Type | Description | | :-------------------- | :----------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | caption | string | | | description | string | | | folder | string | | | levels | T extends "raw" ? [Level](types#level)\<"raw">\[] : \{
   \[levelName: string]: [Level](types#level)\<"indexed">;
} | | | maxNbResultsPerSearch | number | The maximum number of cells returned by the server when looking up members from the hierarchy, to avoid performance issues. Only applicable for virtual hierarchies. See virtual. | | name | [HierarchyName](types#hierarchyname) | | | slicing | boolean | | | virtual | boolean | Whether the hierarchy is implemented as "virtual" or not on the server. Virtual hierarchies have a high cardinality, and their members are not represented in memory on the server. This limits what operations can be done on them, in particular when querying them through MDX. | | visible | boolean | | ## HierarchyCoordinates The dimension and hierarchy names identifying a hierarchy in a cube. | Property | Type | Description | | :------------ | :----------------------------------- | :---------- | | dimensionName | [DimensionName](types#dimensionname) | | | hierarchyName | [HierarchyName](types#hierarchyname) | | For example: ```tsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} const hierarchyCoordinates = { dimensionName: "Geography", hierarchyName: "City", }; ``` ## HierarchyFolderNode A data model tree node representing a hierarchy folder. | Property | Type | Description | | :----------- | :---------------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | cubeName | string | | | serverKey | string | | | type | "hierarchyFolder" | | ## HierarchyIndicesInCellSet A map of hierarchy unique names to the index of the axis where the hierarchy can be found in `cellSet.axes` and its own index in `axis.hierarchies`. ## HierarchyInMapping A tile in the widget mapping, representing a hierarchy. | Property | Type | Description | | :------------- | :--------------------------- | :---------- | | expandedDownTo | [LevelName](types#levelname) | | | type | "hierarchy" | | ## HierarchyName The readable name of a hierarchy in a cube. string For example: ```tsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} const hierarchyName = "City"; ``` ## HierarchyNode A data model tree node representing a hierarchy | Property | Type | Description | | :----------- | :--------------------------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | cubeName | string | | | serverKey | string | | | dimension | [Dimension](types#dimension) | | | hierarchy | [Hierarchy](types#hierarchy) | | | type | "hierarchy" | | ## HierarchySelectSettingDefinition The definition of a setting editable via a hierarchy select. | Property | Type | Description | | :--------------------- | :------------------------------------------ | :---------- | | defaultValue | V | | | key | K | | | searchTokens | string\[] | | | translations | [PerLocale](types#perlocale)\ | | | mode | "single" \| "multiple" | | | onlySlicingHierarchies | boolean | | | type | "hierarchySelect" | | ## HierarchyUniqueName A string representing the unique identifier of a hierarchy in a cube. string For example: ```tsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} const hierarchyUniqueName = "[Geography].[City]"; ``` ## HighlightedCaptionProps | Property | Type | Description | | :---------- | :------ | :---------- | | caption | string | | | className | string | | | isDisabled | boolean | | | searchValue | string | | ## InputNumberSettingDefinition The definition of a numeric setting editable via an input. | Property | Type | Description | | :----------- | :------------------------------------------ | :---------- | | defaultValue | V | | | key | K | | | searchTokens | string\[] | | | translations | [PerLocale](types#perlocale)\ | | | type | "inputNumber" | | ## InputSettingDefinition The definition of a string setting editable via an input. | Property | Type | Description | | :----------- | :------------------------------------------ | :---------- | | defaultValue | V | | | key | K | | | searchTokens | string\[] | | | translations | [PerLocale](types#perlocale)\ | | | type | "input" | | ## InternalNode Represents a node in a tree. NodeType & \{
   path: number\[];
   parentNames: string;
} ## IsDeferredAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to toggle deferred updates. See `isDeferred` in [State](types#state). | Property | Type | Description | | :--------- | :------------------ | :---------- | | isDeferred | boolean | | | type | "isDeferredChanged" | | ## IsMoveDashboardModalVisibleAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to change whether the dashboard 'Move' modal is visible. See `isMoveDashboardModalVisible` in [State](types#state). | Property | Type | Description | | :------- | :------------------------------------------------------- | :---------- | | type | "moveDashboardModalOpened" \| "moveDashboardModalClosed" | | ## IsOpenDashboardPopupVisibleAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to change whether the 'Open Dashboard' popup is visible. See `isOpenDashboardPopupVisible` in [State](types#state). | Property | Type | Description | | :------- | :------------------------------------------------------- | :---------- | | type | "openDashboardPopupOpened" \| "openDashboardPopupClosed" | | ## IsPresentingAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to change whether the application is displayed in "Present" mode. See `isPresenting` in [State](types#state). | Property | Type | Description | | :----------- | :-------------------- | :---------- | | isPresenting | boolean | | | type | "isPresentingChanged" | | ## IsSettingsPopupVisibleAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to change whether the 'Settings' popup is visible. See `isSettingsPopupVisible` in [State](types#state). | Property | Type | Description | | :------- | :--------------------------------------------- | :---------- | | type | "settingsPopupOpened" \| "settingsPopupClosed" | | ## IsToolsPanelExpandedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to change whether the tools panel is expanded. See `isToolsPanelExpanded` in [State](types#state). | Property | Type | Description | | :------- | :-------------------------------------------- | :---------- | | type | "toolsPanelExpanded" \| "toolsPanelCollapsed" | | ## Kpi | Property | Type | Description | | :-------------- | :----- | :---------- | | caption | string | | | description | string | | | expiry | string | | | folder | string | | | goal | string | | | measureGroup | string | | | name | string | | | start | string | | | status | string | | | statusPresenter | string | | | trend | string | | | value | string | | ## KpiComparison * [SubmittedKpiComparison](types#submittedkpicomparison) * [HierarchyCoordinates](types#hierarchycoordinates) ## KpiFolderNode A data model tree node representing a folder of kpis | Property | Type | Description | | :----------- | :---------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | cubeName | string | | | serverKey | string | | | type | "kpiFolder" | | ## KpiNode A data model tree node representing a kpi | Property | Type | Description | | :----------- | :------ | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | cubeName | string | | | serverKey | string | | | type | "kpi" | | ## KpiProperty | Property | Type | Description | | :-------------------- | :--------------------------------------- | :---------- | | kpiName | string | | | kpiPropertyName | [KpiPropertyName](types#kpipropertyname) | | | underlyingMeasureName | [MeasureName](types#measurename) | | ## KpiPropertyIdentifier string For example: KPIStatus("my KPI"): pnl.SUM ## KpiPropertyInMapping A tile in the widget mapping, representing a KPI property. | Property | Type | Description | | :-------------------- | :--------------------------------------- | :---------- | | kpiName | string | | | propertyName | [KpiPropertyName](types#kpipropertyname) | | | type | "kpiProperty" | | | underlyingMeasureName | [MeasureName](types#measurename) | | ## KpiPropertyName * "KPIValue" * "KPIGoal" * "KPIStatus" * "KPITrend" * "KPIStart" * "KPIExpiry" ## KpiPropertyNode A data model tree node representing a kpi property, such as its status | Property | Type | Description | | :-------------------- | :--------------------------------------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | cubeName | string | | | serverKey | string | | | kpiName | string | | | kpiPropertyName | [KpiPropertyName](types#kpipropertyname) | | | underlyingMeasureName | [MeasureName](types#measurename) | | | type | "kpiProperty" | | ## KpisRootNode A data model tree node representing a kpisRoot | Property | Type | Description | | :----------- | :--------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | cubeName | string | | | serverKey | string | | | type | "kpisRoot" | | ## KpiWidgetState | Property | Type | Description | | :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | areFiltersDrivenByMdx | boolean | Whether the filters applied to the query when it is sent to the server are driven by: 1. widgetState.query.mdx (when true). It allows users to write filters as they like in the query tab. 2. dashboardState.filters, pageState.filters and widgetState.filters (when false). It allows a single source of truth for dashboard and page filters, preventing bugs.Defaults to false.In practice it is set to true when the user submits an MDX query in the query tab. It it set to false when filters are changed using other UI elements, such as the content or filters tab. | | query | Partial\<[Query](types#query)\> | | | serverKey | string | | | shouldUseDefaultColumns | MdxType extends [MdxDrillthrough](types#mdxdrillthrough) ? boolean : never | Whether the columns specified in the drillthrough.defaultSelectedColumns setting are used in the drillthrough query. It is useful when performing a drillthrough from another widget, as it allows to create the drillthrough widget right away, while triggering the query only once the default columns have been fetched. | | behavior | Behavior | | | mapping | T extends "serialized" ? [SerializedDataVisualizationWidgetMapping](types#serializeddatavisualizationwidgetmapping) : [DataVisualizationWidgetMapping](types#datavisualizationwidgetmapping) | | | style | Style | | | switchedTo | string | | | comparison | [KpiComparison](types#kpicomparison) | | | titles | \{
   \[tupleKey: string]: string;
} | | ## Layout Atoti UI dashboard page layout Tree of widgets, not necessarily binary. Allows a more intuitive widget resizing behavior than the ActiveUI 4 binary layout. | Property | Type | Description | | :-------- | :------------------------------------------------------------ | :---------- | | children | ([Layout](types#layout) \| [LayoutLeaf](types#layoutleaf))\[] | | | direction | "column" \| "row" | | | size | number | | ## LayoutLeaf | Property | Type | Description | | :------- | :----- | :---------- | | leafKey | string | | | size | number | | ## Level \{
   name: [LevelName](types#levelname);
   caption: string;
   description?: string;
   type: string;
} &
(T extends "indexed" ? \{
   index: number;
} : unknown) ## LevelCoordinates The dimension, hierarchy and level names identifying a hierarchy in a cube. [HierarchyCoordinates](types#hierarchycoordinates) & \{
   levelName: [LevelName](types#levelname);
} For example: ```tsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} const hierarchyCoordinates = { dimensionName: "Geography", hierarchyName: "City", levelName: "City", }; ``` ## LevelName The readable name of a level in a cube. string For example: ```tsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} const levelName = "City"; ``` ## LevelNode A data model tree node representing a level | Property | Type | Description | | :----------- | :--------------------------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | cubeName | string | | | serverKey | string | | | depth | number | | | dimension | [Dimension](types#dimension) | | | hierarchy | [Hierarchy](types#hierarchy) | | | level | [Level](types#level) | | | type | "level" | | ## LevelUniqueName A string representing the unique identifier of a level in a cube. string For example: ```tsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} const levelUniqueName = "[Geography].[City].[City]"; ``` ## LoadingOverlayProps The props provided to a loading overlay. | Property | Type | Description | | :------------------------------------- | :------------ | :---------- | | className | string | | | isInitiallyVisible | boolean | | | isLoading | boolean | | | onWidgetReset | () => void | | | queryId | string | | | serverKey | string | | | style | CSSProperties | | | timeBeforeContinueLoadingButtonAppears | number | | | tip | string | | ## LoadingTableCellProps The props of cells in a [CellSetTable](components#cellsettable), in cases such as undefined cube or undefined data. [CellProps](types#cellprops) & [CurriedCellSetTableCellProps](types#curriedcellsettablecellprops) ## LowerOrGreaterMode * "Lower" * "LowerOrEqual" * "Greater" * "GreaterOrEqual" * "Equal" * "NotEqual" ## Mdx The Abstract syntax tree of an [MdxString](types#mdxstring). * [MdxExpression](types#mdxexpression) * [MdxAxis](types#mdxaxis) * [MdxFromClause](types#mdxfromclause) * [MdxFormula](types#mdxformula) * [MdxDrillthrough](types#mdxdrillthrough) * [MdxMemberPropertyDefinition](types#mdxmemberpropertydefinition) * [MdxSelect](types#mdxselect) * [MdxSubSelect](types#mdxsubselect) * [MdxWhenClause](types#mdxwhenclause) ## MdxAxis An [Mdx](types#mdx) representing an axis such as `ROWS` or `COLUMNS` and its associated expression. | Property | Type | Description | | :---------- | :----------------------------------- | :---------- | | elementType | "Axis" | | | expression | [MdxExpression](types#mdxexpression) | | | name | [AxisName](types#axisname) | | | nonEmpty | boolean | | | properties | [Mdx](types#mdx)\[] | | ## MdxCaseExpression An [Mdx](types#mdx) representing a `CASE` statement. | Property | Type | Description | | :---------- | :------------------------------------------- | :---------- | | cases | [MdxWhenClause](types#mdxwhenclause)\[] | | | elementType | "CaseExpression" | | | elseExp | [MdxExpression](types#mdxexpression) | | | match | [MdxExpression](types#mdxexpression) \| null | | | name | string | | ## MdxCompoundIdentifier The subset of [Mdx](types#mdx)s that identify something using hierarchical dot notation, as in the MDX `[Measures].[MyMeasure]`. Each segment is an [MdxIdentifier](types#mdxidentifier). * [MdxUnknownCompoundIdentifier](types#mdxunknowncompoundidentifier) * [MdxDimensionCompoundIdentifier](types#mdxdimensioncompoundidentifier) * [MdxHierarchyCompoundIdentifier](types#mdxhierarchycompoundidentifier) * [MdxLevelCompoundIdentifier](types#mdxlevelcompoundidentifier) * [MdxMemberCompoundIdentifier](types#mdxmembercompoundidentifier) * [MdxMeasureCompoundIdentifier](types#mdxmeasurecompoundidentifier) * [MdxNamedSetCompoundIdentifier](types#mdxnamedsetcompoundidentifier) ## MdxDimensionCompoundIdentifier A [MdxCompoundIdentifier](types#mdxcompoundidentifier) that represents a dimension. | Property | Type | Description | | :------------ | :-------------------------------------- | :---------- | | elementType | "CompoundIdentifier" | | | identifiers | [MdxIdentifier](types#mdxidentifier)\[] | | | dimensionName | [DimensionName](types#dimensionname) | | | type | "dimension" | | ## MdxDrillthrough An [Mdx](types#mdx) representing a `DRILLTHROUGH` statement. | Property | Type | Description | | :---------- | :-------------------------------------- | :---------- | | columns | [MdxExpression](types#mdxexpression)\[] | | | elementType | "Drillthrough" | | | firstRow | number | | | maxRows | number | | | select | [MdxSelect](types#mdxselect) | | ## MdxErrorDetails | Property | Type | Description | | :------- | :--------------------------------------------------- | :---------- | | expected | string\[] | | | from | \{
   line: number;
   ch: number;
} | | | text | string | | | to | \{
   line: number;
   ch: number;
} | | ## MdxExpression The subset of [Mdx](types#mdx)s that can be used in expression contexts such as the expression of a calculated measure. * [MdxLiteral](types#mdxliteral) * [MdxIdentifier](types#mdxidentifier) * [MdxCompoundIdentifier](types#mdxcompoundidentifier) * [MdxCaseExpression](types#mdxcaseexpression) * [MdxFunction](types#mdxfunction) ## MdxFormula An [Mdx](types#mdx) representing an formula definition in the `WITH` clause of a [MdxSelect](types#mdxselect). An example formula: `WITH Member [Measures].[MyConstant] AS 42`. | Property | Type | Description | | :---------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- | | elementType | "Formula" | | | expression | [MdxExpression](types#mdxexpression) | | | inlined | boolean \| undefined | | | name | [MdxNamedSetCompoundIdentifier](types#mdxnamedsetcompoundidentifier) \| [MdxMeasureCompoundIdentifier](types#mdxmeasurecompoundidentifier) \| [MdxMemberCompoundIdentifier](types#mdxmembercompoundidentifier) \| [MdxUnknownCompoundIdentifier](types#mdxunknowncompoundidentifier) | | | properties | [MdxMemberPropertyDefinition](types#mdxmemberpropertydefinition)\[] | | | type | string | | ## MdxFromClause An [Mdx](types#mdx) representing a named cube for the `FROM` clause of a [MdxSelect](types#mdxselect). Does not represent a subselect expression in a `FROM` clause – that is represented by a [MdxSubSelect](types#mdxsubselect) instead. | Property | Type | Description | | :---------- | :------------------------- | :---------- | | cubeName | [CubeName](types#cubename) | | | elementType | "From" | | ## MdxFunction An [Mdx](types#mdx) representing a function call. Some functions are called with syntax that makes them look like an operator or part of the language; see [Syntax](types#syntax) for the different syntaxes for calling functions. | Property | Type | Description | | :---------- | :-------------------------------------- | :---------- | | arguments | [MdxExpression](types#mdxexpression)\[] | | | elementType | "Function" | | | name | string | | | syntax | [Syntax](types#syntax) | | ## MdxHierarchyCompoundIdentifier A [MdxCompoundIdentifier](types#mdxcompoundidentifier) that represents a hierarchy. | Property | Type | Description | | :------------ | :-------------------------------------- | :---------- | | elementType | "CompoundIdentifier" | | | identifiers | [MdxIdentifier](types#mdxidentifier)\[] | | | dimensionName | [DimensionName](types#dimensionname) | | | hierarchyName | [HierarchyName](types#hierarchyname) | | | type | "hierarchy" | | ## MdxIdentifier An [Mdx](types#mdx) representing an identifier – the name of a hierarchy, level, measure, KPI, etc. For example, this could represent the MDX `Geography` or `[Geography]`. A [MdxCompoundIdentifier](types#mdxcompoundidentifier) is made of these separated by dots. | Property | Type | Description | | :---------- | :----------------------- | :---------- | | elementType | "Identifier" | | | quoting | [Quoting](types#quoting) | | | value | string | | ## MdxLevelCompoundIdentifier A [MdxCompoundIdentifier](types#mdxcompoundidentifier) that represents a level. | Property | Type | Description | | :------------ | :-------------------------------------- | :---------- | | elementType | "CompoundIdentifier" | | | identifiers | [MdxIdentifier](types#mdxidentifier)\[] | | | dimensionName | [DimensionName](types#dimensionname) | | | hierarchyName | [HierarchyName](types#hierarchyname) | | | levelName | [LevelName](types#levelname) | | | type | "level" | | ## MdxLiteral An [Mdx](types#mdx) representing a literal value such as a number or string. | Property | Type | Description | | :---------- | :------------------------- | :---------- | | elementType | "Literal" | | | type | [Argument](types#argument) | | | value | string | | ## MdxMeasureCompoundIdentifier | Property | Type | Description | | :---------- | :-------------------------------------- | :---------- | | elementType | "CompoundIdentifier" | | | identifiers | [MdxIdentifier](types#mdxidentifier)\[] | | | measureName | [MeasureName](types#measurename) | | | type | "measure" | | ## MdxMemberCompoundIdentifier A [MdxCompoundIdentifier](types#mdxcompoundidentifier) that represents a member. | Property | Type | Description | | :------------ | :-------------------------------------- | :---------- | | elementType | "CompoundIdentifier" | | | identifiers | [MdxIdentifier](types#mdxidentifier)\[] | | | dimensionName | [DimensionName](types#dimensionname) | | | hierarchyName | [HierarchyName](types#hierarchyname) | | | levelName | [LevelName](types#levelname) | | | path | string\[] | | | type | "member" | | ## MdxMemberPropertyDefinition An [Mdx](types#mdx) representing the definition of a property of a member that is defined in a [MdxFormula](types#mdxformula). Some example property names are `FORE_COLOR` and `FONT_FLAGS`. | Property | Type | Description | | :---------- | :----------------------------------- | :---------- | | elementType | "MemberPropertyDefinition" | | | expression | [MdxExpression](types#mdxexpression) | | | name | string | | ## MdxNamedSet | Property | Type | Description | | :---------- | :--------------------------- | :---------- | | caption | string | | | cube | [CubeName](types#cubename) | | | description | string | | | expression | [MdxString](types#mdxstring) | | | name | [AxisName](types#axisname) | | | serverUrl | string | | | type | "namedSet" | | ## MdxNamedSetCompoundIdentifier A [MdxCompoundIdentifier](types#mdxcompoundidentifier) that represents a named set. | Property | Type | Description | | :---------- | :-------------------------------------- | :---------- | | elementType | "CompoundIdentifier" | | | identifiers | [MdxIdentifier](types#mdxidentifier)\[] | | | setName | [SetName](types#setname) | | | type | "namedSet" | | ## MdxOrderFunction An [MdxFunction](types#mdxfunction) that represents a call to the \[`Order` function]\([https://docs.microsoft.com/en-us/sql/mdx/order-mdx](https://docs.microsoft.com/en-us/sql/mdx/order-mdx)). * [MdxFunction](types#mdxfunction) & [MdxFunction](types#mdxfunction) & \{ arguments: \[[MdxExpression](types#mdxexpression), [MdxExpression](types#mdxexpression), [OrderModeMdxLiteral](types#ordermodemdxliteral)] * \[[MdxExpression](types#mdxexpression), [MdxExpression](types#mdxexpression)]; name: "Order"; } ## MdxSelect An [Mdx](types#mdx) representing a SELECT statement. | Property | Type | Description | | :---------- | :------------------------------------------------------------------------- | :---------- | | axes | [MdxAxis](types#mdxaxis)\[] | | | cellProps | string\[] | | | elementType | "Select" | | | from | [MdxSubSelect](types#mdxsubselect) \| [MdxFromClause](types#mdxfromclause) | | | slicerAxis | [MdxSlicerAxis](types#mdxsliceraxis) \| null | | | withClause | [MdxFormula](types#mdxformula)\[] | | ## MdxSlicerAxis [MdxAxis](types#mdxaxis) & \{
   name: "SLICER";
} ## MdxString A string representing an \[MDX]\([https://en.wikipedia.org/wiki/MultiDimensional\\\_eXpressions](https://en.wikipedia.org/wiki/MultiDimensional\\_eXpressions)) query or a part of one. string For example: ```tsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} const mdx = "SELECT\n [Measures].[contributors.COUNT] ON COLUMNS\n FROM [EquityDerivativesCube]"; ``` For example: ```tsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} const mdx = "[Measures].[contributors.COUNT]"; ``` For example: ```tsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} const mdx = '"a string in MDX"'; ``` For example: ```tsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} const mdx = "123"; ``` ## MdxSubSelect An [Mdx](types#mdx) representing a subselect expression. | Property | Type | Description | | :-------------- | :------------------------------------------------------------------------- | :---------- | | axes | [MdxAxis](types#mdxaxis)\[] | | | elementType | "SubSelect" | | | from | [MdxSubSelect](types#mdxsubselect) \| [MdxFromClause](types#mdxfromclause) | | | nonVisualTotals | boolean | | | slicerAxis | [MdxSlicerAxis](types#mdxsliceraxis) \| null | | ## MdxUnknownCompoundIdentifier A [MdxCompoundIdentifier](types#mdxcompoundidentifier) representing an unknown identifier. | Property | Type | Description | | :---------- | :-------------------------------------- | :---------- | | elementType | "CompoundIdentifier" | | | identifiers | [MdxIdentifier](types#mdxidentifier)\[] | | | type | "unknown" | | Remarks: This type is used for any MDX compound identifier whose type cannot be identified. It is the case for all compound identifiers in the raw result of parsing an MDX string. It can then be further refined by confronting it to the dataModel and calling `getSpecificCompoundIdentifier`. ## MdxWhenClause An [Mdx](types#mdx) representing a `WHEN` clause of a [MdxCaseExpression](types#mdxcaseexpression), including the clause’s `THEN` true result expression. | Property | Type | Description | | :---------- | :----------------------------------- | :---------- | | elementType | "When" | | | then | [MdxExpression](types#mdxexpression) | | | when | [MdxExpression](types#mdxexpression) | | ## Measure | Property | Type | Description | | :----------- | :------------------------------- | :---------- | | caption | string | | | description | string | | | expression | string | | | folder | string | | | formatString | string | | | measureGroup | string | | | name | [MeasureName](types#measurename) | | | type | string | | | visible | boolean | | ## MeasureGroup | Property | Type | Description | | :---------- | :----- | :---------- | | caption | string | | | description | string | | | name | string | | ## MeasureInMapping A tile in the widget mapping, representing a measure. | Property | Type | Description | | :---------- | :-------- | :-------------------------------------------------------------------------------------------------------------------- | | caption | string | Optional caption for query-scoped calculated measures. For regular measures, the caption defined in the cube is used. | | measureName | string | | | type | "measure" | | ## MeasureName The readable name of a measure in a cube. string For example: ```tsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} const measureName = "pnl.SUM"; ``` ## MeasureNode A data model tree node representing a measure | Property | Type | Description | | :----------- | :----------------------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | cubeName | string | | | serverKey | string | | | measure | [Measure](types#measure) | | | type | "measure" | | ## MeasuresFolderNode A data model tree node representing a measuresFolder | Property | Type | Description | | :----------- | :--------------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | cubeName | string | | | serverKey | string | | | type | "measuresFolder" | | ## MeasureUniqueName A string representing the unique identifier of a measure in a cube. string For example: ```tsx theme={"languages":{"custom":["/engine/python-sdk/0.9/languages/pycon.tmLanguage.json"]}} const measureUniqueName = "[Measures].[pnl.SUM]"; ``` ## Member | Property | Type | Description | | :---------- | :------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | captionPath | string\[] | | | namePath | string\[] | | | properties | \{
   \[key: string]: unknown;
} | Properties attached to each member in [CellSet](types#cellset) positions.In Atoti UI, these properties are used in table header cells to: - Display extra information on hover. - Infer whether the cell can be drilled down.See [https://learn.microsoft.com/en-us/analysis-services/multidimensional-models/mdx/mdx-member-properties?view=asallproducts-allversions](https://learn.microsoft.com/en-us/analysis-services/multidimensional-models/mdx/mdx-member-properties?view=asallproducts-allversions) | ## MemberCoordinates Coordinates identifying a [Member](types#member). [HierarchyCoordinates](types#hierarchycoordinates) & \{
   namePath: string\[];
} ## MenuItemPlugin Plugin useful for items in the context menus of widgets or in the top right widget menu. | Property | Type | Description | | :-------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------ | | key | string | | | translations | \{
   \[locale: string]: [TranslationTree](types#translationtree)\;
} | | | doesContextMenuCloseOnClick | boolean | Whether clicking the menu item closes the context menu. true by default. | | useMenuItem | (props: [MenuItemProps](types#menuitemprops)\) => Omit\ \| Omit\ \| undefined | | ## MenuItemProps [ActionProps](types#actionprops)\ ## ModalsProviderProps | Property | Type | Description | | :------- | :----------------------------------------------------------- | :---------- | | modals | \{
   \[modalKey: string]: ComponentType\;
} | | ## NamedSetInMapping A tile in the widget mapping, representing a named set. | Property | Type | Description | | :------- | :--------- | :---------- | | name | string | | | type | "namedSet" | | ## NodeIconProps | Property | Type | Description | | :------- | :-------------------------------------------- | :---------- | | node | [InternalNode](types#internalnode)\ | | | style | CSSProperties | | ## NodeProps | Property | Type | Description | | :------------------ | :----------------------------------------------------------------------------------------------------- | :---------- | | caretStyle | CSSProperties | | | contextMenuItems | ItemType\[] | | | data | [InternalNode](types#internalnode)\\[] | | | getDefaultCaption | (node?: NodeType) => string | | | hasCheckbox | boolean | | | hasSelectedChildren | boolean | | | hoverStyle | CSSProperties | | | Icon | ComponentType\<[NodeIconProps](types#nodeiconprops)\> \| null | | | index | number | | | isEdited | boolean | | | isExpandable | boolean | | | isExpanded | boolean | | | isFocused | boolean | | | isPopoverOpen | boolean | | | isSelected | boolean | | | onClick | (item: [InternalNode](types#internalnode)\, event: ReactMouseEvent\) => void | | | onEditCanceled | () => void | | | onEditEnded | (path: number\[], caption: string) => void | | | onEditStarted | (path: number\[]) => void | | | onExpandToggled | (item: [InternalNode](types#internalnode)\, isExpanding: boolean) => void | | | popoverContent | ReactNode | | | popoverInnerHeight | number | | | popoverTitle | ReactNode | | | searchValue | string | | | selectionStyle | CSSProperties | | | style | CSSProperties | | | tooltip | JSX.Element | | | tooltipDelay | number | | | trees | [TreeObject](types#treeobject)\\[] | | ## NonEmptyEvaluationMeasureSetting Controls the measure used to filter out empty members in the list presented to the user when creating or editing a filter on a hierarchy. Members with no value for this measure are considered empty and are omitted from this list. This measure defaults to `contributors.COUNT`, and can be configured: - globally, by defining the setting value as a single measure name - or on a per hierarchy basis, by defining the setting value as a map from hierarchy unique name to measure name. This map also has a special `default` key, to define the measure that should be used for a hierarchy that is not expressed in the map. * string * Partial\<\{
   \[hierarchyUniqueName: string]: string;
   default: string;
}> ## NumberFormat The types of number format, corresponding to ways to abbreviate big numbers in order to make them more legible. * "number" * "thousands" * "millions" * "percentage" * "billions" ## OpenCommandPaletteAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to open the command palette. See `isCommandPaletteVisible` in [State](types#state). | Property | Type | Description | | :------- | :------------------- | :---------- | | type | "openCommandPalette" | | ## OrderMode * "ASC" * "DESC" * "BASC" * "BDESC" ## OrderModeMdxLiteral An [MdxLiteral](types#mdxliteral) that represents one of the [OrderMode](types#ordermode) strings. [MdxLiteral](types#mdxliteral) & \{
   type: "STRING";
   value: [OrderMode](types#ordermode);
} ## PerLocale An object where keys are locales and values are the passed generic type. \{
   "en-US": T;
   \[key: string]: T;
} ## Permission The permissions of a [ContentEntry](types#contententry) of a file or folder. * \{ userName: [UserName](types#username) * [UserRole](types#userrole); type: "reader" * "editor"; isPending?: boolean; } ## Permissions Flat map containing the permissions of the user regarding the behavior of various parts of Atoti. Permissions can be defined on the Content Server for the whole organization, a role (= group of users), or an individual user. In case of conflict, the most permissive permission prevails. Contrarily to Settings, a non-admin user cannot change their own permissions. | Property | Type | Description | | :----------------------- | :--------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | applicationMenus | [Allowlist](types#allowlist) | The menus available in the application header, such as Edit -> Undo. | | canManageContent | boolean | Whether the user can create, save, edit, and move dashboards. | | canShare | boolean | Whether the user can share content. | | canUseCalculatedMeasures | boolean | Whether the calculated measures creation and edition popup is available to the user. | | canUseDataModel | boolean | Whether the data model is available to the user. | | canUseNamedSets | boolean | Whether the named sets creation and edition popup is available to the user. | | canUseUserFilters | boolean | Whether the "All dashboards" section is visible in the filters tab and taken into account by widgets. When enabled, it allows users to create filters that apply to all dashboards they visit. | | canUseUserQueryContext | boolean | Whether the "All dashboards" section is visible in the query context tab and taken into account by widgets. When enabled, it allows users to create a global query context, which applies to all dashboards they visit. | | contextValues | [Allowlist](types#allowlist) | Names of the context values that are visible to the user, provided that they are defined in the cube. | | tools | [Allowlist](types#allowlist) | The tools available in the horizontal bar to the right of the data model, such as the fields tab. | | widgetMenuItems | [Allowlist](types#allowlist) | Keys of the menu item plugins that are granted to the user, provided that they are defined in the plugin registry. | | widgets | [Allowlist](types#allowlist) | Keys of the widget plugins that are granted to the user, provided that they are defined in the plugin registry. | | widgetTitleBarButtons | [Allowlist](types#allowlist) | | ## PinnableFilter \{
   isPinned?: boolean;
   pinnedFilterWidth?: number;
} ## PlotlyOverrides Plotly configuration overrides that can be made in the chart's configuration. | Property | Type | Description | | :------- | :----------------------------------- | :---------- | | config | Partial\ | | | data | [DataOverrides](types#dataoverrides) | | | layout | Partial\ | | ## PlotlyPieStyle The style of a Plotly pie chart widget. | Property | Type | Description | | :---------------------- | :----------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | headers | \{
   \[tupleKey: string]: CSSProperties;
} | | | measures | \{
   \[measureName: string]: FieldStyle;
} | | | tuples | \{
   \[tupleKey: string]: CSSProperties;
} | | | areAxisTitlesVisible | boolean | | | axisLabelFontSize | number | The font size of the labels on the axes. | | hasSingleScale | boolean | Used for Plotly "Columns and lines" charts. This indicates whether there is a single scale used between the columns and line values on the y-axes. If set to false, two different scales are used for the y-axes. | | isTextVisible | boolean | Whether values are displayed as text labels on chart elements. | | markerSize | number | The size of the chart markers. | | textIncludesMemberNames | boolean | Whether the caption of each slice includes the name of the member it represents. | ## PlotlyPieWidgetState The state of a Plotly pie chart widget. [PlotlyWidgetState](types#plotlywidgetstate)\ ## PlotlyStyle Style attributes (`widgetState.style`) of Plotly widgets. | Property | Type | Description | | :------------------- | :----------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | headers | \{
   \[tupleKey: string]: CSSProperties;
} | | | measures | \{
   \[measureName: string]: FieldStyle;
} | | | tuples | \{
   \[tupleKey: string]: CSSProperties;
} | | | areAxisTitlesVisible | boolean | | | axisLabelFontSize | number | The font size of the labels on the axes. | | hasSingleScale | boolean | Used for Plotly "Columns and lines" charts. This indicates whether there is a single scale used between the columns and line values on the y-axes. If set to false, two different scales are used for the y-axes. | | isTextVisible | boolean | Whether values are displayed as text labels on chart elements. | | markerSize | number | The size of the chart markers. | ## PlotlyWidgetState | Property | Type | Description | | :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | areFiltersDrivenByMdx | boolean | Whether the filters applied to the query when it is sent to the server are driven by: 1. widgetState.query.mdx (when true). It allows users to write filters as they like in the query tab. 2. dashboardState.filters, pageState.filters and widgetState.filters (when false). It allows a single source of truth for dashboard and page filters, preventing bugs.Defaults to false.In practice it is set to true when the user submits an MDX query in the query tab. It it set to false when filters are changed using other UI elements, such as the content or filters tab. | | query | Partial\<[Query](types#query)\> | | | serverKey | string | | | shouldUseDefaultColumns | MdxType extends [MdxDrillthrough](types#mdxdrillthrough) ? boolean : never | Whether the columns specified in the drillthrough.defaultSelectedColumns setting are used in the drillthrough query. It is useful when performing a drillthrough from another widget, as it allows to create the drillthrough widget right away, while triggering the query only once the default columns have been fetched. | | behavior | Behavior | | | mapping | T extends "serialized" ? [SerializedDataVisualizationWidgetMapping](types#serializeddatavisualizationwidgetmapping) : [DataVisualizationWidgetMapping](types#datavisualizationwidgetmapping) | | | style | Style | | | switchedTo | string | | | isInExpandMode | boolean | Whether the chart is in "drill down mode". When in drill down mode, the user can click a bar in order to filter on it and drill deeper into its children. | | plotly | [PlotlyOverrides](types#plotlyoverrides) | | | subplotLimits | [SubplotLimits](types#subplotlimits) | | | visibleGrandTotals | [AxisId](types#axisid)\[] | | | visibleSubTotals | [LevelUniqueName](types#leveluniquename)\[] | | ## Plugin Any type of Atoti UI plugin. * [CellPlugin](types#cellplugin)\ * [CellStylePlugin](types#cellstyleplugin)\ * [MenuItemPlugin](types#menuitemplugin)\ * [TitleBarButtonPlugin](types#titlebarbuttonplugin)\ * [WidgetPlugin](types#widgetplugin)\ ## PluginRegistry All Atoti UI plugins registered by the application using the SDK. | Property | Type | Description | | :---------------- | :--------------------------------------------------------------------------------------------------- | :---------- | | "cell-style" | [PluginsOfType](types#pluginsoftype)\<[CellStylePlugin](types#cellstyleplugin)> | | | "menu-item" | [PluginsOfType](types#pluginsoftype)\<[MenuItemPlugin](types#menuitemplugin)\> | | | "titlebar-button" | [PluginsOfType](types#pluginsoftype)\<[TitleBarButtonPlugin](types#titlebarbuttonplugin)\> | | | cell | [PluginsOfType](types#pluginsoftype)\<[CellPlugin](types#cellplugin)> | | | widget | [PluginsOfType](types#pluginsoftype)\<[WidgetPlugin](types#widgetplugin)\> | | ## PluginsOfType The plugins of a certain type (e.g. all registered widget plugins) ## PluginsProviderProps | Property | Type | Description | | :------- | :--------------------------------------------- | :---------- | | value | [PluginRegistry](types#pluginregistry) \| null | | ## PluginType A type of [Plugin](types#plugin). * "cell" * "cell-style" * "menu-item" * "titlebar-button" * "widget" ## PositionInDashboard The position of a widget within the dashboard. This information is available in all components in a widget when it is in a dashboard. | Property | Type | Description | | :--------- | :-------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | layoutPath | number\[] | The path describing the location of the widget within the page's layout. Can be used for operations within the layout, such as moving to a different place in the page. | | leafKey | string | Identifies the leaf in the page where a widget is located. Allows the widget to retrieve its state in pageState.content. | | pageKey | string | Identifies which page the widget is on. | ## PreviousOrNextMode * "previous" * "next" ## Query | Property | Type | Description | | :--------- | :--------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------- | | context | \{
   \[key: string]: string;
} | Context values usable as input for server-side calculations. E.g. the confidence level for value at risk calculation. | | mdx | T | Query to execute. | | ranges | \{
   \[axisId in [AxisId](types#axisid)]?: [QueryRange](types#queryrange);
} | Ranges of positions that should be returned by the server. E.g. "only return the first 100 rows and the first 20 columns". | | transform | [Transform](types#transform) | Client-side transformations to apply to the data returned by Atoti Server for this query. | | updateMode | [UpdateMode](types#updatemode) | Whether the query is only run once, or kept open in order to receive real-time updates. | ## QueryContextEntry A piece of a query's context. Allows to parametrize the behavior of Atoti Server when it answers the query. | Property | Type | Description | | :------- | :----- | :---------- | | key | string | | | value | string | | Remarks: Technical query context entries should not be accessible to end users. Functional query context entries can usually be replaced by analysis hierarchies, which offer a better experience to end users. Query context entries are still used by legacy projects, particularly in finance. For example: timeout, target currency, VaR sensitivity. ## QueryRange The range of results to fetch, in the case of infinite scrolling. [Range](types#range) ## QueryResult | Property | Type | Description | | :-------- | :--------------------------------------------- | :-------------------------------------------------------------------------------------------------------------- | | data | ResultType | The data for this result, either a [CellSet](types#cellset) or a [DrillthroughResult](types#drillthroughresult) | | error | [ErrorInQueryResult](types#errorinqueryresult) | | | isLoading | boolean | | ## QuickFilterDisplayMode The different ways in which a quick filter widget can be displayed. * "select" * "multi-select" * "checkbox" * "radio" * "tree" * "calendar" ## QuickFilterWidgetState The state of a [pluginWidgetQuickFilter](variables#pluginwidgetquickfilter). | Property | Type | Description | | :--------------- | :-------------------------------------------------------------- | :---------- | | query | \{
   updateMode?: [UpdateMode](types#updatemode);
} | | | cubeName | [CubeName](types#cubename) | | | levelCoordinates | [LevelCoordinates](types#levelcoordinates) | | | mode | [QuickFilterDisplayMode](types#quickfilterdisplaymode) | | | serverKey | string | | ## Quoting * "QUOTED" /\*\* \* Unquoted identifier, for example \`Geography\`. \*/ * "UNQUOTED" /\*\* \* Identifier quoted with an ampersand to indicate a key value, for example the second segment in \`\[Geography].&\[France]\`. \*/ * "AMP\_QUOTED" ## Range | Property | Type | Description | | :------- | :----- | :---------- | | from | number | | | to | number | | ## Range2D A 2D [Range](types#range). | Property | Type | Description | | :------- | :------------------- | :---------- | | columns | [Range](types#range) | | | rows | [Range](types#range) | | ## RecursiveDashboardPageState The state of a recursive dashboard page. `layout` represents how content is laid out. [BaseDashboardPageState](types#basedashboardpagestate)\ & \{
   type?: "recursive";
   layout: [Layout](types#layout);
} ## RecursiveFolderPermissionUpdateParams The type of the argument of `contentClient.updateFolderPermissions` when the update is recursive. I.e. when it also applies to the folder's descendants. | Property | Type | Description | | :----------------- | :------------------------------- | :---------- | | id | string | | | pathToParentFolder | string\[] | | | type | [ContentType](types#contenttype) | | | ownersToAdd | string\[] | | | ownersToRemove | string\[] | | | readersToAdd | string\[] | | | readersToRemove | string\[] | | | recursive | true | | ## RelativeTimeMode * [PreviousOrNextMode](types#previousornextmode) * "toDate" ## ResourcesPanelChangedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to change the currently open resources panel. See `resourcesPanelKey` in [State](types#state). | Property | Type | Description | | :---------------- | :------------------------------------- | :---------- | | resourcesPanelKey | "data-model" \| "widgets" \| "filters" | | | type | "resourcesPanelChanged" | | ## RootTilePositionWithinSection | Property | Type | Description | | :-------- | :----- | :---------- | | tileIndex | number | | ## SectionPositionWithinWizard The position of a section within a Wizard. | Property | Type | Description | | :---------- | :----- | :---------- | | sectionName | string | | ## SelectionWithinWidget The selected elements in a widget. For instance, selected cells in a table or selected points in a chart. \{
   highLevelSelection: HighLevelSelection;
   lowLevelSelection: LowLevelSelection;
} ## SelectionWithinWidgetChangedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) dispatched when the selected elements within a widget change. See `selectionWithinWidgets` in [State](types#state). | Property | Type | Description | | :-------- | :--------------------------------------------------- | :---------- | | leafKey | string | | | pageKey | string | | | selection | [SelectionWithinWidget](types#selectionwithinwidget) | | | type | "selectionWithinWidgetChanged" | | ## SelectionWithinWidgetClearedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) dispatched when the selection is cleared within a widget. See `selectionWithinWidgets` in [State](types#state). | Property | Type | Description | | :------- | :----------------------------- | :---------- | | leafKey | string | | | pageKey | string | | | type | "selectionWithinWidgetCleared" | | ## SelectionWithinWidgets \{
   \[pageKey: string]: \{
     \[leafKey: string]: [SelectionWithinWidget](types#selectionwithinwidget);
  };
} ## SelectSettingDefinition The definition of a setting editable via a select. * ([ASettingDefinition](types#asettingdefinition)\ & \{
   type: "select";
   options: Option\[];
   mode?: "single";
}) * ([ASettingDefinition](types#asettingdefinition)\ & \{
   type: "select";
   options: Option\[];
   mode: "multiple";
}) ## SerializableWidgetPluginProperties The properties of a [WidgetPlugin](types#widgetplugin) that can be serialized. | Property | Type | Description | | :----------------------------- | :--------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | key | string | | | translations | \{
   \[locale: string]: [TranslationTree](types#translationtree)\;
} | | | attributes | [WidgetAttributes](types#widgetattributes) | | | attributesDrivingColors | string\[] | The names of mapping attributes that can be used to customize colors using the Colors Editor. | | category | [WidgetCategory](types#widgetcategory) | | | contextMenuItems | string\[] | | | doesSupportMeasuresRedirection | boolean | | | initialState | WidgetState | | | lazyLoading | \{
   chunkSizes: Partial\>;
} | Configuration of the maximum number of rows and columns that this widget fetches. Past these values, lazy loading kicks in: more rows and columns are only fetched dynamically when the user scrolls. When this attribute is omitted, it means that the widget does not support lazy loading and will fetch the entirety of the required data upfront. | | menuItems | string\[] | | | subCategory | string | | | titleBarButtons | string\[] | | ## SerializedDataVisualizationWidgetMapping The attributes to fields mapping, specific to a given type of data visualization widget. Contains serialized fields. See [DataVisualizationWidgetMapping](types#datavisualizationwidgetmapping) For example: ``` { rows: [ "[Currency].[Currency].[Currency]" ] } ``` ## ServerNode A data model tree node representing a server | Property | Type | Description | | :----------- | :------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | type | "server" | | ## ServerPath The ids of the folders containing a [ContentRecord](types#contentrecord), from the top-level folder down to the record's own id. string\[] ## ServiceKey * "sentinel" * "jwt" * "pivot" * "repository" * "content" * "reporting" * "activeviam/sentinel" * "activeviam/jwt" * "activeviam/pivot" * "activeviam/repository" * "activeviam/content" * "activeviam/reporting" ## ServicesVersions | Property | Type | Description | | :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------- | | apis | \{
   \[serviceKey: string]: \{
     versions: \[[ServiceVersion](types#serviceversion), ...[ServiceVersion](types#serviceversion)\[]];
  };
} | | | serverVersion | string | | | version | number | | ## ServiceVersion | Property | Type | Description | | :------- | :----- | :---------- | | id | string | | | restPath | string | | | wsPath | string | | ## Set | Property | Type | Description | | :---------- | :----------------------- | :---------- | | caption | string | | | description | string | | | expression | string | | | name | [SetName](types#setname) | | ## SetName string ## SetNode A data model tree node representing a set | Property | Type | Description | | :----------- | :--------------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | cubeName | string | | | serverKey | string | | | set | [Set](types#set) | | | type | "set" | | ## SetsRootNode A data model tree node representing a setsRoot | Property | Type | Description | | :----------- | :--------- | :---------- | | caption | string | | | dragItem | any | | | isActionable | boolean | | | isDisabled | boolean | | | isFolder | boolean | | | cubeName | string | | | serverKey | string | | | type | "setsRoot" | | ## SettingDefinition The definition of a setting. * [SelectSettingDefinition](types#selectsettingdefinition)\ * [HierarchySelectSettingDefinition](types#hierarchyselectsettingdefinition)\ * [CheckboxSettingDefinition](types#checkboxsettingdefinition)\ * [InputSettingDefinition](types#inputsettingdefinition)\ * [InputNumberSettingDefinition](types#inputnumbersettingdefinition)\ ## SettingsGroup The definition of a group of settings. * \{
   key: string;
   type: "group";
   settings: [SettingDefinition](types#settingdefinition)\\[];
   searchTokens?: string\[];
} &
(\{
   translations: [PerLocale](types#perlocale)\<\{
     title: string;
  }>;
} * \{
   hasCheckbox: true;
   defaultValue: boolean;
   translations: [PerLocale](types#perlocale)\<\{
     title: string;
     description: string;
  }>;
}) ## SettingTranslationsWithOptions [ASettingTranslations](types#asettingtranslations) & \{
   options?: \{
     \[optionName: string]: string;
  };
} ## Side * "center" * "top" * "right" * "bottom" * "left" ## SimpleFolderPermissionUpdateParams The type of the argument of `contentClient.updateFolderPermissions` when the update is NOT recursive. I.e. when it does NOT also apply to the folder's descendants. | Property | Type | Description | | :----------------- | :------------------------------- | :---------- | | id | string | | | pathToParentFolder | string\[] | | | type | [ContentType](types#contenttype) | | | owners | string\[] | | | readers | string\[] | | | recursive | false | | ## State The state of Atoti UI. It can be extended through [Configuration](types#configuration). | Property | Type | Description | | :---------------------------- | :---------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | activeToolKey | string \| null | The unique key identifying the tool currently open to the right of the data model. null if no tool is open. | | atotiClients | MultiAtotiClientState | The states of the Atoti clients used in the application. | | contentClient | ContentClientState | Content-related state loaded from the Content Server. | | dashboard | StateWithHistory\<[DashboardState](types#dashboardstate) \| null> | The state of the dashboard, or null if no dashboard is loaded. | | expandedFolderPathsInHomePage | string\[]\[] | The expanded folders in the dashboards tree in the home page. | | isCommandPaletteVisible | boolean | Whether the command palette is visible. | | isDataModelTreeExpanded | boolean | Whether the data model tree is expanded or collapsed. | | isDeferred | boolean | Whether deferred updates are enabled for MDX queries fired by widgets in the dashboard. | | isMoveDashboardModalVisible | boolean | Whether the dashboard 'Move' modal is visible. | | isOpenDashboardPopupVisible | boolean | Whether the 'Open Dashboard' popup is visible. | | isPresenting | boolean | Whether the application is in presentation mode. | | isSaveDashboardAsModalVisible | boolean | Whether the dashboard 'Save as' modal is visible. | | isSettingsPopupVisible | boolean | Whether the 'Settings' popup is visible. | | isShareDashboardModalVisible | boolean | Whether the dashboard 'Share' modal is visible. | | isToolsPanelExpanded | boolean | Whether the tools panel is expanded. | | isWidgetsPanelVisible | boolean | Whether the widgets panel is visible. | | lastSavedDashboardHash | number \| null | A hash of the dashboard state, useful to efficiently determine whether the dashboard has unsaved changes. See [getHasUnsavedChanges](functions#gethasunsavedchanges) | | resourcesPanelKey | "data-model" \| "widgets" \| "filters" | The open resource panel, located to the left of the application. | | selectionWithinWidgets | [SelectionWithinWidgets](types#selectionwithinwidgets) | The selection of each widget in each page of the dashboard. | | statusNotifications | [StatusNotification](types#statusnotification)\[] | The notifications about the status of asynchronous actions in progress. | | widgetSelection | [WidgetSelectionState](types#widgetselectionstate) \| null | The key of the selected widget in each page. | | widgetsPanelWidth | number | The width of the widgets panel, when it is visible. | ## StaticStore A simplified version of a Redux Store, where the reducer cannot be replaced. * Pick\, "getState" * "dispatch" * "subscribe"> ## StatusNotification [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to notify the user about the status of the asynchronous actions (for instance saving a dashboard) taking place. See `statusNotification` in [State](types#state). | Property | Type | Description | | :------- | :------------------------------------- | :---------- | | action | "saving" \| "loading" | | | id | string | | | status | "pending" \| "fulfilled" \| "rejected" | | ## StatusNotificationAddedAction | Property | Type | Description | | :------- | :------------------------ | :---------- | | type | "statusNotificationAdded" | | ## StatusNotificationRemovedAction | Property | Type | Description | | :------- | :-------------------------- | :---------- | | type | "statusNotificationRemoved" | | ## StatusNotificationSettledAction | Property | Type | Description | | :------- | :-------------------------- | :---------- | | status | "fulfilled" \| "rejected" | | | type | "statusNotificationSettled" | | ## SubmittedKpiComparison * [HierarchyCoordinates](types#hierarchycoordinates) & [HierarchyCoordinates](types#hierarchycoordinates) & \{ referenceMemberNamePath: string\[] * DynamicMemberNamePath; comparedMemberNamePath: string\[] * DynamicMemberNamePath; } ## SubplotLimits Maximum number of subplots that will be displayed horizontally and vertically. | Property | Type | Description | | :--------- | :----- | :---------- | | horizontal | number | | | vertical | number | | ## SubtilePositionWithinSection | Property | Type | Description | | :----------- | :----- | :---------- | | tileIndex | number | | | subtileIndex | number | | ## Syntax * "Property" /\*\* \* Function style, e.g. \`FUNCTION()\` or \`FUNCTION(args)\`. \*/ * "Function" /\*\* \* Method style, e.g. \`object.METHOD()\` or \`object.METHOD(args)\`. \*/ * "Method" /\*\* \* Infix style, e.g. \`arg OPERATOR arg\` (typically for operators such as '+' or 'AND'). \*/ * "Infix" /\*\* \* Prefix style, e.g. \`OPERATOR arg\` (typically for unary operators such as '-'). \*/ * "Prefix" /\*\* \* Parentheses style, e.g. \`(ARG,...)\` (used for tuple expressions) \*/ * "Parentheses" /\*\* \* Braces style, e.g. \`\{
  ARG, ...
}\` (used for set expressions) \*/ * "Braces" ## TableCell The minimal information representing a cell in the Table component. Note that this has no reality in terms of the data fetched from Atoti Server and it is entirely specific to the Table component. * \{ caption: string; value: number * string; } * null ## TableRangeStyle Style, attached to a given range of cells within a table. \{
   range: [Range2D](types#range2d);
   style: CSSProperties;
} ## TableStateDerivedFromCellSet The information derived from `data` and used by [CellSetTable](components#cellsettable) and its children (including plugins). | Property | Type | Description | | :------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | cells | CellSetTableCell\[]\[] | The cells forwarded to the underlying Table component. The dimensions of the array include the frozen rows and columns. Only the cells of the body are filled, as the rendering of the header cells depend on more information, present in the metaData. | | columnHeaderIndices | \{
   hierarchyIndex: number;
   levelIndex: number;
}\[] | Represents the level corresponding to each frozen row of the column header. | | columnIndexImpactingRowStyle | number | The index of the column whose conditional formatting impacts full rows, if applicable. | | columnsAxis | [Axis](types#axis) \| undefined | | | cube | [Cube](types#cube) | | | data | [CellSet](types#cellset) | | | defaultMeasure | [DefaultMember](types#defaultmember) | | | hierarchyIndicesInCellSet | [HierarchyIndicesInCellSet](types#hierarchyindicesincellset) | | | indexOfMeasureOnSlicer | number | | | isRowHeaderTree | boolean | | | loadedRange | [Range2D](types#range2d) | | | mapping | [DataVisualizationWidgetMapping](types#datavisualizationwidgetmapping) | | | memberPropertyKeys | string\[] | | | numberOfColumnsInBody | number | | | numberOfFrozenColumns | number | | | numberOfFrozenRows | number | | | numberOfRowsInBody | number | | | rowHeaderIndices | \{
   hierarchyIndex: number;
   levelIndex: number;
}\[] | | | rowsAxis | [Axis](types#axis) | | | slicerAxis | [Axis](types#axis) | | | sort | \{
   orderMode: [OrderMode](types#ordermode) \| undefined;
   tupleCoordinates?: [TupleCoordinates](types#tuplecoordinates);
   levelCoordinates?: [LevelCoordinates](types#levelcoordinates);
} | | | staticHeaderCoordinatesOnColumns | [TableStaticHeaderCoordinates](types#tablestaticheadercoordinates)\[] | | | staticHeaderCoordinatesOnRows | [TableStaticHeaderCoordinates](types#tablestaticheadercoordinates)\[] | | | staticHeadersOnColumns | [TableStaticHeader](types#tablestaticheader)\[] | | | staticHeadersOnRows | [TableStaticHeader](types#tablestaticheader)\[] | | | styleImpactingRows | [AFieldStyle](types#afieldstyle) | The style impacting full rows, if applicable. It corresponds to the style of the tupleImpactingRowStyle from [TableWidgetStyle](types#tablewidgetstyle). For instance, if the table has currencies and measures on columns, the this tuple can be (EUR, delta.SUM). | ## TableStaticHeader * \{
   type: "Measures";
} * [Level](types#level) ## TableStaticHeaderCoordinates * \{
   dimensionName: "Measures";
   hierarchyName: "Measures";
} * [LevelCoordinates](types#levelcoordinates) ## TableWidgetPlugin The more specific [WidgetPlugin](types#widgetplugin) interface, suited for table widgets. | Property | Type | Description | | :----------------------------- | :------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | key | string | | | translations | \{
   \[locale: string]: [TranslationTree](types#translationtree)\;
} | | | attributes | [WidgetAttributes](types#widgetattributes) | | | attributesDrivingColors | string\[] | The names of mapping attributes that can be used to customize colors using the Colors Editor. | | category | [WidgetCategory](types#widgetcategory) | | | contextMenuItems | string\[] | | | doesSupportMeasuresRedirection | boolean | | | initialState | WidgetState | | | lazyLoading | \{
   chunkSizes: Partial\>;
} | Configuration of the maximum number of rows and columns that this widget fetches. Past these values, lazy loading kicks in: more rows and columns are only fetched dynamically when the user scrolls. When this attribute is omitted, it means that the widget does not support lazy loading and will fetch the entirety of the required data upfront. | | menuItems | string\[] | | | subCategory | string | | | titleBarButtons | string\[] | | | behaviorEditor | ComponentType\<[EditorProps](types#editorprops)\> | | | Component | ComponentType\<[WidgetPluginProps](types#widgetpluginprops)\> | | | contentEditor | ComponentType\<[EditorProps](types#editorprops)\> | | | filtersEditor | ComponentType\<[EditorProps](types#editorprops)> | | | Icon | ComponentType\ | | | queryEditor | ComponentType\<[EditorProps](types#editorprops)\> | | | style | Style | | | styleEditor | ComponentType\<[EditorProps](types#editorprops)\> | | | titleSuffix | ComponentType\<[WidgetPluginProps](types#widgetpluginprops)\> | Optional component rendered next to the widget name in the dashboard title bar. When omitted, the title bar shows only the widget name. Receives the same props as [WidgetPlugin](types#widgetplugin). | | useOnDataModelNodeClicked | (widgetState: WidgetState) => (node: [DataModelNode](types#datamodelnode)) => WidgetState | Controls what happens to the widget when the user clicks fields in the data model. | | cell | string | The key of the cell plugin to use. | | cellStyle | string | The key of the cell style plugin to use. | ## TableWidgetState | Property | Type | Description | | :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | areFiltersDrivenByMdx | boolean | Whether the filters applied to the query when it is sent to the server are driven by: 1. widgetState.query.mdx (when true). It allows users to write filters as they like in the query tab. 2. dashboardState.filters, pageState.filters and widgetState.filters (when false). It allows a single source of truth for dashboard and page filters, preventing bugs.Defaults to false.In practice it is set to true when the user submits an MDX query in the query tab. It it set to false when filters are changed using other UI elements, such as the content or filters tab. | | query | Partial\<[Query](types#query)\> | | | serverKey | string | | | shouldUseDefaultColumns | MdxType extends [MdxDrillthrough](types#mdxdrillthrough) ? boolean : never | Whether the columns specified in the drillthrough.defaultSelectedColumns setting are used in the drillthrough query. It is useful when performing a drillthrough from another widget, as it allows to create the drillthrough widget right away, while triggering the query only once the default columns have been fetched. | | behavior | Behavior | | | mapping | T extends "serialized" ? [SerializedDataVisualizationWidgetMapping](types#serializeddatavisualizationwidgetmapping) : [DataVisualizationWidgetMapping](types#datavisualizationwidgetmapping) | | | style | Style | | | switchedTo | string | | | columnWidths | \{
   \[tupleKey: string]: number;
} | The widths of columns that have been resized, in pixels. | | hiddenColumns | string\[] | The tuple keys identifying the columns that have been hidden. | | hiddenFrozenRows | string\[] | The level coordinates identifying the frozen rows that have been hidden. | ## TableWidgetStyle The style attribute of a table widget state | Property | Type | Description | | :---------------------- | :----------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | headers | \{
   \[tupleKey: string]: CSSProperties;
} | | | measures | \{
   \[measureName: string]: FieldStyle;
} | | | tuples | \{
   \[tupleKey: string]: CSSProperties;
} | | | areColumnNumbersVisible | boolean | Whether column numbers are visible. Column numbers display Excel-style letters (A, B, C, ..., AA, AB, ...) above the table headers. | | areRowNumbersVisible | boolean | Whether row numbers are visible. Row numbers allow to select an entire row. When they are visible, a button in the top left corner of the table allows to select all the cells of the table. | | areTooltipsVisible | boolean | Whether tooltips are accessible on numeric cells. | | cells | [TableRangeStyle](types#tablerangestyle)\[] | Styles attached to specific ranges of cells within the table. Each entry maps a range of cells (in absolute grid coordinates) to a CSS style to apply on them. | | size | "large" \| "medium" \| "small" | The overall spacing within the table. Drives default row heights and column widths. Columns can then be resized individually. | | tupleImpactingRowStyle | [TupleCoordinates](types#tuplecoordinates) | The tuple representing the column whose conditional formatting impacts row styles. | | wrapHeaders | boolean | Whether the text content of table headers wrap to the next line if it contains multiple words and is too long, or if sticks to a single line and has an ellipsis instead. | ## TextEditorWidgetState State of a [pluginWidgetTextEditor](variables#pluginwidgettexteditor) widget. | Property | Type | Description | | :--------------- | :--------------- | :--------------------------------------------------------------------------------------------------------------------------------- | | displayMode | "view" \| "edit" | | | text | string | | | titleInfoTooltip | string | Text shown in the tooltip of the info icon rendered next to the text editor's widget name. When omitted, no info icon is rendered. | ## Theme Contains all style attributes used by Atoti UI components. | Property | Type | Description | | :------------------------------------- | :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | activeMenuItemBackgroundColor | [Color](types#color) | The background color when a user hovers over a menu item. | | activeTabBackgroundColor | [Color](types#color) | The background color of the tab representing the active page in a dashboard. | | alternateBackgroundColor | [Color](types#color) | The alternative background color, for instance the color of a tile or a data model header. | | alternateCellBackgroundColor | [Color](types#color) | For table widgets the background color for the alternating color. | | backgroundColor | [Color](types#color) | The background color of the app. | | black | [Color](types#color) | Representative of the darkest color in the grayScale property, affects the overlay color. It is also the default color of header text and labels. | | cellBackgroundDuringNegativeTransition | [Color](types#color) | The background color of a cell when its value decreases in a real time query. | | cellBackgroundDuringPositiveTransition | [Color](types#color) | The background color of a cell when its value increases in a real time query. | | cellBorderColor | [Color](types#color) | The border color of table widgets. | | disabledBackground | [Color](types#color) | Background color when a menu item cannot be selected, primarily affects buttons. | | disabledTextColor | [Color](types#color) | Text color when a menu item cannot be selected. | | dropHintBorderColor | [Color](types#color) | The border color of the area that appears when a user is dragging and dropping widgets, either when trying to move the widget or when trying to place it from the widget insertion menu. | | dropHintColor | [Color](types#color) | The background color of the area that appears when a user is dragging and dropping widgets, either when trying to move the widget or when trying to place it from the ribbon. | | errorColor | [Color](types#color) | The default color for highlighting negative values. Inherently stands in for cellBackgroundDuringNegativeTransition if not supplied. Affects asterisks signifying required inputs as well. Used as background of tiles representing corrupted fields or filters in the wizard. Corrupted fields are fields that do not exist in the cube to which the widget is connected. | | grayScale | [Color](types#color)\[] | An array of 14 colors representing a spectrum from the white property to the black property. If not provided it is constructed from the black and white properties. | | headerActiveColor | [Color](types#color) | The text or icon color of a menu item in the application header when it is active. | | hoverColor | [Color](types#color) | The text color when a user hovers over a menu item. Secondarily serves as the text and icon color of the currently active menu item. | | inactiveTabBackgroundColor | [Color](types#color) | The background color of the tabs representing pages that are not currently being viewed in the dashboard. | | isDark | boolean | Boolean flagging whether or not the theme is a dark variant. | | menuInlineSubmenuBg | [Color](types#color) | The background color of an inline sub menu. | | placeholderColor | [Color](types#color) | The text color for the placeholder title of a new widget. | | primaryColor | [Color](types#color) | The only mandatory theme color. It serves a the base color for all other colors if they are not provided. | | primaryScale | [Color](types#color)\[] | An array of 10 colors representing a spectrum from light variants of primaryColor to dark variants of the primaryColor (in the opposite order when the theme is dark). If not provided it is constructed from the primaryColor property. | | selectedMenuItemBackground | [Color](types#color) | | | selectionColor | [Color](types#color) | The background color of the selected menu item. | | selectionMarkDarkColor | [Color](types#color) | The color of the checkmark in the color selector of the style tab if the selected color is light enough to provide contrast to a dark color. | | selectionMarkLightColor | [Color](types#color) | The color of the checkmark in the color selector of the style tab if the selected color is dark enough to provide contrast to a light color. | | selectionOverlayColor | [Color](types#color) | The overlay color to display when selecting a value in a widget cell. | | shadowColor | [Color](types#color) | | | statusColors | StatusColors | Colors for status indicators throughout the UI. | | successColor | [Color](types#color) | The default color for highlighting positive values, inherently stands in for cellBackgroundDuringPositiveTransition if not supplied. | | textColor | [Color](types#color) | Default text and icon color. | | warningColor | [Color](types#color) | Default color for warning alert icons i.e. when deleting dashboards. | | white | [Color](types#color) | Lightest color in the grayScale property, affects the text color when renaming a dashboard. | ## TilePositionWithinSection * [RootTilePositionWithinSection](types#roottilepositionwithinsection) * [SubtilePositionWithinSection](types#subtilepositionwithinsection) ## TilePositionWithinWizard The position of a tile (or subtile) within a Wizard. [SectionPositionWithinWizard](types#sectionpositionwithinwizard) & [TilePositionWithinSection](types#tilepositionwithinsection) ## TimePeriod * "day" * "week" * "month" * "quarter" * "year" ## TitleBarButtonPlugin Plugin useful to define buttons accessible next to the top right menu of widgets. | Property | Type | Description | | :----------- | :--------------------------------------------------------------------------------------- | :---------- | | key | string | | | translations | \{
   \[locale: string]: [TranslationTree](types#translationtree)\;
} | | | Component | ComponentType\<[ActionProps](types#actionprops)\> | | ## Tool Tool accessible by clicking its `icon` in the horizontal bar to the right of the data model. Useful to allow users to edit the dashboard or interact with it. | Property | Type | Description | | :----------- | :------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | component | ComponentType\<[EditorProps](types#editorprops)> | The component displayed when the user opens the tool. | | icon | ComponentType | The icon displayed in the horizontal bar and on which the user can click in order to open or close this tool. | | key | string | Identifies the tool. | | shortcut | string | The key of the shortcut to open this tool. For instance, "w" means that the user can open this tool by pressing "Alt" + "w". | | translations | \{
   \[locale: string]: \{
     \[key: string]: string;
  };
} | Translations specific to this tool. This is useful if you wish to include a tool within an extension (see [ExtensionModule](types#extensionmodule)) in order to make it reusable across projects. | | type | "double" \| "single" | Whether the tool contains two independently resizable parts, or if it is a single block. | ## TopBottomMode * "TopCount" * "TopSum" * "TopPercent" * "BottomCount" * "BottomSum" * "BottomPercent" ## Trace * Omit\, "x" * "y" * "r" * "theta"> & "theta"> & \{ \_key: string; \_styleKey?: string; \_baseColor?: C; cellsIndices: (CellIndices\[] * null)\[]; axisIndices?: (number * null)\[]; texttemplate?: string\[]; } & (T extends "vertical" ? & (T extends "vertical" ? \{ x: (string * null)\[]; y: (number * null)\[]; } : unknown) & (T extends "horizontal" ? : unknown) & (T extends "horizontal" ? \{ x: (number * null)\[]; y: (string * null)\[]; } : unknown) & (T extends "scatter" ? : unknown) & (T extends "scatter" ? \{ x: (number * null)\[]; y: (number * null)\[]; } : unknown) & (T extends "radar" ? : unknown) & (T extends "radar" ? \{ r: (number * null)\[]; theta: string\[]; } : unknown) & (T extends "surface" ? : unknown) & (T extends "surface" ? \{ z: (number * null)\[]\[]; } : unknown) ## TraceType Defines whether the trace has an ordinal horizontal axis and a numeric vertical one, or the other way around. * "horizontal" * "vertical" * "noaxis" * "scatter" * "radar" * "surface" For example: Lines and column charts are "vertical" whereas bar charts are "horizontal". ## Transform Client-side transformations to apply to the data returned by Atoti Server for this query. | Property | Type | Description | | :------------ | :----------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------- | | memberAliases | \{
   \[memberUniqueName: string]: string;
} | Aliases overriding the displayed caption of specific members, keyed by member unique name. | | membersOrder | \{
   \[levelCoordinates: string]: \{
     \[memberName: string]: number;
  };
} | The order of members for specific levels. | ## TranslationTree A tree of translations identified by a key. ## TreeContextMenuItemProps | Property | Type | Description | | :------------ | :------------------------------------------- | :---------- | | node | NodeType | | | onEditStarted | () => void | | | path | number\[] | | | trees | [TreeObject](types#treeobject)\\[] | | ## TreeContextMenuProps | Property | Type | Description | | :------------ | :------------------------------------------- | :---------- | | node | NodeType | | | onEditStarted | () => void | | | path | number\[] | | | trees | [TreeObject](types#treeobject)\\[] | | ## TreeObject T & \{
   children?: [TreeObject](types#treeobject)\\[];
} ## Tuple The coordinates of an aggregate in a cube. Can be used for instance to represent a cell in a table or a point in a chart. ([HierarchyCoordinates](types#hierarchycoordinates) & [Member](types#member))\[] ## TupleCoordinates Coordinates identifying a [Tuple](types#tuple). [MemberCoordinates](types#membercoordinates)\[] ## UpdateMode Update mode for MDX query. * "once" * "realTime" ## User The name and roles of a user. | Property | Type | Description | | :-------- | :-------- | :---------- | | username | string | | | userRoles | string\[] | | ## UserName The name of a user. string ## UserRole The name of a role for users. string ## WidgetActionProps | Property | Type | Description | | :---------------- | :------------------------------------ | :---------- | | className | string | | | lowLevelSelection | LowLevelSelectionType | | | onWidgetChange | (newWidgetState: WidgetState) => void | | | queryId | string | | | selection | SelectionType | | | widgetState | WidgetState | | ## WidgetAttribute | Property | Type | Description | | :---------------- | :----------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | isMainAxis | boolean | Defines whether the attribute represents the main axis of the widget. Useful in the case of charts.The main axis of a line or column chart is xAxis. The one of a bar chart is yAxis. | | maxNumberOfFields | number | | | role | [AttributeRole](types#attributerole) | | ## WidgetAttributes An object containing [WidgetAttribute](types#widgetattribute) values identified by their name. ## WidgetCategory * "dataVisualization" * "editor" * "filter" * "monitor" * "misc" ## WidgetContent The content of the file to fetch in order to render a dashboard. Like SerializedDashboardState, but name and value.widgetKey are omitted. * Omit\<[AWidgetState](types#awidgetstate)\<"serialized">, "name" * "widgetKey"> ## WidgetInDashboardActionProps | Property | Type | Description | | :----------------- | :------------------------------------------------------------------ | :---------- | | className | string | | | lowLevelSelection | LowLevelSelectionType | | | onWidgetChange | (newWidgetState: WidgetState) => void | | | queryId | string | | | selection | SelectionType | | | widgetState | WidgetState | | | dashboardState | [DashboardState](types#dashboardstate) | | | layoutPath | number\[] | | | leafKey | string | | | onActivePageChange | (newActivePageKey: string) => void | | | onDashboardChange | (newDashboardState: [DashboardState](types#dashboardstate)) => void | | | pageKey | string | | ## WidgetMetaData The content of the file to fetch in order to render the node representing a widget in the widgets tree. | Property | Type | Description | | :-------- | :------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | isFolder | boolean | | | name | string | | | version | number | The version is copied to [AWidgetState](types#awidgetstate) each time a saved widget is added to a dashboard. It is incremented each time the saved widget is updated. It is used to know whether a saved widget and a copy of it within a dashboard are in sync. | | widgetKey | string | | ## WidgetPlugin Plugin defining a component that can be used in a dashboard. | Property | Type | Description | | :----------------------------- | :------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | key | string | | | translations | \{
   \[locale: string]: [TranslationTree](types#translationtree)\;
} | | | attributes | [WidgetAttributes](types#widgetattributes) | | | attributesDrivingColors | string\[] | The names of mapping attributes that can be used to customize colors using the Colors Editor. | | category | [WidgetCategory](types#widgetcategory) | | | contextMenuItems | string\[] | | | doesSupportMeasuresRedirection | boolean | | | initialState | WidgetState | | | lazyLoading | \{
   chunkSizes: Partial\>;
} | Configuration of the maximum number of rows and columns that this widget fetches. Past these values, lazy loading kicks in: more rows and columns are only fetched dynamically when the user scrolls. When this attribute is omitted, it means that the widget does not support lazy loading and will fetch the entirety of the required data upfront. | | menuItems | string\[] | | | subCategory | string | | | titleBarButtons | string\[] | | | behaviorEditor | ComponentType\<[EditorProps](types#editorprops)\> | | | Component | ComponentType\<[WidgetPluginProps](types#widgetpluginprops)\> | | | contentEditor | ComponentType\<[EditorProps](types#editorprops)\> | | | filtersEditor | ComponentType\<[EditorProps](types#editorprops)> | | | Icon | ComponentType\ | | | queryEditor | ComponentType\<[EditorProps](types#editorprops)\> | | | style | Style | | | styleEditor | ComponentType\<[EditorProps](types#editorprops)\> | | | titleSuffix | ComponentType\<[WidgetPluginProps](types#widgetpluginprops)\> | Optional component rendered next to the widget name in the dashboard title bar. When omitted, the title bar shows only the widget name. Receives the same props as [WidgetPlugin](types#widgetplugin). | | useOnDataModelNodeClicked | (widgetState: WidgetState) => (node: [DataModelNode](types#datamodelnode)) => WidgetState | Controls what happens to the widget when the user clicks fields in the data model. | ## WidgetPluginInDashboardProps Props received by a widget plugin component within a dashboard | Property | Type | Description | | :----------------- | :---------------------------------------------------------------------------------- | :---------- | | isDeferred | boolean | | | isSelected | boolean | | | onChange | (newState: WidgetState) => void | | | onLoaded | () => void | | | onSelectionChange | (newSelection: SelectionType, newLowLevelSelection?: LowLevelSelectionType) => void | | | queryId | string | | | style | CSSProperties | | | widgetState | WidgetState | | | onElementsActioned | (elements: Elements) => void | | | dashboardState | [DashboardState](types#dashboardstate) | | | layoutPath | number\[] | | | leafKey | string | | | onActivePageChange | (newActivePageKey: string) => void | | | onDashboardChange | (newDashboardState: [DashboardState](types#dashboardstate)) => void | | | pageKey | string | | ## WidgetPluginOutsideADashboardProps | Property | Type | Description | | :----------------- | :---------------------------------------------------------------------------------- | :---------- | | isDeferred | boolean | | | isSelected | boolean | | | onChange | (newState: WidgetState) => void | | | onLoaded | () => void | | | onSelectionChange | (newSelection: SelectionType, newLowLevelSelection?: LowLevelSelectionType) => void | | | queryId | string | | | style | CSSProperties | | | widgetState | WidgetState | | | onElementsActioned | (elements: Elements) => void | | ## WidgetPluginProps Props received by a widget plugin component. * [WidgetPluginOutsideADashboardProps](types#widgetpluginoutsideadashboardprops)\ * [WidgetPluginInDashboardProps](types#widgetpluginindashboardprops)\ ## WidgetSelectedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) to change the selected widget in a dashboard page. See `widgetSelection` in [State](types#state). | Property | Type | Description | | :------- | :--------------- | :---------- | | leafKey | string | | | pageKey | string | | | type | "widgetSelected" | | ## WidgetSelectionState The key of the selected widget in each page. ## WidgetsPanelClosedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) dispatched when the user closes the widgets panel. See `isWidgetsPanelVisible` in [State](types#state). | Property | Type | Description | | :------- | :------------------ | :---------- | | type | "widgetPanelClosed" | | ## WidgetsPanelOpenedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) dispatched when the user opens the widgets panel. See `isWidgetsPanelVisible` in [State](types#state). | Property | Type | Description | | :------- | :------------------ | :---------- | | type | "widgetPanelOpened" | | ## WidgetsPanelWidthChangedAction [Redux action](https://redux.js.org/tutorials/fundamentals/part-2-concepts-data-flow#actions) dispatched when the widgets panel is resized. See `widgetsPanelWidth` in [State](types#state). | Property | Type | Description | | :---------------- | :------------------------- | :---------- | | type | "widgetsPanelWidthChanged" | | | widgetsPanelWidth | number | | ## WidgetWithQueryProps Props received by a widget with a query. [WidgetPluginProps](types#widgetpluginprops)\ & \{
   queryResult: [QueryResult](types#queryresult)\;
   onQueryRangesChanged: (newRanges: Partial\<\{
     \[axisId in [AxisId](types#axisid)]: [QueryRange](types#queryrange);
  }>) => void;
} ## WidgetWithQueryState The state of widgets using a query. | Property | Type | Description | | :---------------------- | :----------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | areFiltersDrivenByMdx | boolean | Whether the filters applied to the query when it is sent to the server are driven by: 1. widgetState.query.mdx (when true). It allows users to write filters as they like in the query tab. 2. dashboardState.filters, pageState.filters and widgetState.filters (when false). It allows a single source of truth for dashboard and page filters, preventing bugs.Defaults to false.In practice it is set to true when the user submits an MDX query in the query tab. It it set to false when filters are changed using other UI elements, such as the content or filters tab. | | query | Partial\<[Query](types#query)\> | | | serverKey | string | | | shouldUseDefaultColumns | MdxType extends [MdxDrillthrough](types#mdxdrillthrough) ? boolean : never | Whether the columns specified in the drillthrough.defaultSelectedColumns setting are used in the drillthrough query. It is useful when performing a drillthrough from another widget, as it allows to create the drillthrough widget right away, while triggering the query only once the default columns have been fetched. | ## WidgetWithQueryUpdateModeState The state of a widget with a query update mode. The difference with [WidgetWithQueryState](types#widgetwithquerystate) is that only the query update mode is configurable. The mdx and query context are managed internally by the widget. | Property | Type | Description | | :------- | :-------------------------------------------------------------- | :---------- | | query | \{
   updateMode?: [UpdateMode](types#updatemode);
} | |