ActiveUI

ActiveUI

  • User Guide
  • Developer Documentation

Home > @activeviam/activeui-sdk

activeui-sdk package

ActiveUI SDK is a React-based library providing customizable, rich and highly-interactive visualizations.

Enumerations

EnumerationDescription
ActionSituation
Argument
CellProperty
CloudApplicationStatus
DisplayMode
LoadingState
Quoting
Syntax
TabularDisplayModePossible display modes for a Pivot Table.

Functions

FunctionDescription
ActionsAware(props)A Function As Child Component that provides an array of actions properties to its children.
ActiveUIConsumer(props)A component to consume an instance of ActiveUI from React context.
ActiveUIProvider(props)A component to provide an instance of ActiveUI to child components.
Container(props)Container is a React component used to render widgets provided by ActiveUI SDK.
createActiveUI(options)Creates an instance of ActiveUI based on the given options.
isEditModeAllowedForBookmark(activeUI, bookmarkId, bookmarkContentServerUrl)Evaluates if the edit mode is allowed for a particular bookmark. Edit mode will always be allowed for bookmarks that do not exist on the content server.
SelectedPageAware(props)A Function As Child Component that provides the API and index of the active page of the currently selected dashboard.
SelectedRootDockAware(props)A Function As Child Component that provides the API of the root dock holding the widget that is currently selected to child components. See SelectedWidgetAware() for more details.
SelectedWidgetAware(props)A Function As Child Component that provides the API of the currently selected widget to child components, or undefined if no widget is selected.
useActions(props)A React hook that provides an array of actions properties.
useActiveUI()A React hook that provides an instance of ActiveUI from React context.
useDisplayMode()A React hook that provides the current display mode as well as a function to change it.
useSelectedPage()A React hook that provides the API and index of the active page of the currently selected dashboard.
useSelectedRootDock()A React hook that provides the API of the root dock holding the widget that is currently selected to child components.See useSelectedWidget() for more details.
useSelectedWidget()A React hook that provides the API of the currently selected widget to child components, or undefined if no widget is selected.

Interfaces

InterfaceDescription
AboutActionParametersDisplays the about popup. There is no requirement concerning its availability (it can be used anywhere).
AboutApiVersion of the package and the Content Server
ActionIconProps
ActionImplementationPropertiesBuild an action offered to users in several places of the UI.
ActionImplementationStaticProperties
ActionPropertiesProperties of a deserialized action plugin, curried with a payload argument holding the API of the target widget.
ActionResult
ActionsAwareProps
ActiveFilter
ActiveMonitorAgentAgent registered to an ActiveMonitor Server
ActiveMonitorAgentConnectionDetailsDetails about connection to an agent
ActiveMonitorAgentMapMap Site to agent
ActiveMonitorAlertAlert received from an ActiveMonitor websocket.
ActiveMonitorEventEvent received from ActiveMonitor Server.
ActiveMonitorMessageA message received from ActiveMonitor websocket.
ActiveMonitorMessageContentContent of an ActiveMonitorMessage.
ActiveMonitorMessagesActionParametersDisplay the ActiveMonitor Messages. It is displaying the number of unread messages in a badge.
ActiveMonitorServerHandle all the communications between ActiveMonitor Server.
ActiveMonitorState
ActivePivotConfiguration
ActivePivotServerHandle all the communications with an ActivePivot Server.
ActivePivotServerParameters
ActiveUIThe ActiveUI API.
ActiveUIConsumerProps
ActiveUIOptionsOptions for creating an instance of ActiveUI.
ActiveUIPermissions
ActiveUIPlugin
ActiveUIPluginWithTypeA ActiveUIPlugin with an additional type property.
ActiveUIProviderProps
ActiveviamOrdinalColorScaleParametersColor scale of size 10 created by ActiveViam with the following colors: turquoise blue, wisteria, cream can, celery, cinnabar, el salva, neon carrot, cabaret, governor bay, nepal
AddServerActionParametersOpens the Add Server popup
AddToFavoritesActionParametersAdds a bookmark to the user's favorites.
AddWidgetActionParametersAn action available with dashboards only, to display a popup to add widgets in a dashboard.
AgentsApi
AlertAttributesImplementationStaticProperties
AlertsActionParametersDisplay the ActiveMonitor Alerts. It is displaying the number of alerts in a badge.
AllAlertOptions
AllMdxFilterSelectorParametersMatches any filter
AlphabeticalHeaderComparatorParametersSorts headers alphabetically.
ApplicationStateData structure used to configure the application at startup
ApproximateFormatterParametersFormats axis tick labels into k/M/B notation. e.g. 1000 -> 1k
AppStateReporterParametersExports the whole state of the application
AuditTimeInfo
AuthenticationHolderImplementationPropertiesExposes the authentication API that every part of ActiveUI requiring authentication can consume.
AuthenticationHolderImplementationStaticProperties
AutomaticRestoreOptionsIf you turn on this feature, we advise you also provide the home action.
AxisNodeAn MdxNode representing an axis such as ROWS or COLUMNS and its associated expression.
BasicAuthenticationHolderParametersResend Basic authentication for each REST call and uses cookies for WebSockets.
BlackWhiteOrdinalColorScaleParametersColor scale of size 2: black and white
BoldTotalRowStyleParametersUses bold font if the row corresponds to a parent aggregate.
Bookmark
BookmarkContent
BookmarkMetaData
BookmarksApi
BookmarkStateEditorActionParametersOpen a popup to edit the bookmark corresponding to the target node.
CalculatedMeasureImplementationProperties
CalculatedMeasureImplementationStaticProperties
CanOverlayDisplayPayload
CaptionCellRendererParametersRender the caption contained in the cell.
CaseExpressionNodeAn MdxNode representing a CASE statement.
Catalog
CellCoordinatesA cell in a table is characterized by a row index and a column index. In this object, cell coordinates are grouped by row indexes.
CellEditorImplementationPropertiesA cell editor that can be added in a table.
CellEditorImplementationStaticProperties
CellFactoryImplementationPropertiesPerforms a manipulation on the columns of a table, for example to render several columns as one.
CellFactoryImplementationStaticProperties
CellPosition
CellRendererImplementationPropertiesChange the rendering of cells in a table.
CellRendererImplementationStaticProperties
CellSet
CellSetAxis
CellSetCell
CellSetMember
ChangePivotTableDisplayActionParametersThis action is meant to be used on tabular headers. It adds the tree cell column configuration to the list of column groups of the tabular if it was not there, or removes it if it was already there.
ChartApi
ChartConfiguration
ChartElementStylerImplementationPropertiesMerges the ouput style on top of the current style.
ChartElementStylerImplementationStaticProperties
ChartHandlerActionPayload
ChartLayerApi
ChartMappingThe attributes to fields mapping, contextual to the type of chart.
ChartOverlayImplementationPropertiesDisplay an overlay over a chart.
ChartOverlayImplementationStaticProperties
ChartPngExportActionParametersAn action to export the chart as a png.
ChartRemoveSortActionParametersAn action to remove sort on charts.
ChartSelectionHandlerImplementationPropertiesLets projects interact with the core chart selection.
ChartSelectionHandlerImplementationStaticProperties
ChartShowDataActionParametersAn action to display the data of the chart as a table.
ChartSortActionParametersAn action to sort charts.
ChartTimeFormatterImplementationPropertiesFormat date/time members on chart axis
ChartTimeFormatterImplementationStaticProperties
ChartTooltipShowActionParametersDisplay a tooltip for the chart widget.
ChooseableFormatterImplementationStaticProperties
ClearDockActionParametersUnload the current bookmark from the dock (or in other terms, clear the dock).
ColorAlternateRowStyleParametersUses the tabularAlternatingRowColor as a background on even-indexed rows.
ColumnMergeHeaderCaptionProducerParametersA caption producer that merges headers together, separated with a '/', like 'Desk / Currency'
ColumnsSelectorImplementationPropertiesA column selector, used for grouping table columns.
ColumnsSelectorImplementationStaticProperties
ConditionalFormattingActionParametersOpen a popup to format the current measure.
ConsoleReporterParametersExports all info, warning and error logs logged through the ActiveUI logging framework.
ConstantChartOverlayParametersAn overlay that displays a line of constant value. Only available on charts with an x and y axis, and with y being a numerical axis.
ContainerApi
ContainerPropsFor more information about the controlled/uncontrolled distinction see https://reactjs.org/docs/uncontrolled-components.html.
ContainerStyle
ContainerValue
ContentEditorApi
ContentServerExpose the API to interact with a Content Server.
ContextMenuImplementationProperties
ContextMenuImplementationStaticProperties
CopyCellsActionParametersCopy the table's selected cells to the clipboard.
CopyTableActionParametersCopy to clipboard the underlying table. Only available if the underlying table is fully downloaded (i.e. not lazy loaded)
CreateFolderActionParametersOpen a popup to create a folder under the selected node.
CreateKpiActionParametersAn action to open the kpi editor, with some contextual information if available.
CreateStatementNodeAn MdxNode representing a CREATE statement.
CSFile
CSFileEntry
Cube
CubeContextValue
CubeContextValueDefinition
CubeDimension
CubeHierarchy
CubeKpi
CubeLevel
CubeMeasure
CubeMeasureGroup
CubeMember
CubeSet
CurrencyFormatterParametersFormats axis tick labels into currency. e.g. 1000 -> $1,000.00
D310OrdinalColorScaleParametersColor scale of size 10 provided by D3. See https://github.com/d3/d3-scale/blob/master/README.md#schemeCategory10
D320BOrdinalColorScaleParametersColor scale of size 20 provided by D3. See https://github.com/d3/d3-scale/blob/master/README.md#schemeCategory20b
D320COrdinalColorScaleParametersColor scale of size 20 provided by D3. See https://github.com/d3/d3-scale/blob/master/README.md#schemeCategory20c
D320OrdinalColorScaleParametersColor scale of size 20 provided by D3. See https://github.com/d3/d3-scale/blob/master/README.md#schemeCategory20
DarkActiveViamThemeParametersA built-in dark theme.
DashboardApi
DashboardPageApi
DashboardPageChildApi
DataApiAPI entry point for all data-related features.
DataIdsByColumnIndexMapping of the form {displayed column index} => {corresponding data columns indexes}
DataOverrides
DataSourceApi
DataSourceImplementationProperties
DataSourceImplementationStaticProperties
DateRecognizer
DebugLoggerParametersA logger that logs everything, and adds timestamp and the caller to each message.
DefaultCellSetMember
DefaultChartSelectionHandlerParametersDefault chart selection mechanism
DefaultChartTimeFormatterParametersAutomatically format a date based on how much details the date contains.
DefaultTableSelectionHandlerParametersDefault Tabular selection mechanism
DeleteBookmarkActionParametersDeletes a bookmark or a folder recursively. If the bookmark has been registered as user's favorite and the user has the right to edit that, it will also delete the favorite.
DeleteCalculatedMeasureActionParametersAn action to delete the a persisted measure, disabled if the user does not have the permissions to delete it.
DeleteKpiActionParametersAn action to delete the kpi, disabled if the user does not have the permissions to delete it.
DeletePointValuesActionParametersOpen a popup to notify a user before deleting the selected rows.
DeleteServerActionParametersOpens a popup to confirm the deletion of a server from the serversPool.
DimensionCompoundIdentifierNodeA CompoundIdentifierNode that represents a dimension.
DiscoveryInformation discovered from an ActivePivot server about what data is available.
DiscoveryKpiKPI object provided by a discovery REST call This describes a KPI from an MDX point of view.
DisplayModeProps
DockActionPayload
DragAndDropApi
DrillthroughApi
DrillthroughDataSetData structure sent by ActivePivot containing the drillthrough result.
DrillthroughDataSetHeader
DrillthroughDataSetResult
DrillthroughQuery
DrillthroughStatementNodeAn MdxNode representing a DRILLTHROUGH statement.
DropStatementNodeA type of MdxNode.
EditBookmarkActionParametersOpens a popup to edit a bookmark or a folder.
EditCalculatedMeasureActionParametersOpen a popup to edit a calculated measure and modify the MDX of the widget.
EditKpiActionParametersAn action to open the kpi editor, with some contextual information if available.
EmptyApi
EmptyTableSelectionHandlerParametersHandler that always returns an empty selection
EnhancedDrillthroughApi
EnhancedFeaturedValuesApi
EnhancedPivotTableApi
EnhancedTabularApi
EnrichedCubeMeasure
EnvironmentReporterParametersExports information about the application's environment: server, browser, build...
ErrorReporterParametersExports information related to the provided exception
ErrorsLoggerParametersA logger that only logs errors.
ExceptFiltersKeyMdxFilterSelectorParametersFilters out the specified filters on top of using a key
ExpiryCellFactoryParametersRenders a progress bar instead of the start and expiry columns of a KPI.
ExplicitHeaderComparatorParametersSorts headers in the same order as a given list.
ExplicitOrdinalColorScaleParametersCreate a custom color scale that explicitly list all colors. Fallback to text color if no parameters are provided.
FeaturedValuesApi
FeaturedValuesHandlerActionPayload
FeaturedValuesTooltipShowActionParametersDisplay a tooltip for the featured values widget.
FeedInfo
FieldChooserImplementationStaticProperties
FiltersMembersContributionAn array corresponding to the intersection of the members included by each explicit filter for a given hierarchy.
FirstColumnHeaderCaptionProducerParametersThis caption producer keeps the caption as it is in the first column of the group.
Formatter
FormatterImplementationPropertiesFormats a caption into a specific format incorporating the user's locale.
FormulaNodeAn MdxNode representing an formula definition in the WITH clause of a SelectStatementNode. An example formula: WITH Member [Measures].[MyConstant] AS 42.
FromClauseNodeAn MdxNode representing a named cube for the FROM clause of a SelectNode. Does not represent a subselect expression in a FROM clause – that is represented by a SubSelectNode instead.
FullSizeActionParametersDisplay widgets in full screen.
GetReactCaptionProperty
GoogleChartOrdinalColorScaleParametersColor scale of size 5 following Google Chart/ActivePivot Live 3 color scheme. It contains the following colors: mariner, tia maria, orange peel, la palma, flirt. See https://developers.google.com/chart/
HeaderCaptionProducerImplementationStaticProperties
HeaderComparatorImplementationPropertiesCustomizes the order in which tabular view and pivot table columns are displayed.
HeaderComparatorImplementationStaticProperties
HideTooltipActionParametersAn action to hide any tooltip that is displayed in ActiveUI.
HierarchyCompoundIdentifierNodeA CompoundIdentifierNode that represents a hierarchy.
HierarchyCoordinates
HierarchyGreaterIndexMdxFilterSelectorParametersMatches filters with the provided hierarchy and an index greater than the one provided
HierarchyKeyIndexMdxFilterSelectorParametersMatches filters with the provided key, index and hierarchy
HierarchyKeyMdxFilterSelectorParametersMatches filters with the provided key and hierarchy
HierarchyKeyValueMdxFilterSelectorParametersMatches filters with the provided key, filter value and hierarchy
HierarchyMdxFilterSelectorParametersMatches filters with the provided hierarchy
HomeActionParametersReset a root widget to its default view
HtmlRendererImplementationPropertiesResponsible for converting plain text to HTML.
HtmlRendererImplementationStaticProperties
IconImplementationPropertiesRenders an icon. The expected output is any React element.
IconImplementationStaticProperties
IdentifierNodeAn MdxNode representing an identifier – the name of a hierarchy, level, measure, KPI, etc. For example, this could represent the MDX Geography or [Geography]. A CompoundIdentifierNode is made of these separated by dots.
InternationalizationAn object to expose the locale events and provide ActiveUI's translator implementation to an external application
JwtAuthenticationHolderParametersUses JWT for REST and cookies for WebSockets.
JwtResult
KeycloakAuthenticationHolderOptions
KeycloakAuthenticationHolderParametersUses Keycloak for REST and cookies for WebSocket.
KeyMdxFilterSelectorParametersMatches non server filters with the provided key
KeyValueTooltipEntry
KeyValueTooltipParameters
KpiDefinition
KpiExpiryColumnsSelectorParametersGroups together the start and expiry columns of a kpi
KpiExpiryHeaderCaptionProducerParametersThis caption producer is useful when the expiry column groups several expiries together.
KpiGoalColumnsSelectorParametersSelects the columns that are the goal of a kpi.
KpiMonitorConfigurationThe monitor configuration that will be stringified.
KpiStatusCellFactoryParametersRenders the customized cell of the status of a KPI status.
KpiStatusCellRendererParametersRender different icons for cell values value < -0.5, -0.5< value <0.5 and value > 0.5
KpiStatusColumnsSelectorParametersGroups together the status columns of a kpi.
LevelCompoundIdentifierNodeA CompoundIdentifierNode that represents a level.
LightActiveViamThemeParametersA built-in light theme.
LinearChartOverlayParametersAn overlay displaying a line following the equation y = mx + b. Only available on charts with an x and y axis, and with y being a numerical axis.
LinearNumericScaleProfileParametersA linear profile, that returns the percentage of the value between the domain min and max.
LinearPiecewiseNumericScaleProfileParametersA profile linear in 2 pieces, centered around middle.
LiteralNodeAn MdxNode representing a literal value such as a number or string.
LoadBookmarkActionParametersIf bookmark is a dashboard, loads it in a root container, opening a popup if several are available. If it is a widget bookmark, adds widget to active dashboard.
LocaleConfig
LocaleDescriptionA object describing a locale
LocationInfo
LocationMeasure
LoggerImplementationPropertiesA plugin to handle logging side-effect. It is called for every logging request in activeUI
LoggerImplementationStaticProperties
LogoutActionParametersLogs the current user out. There is no requirement concerning its availability (it can be used anywhere).
LookupCellFactoryParametersRenders an editable cell when the column displays a lookup.
LookupColumnsSelectorParametersSelects the columns that correspond to a formula lookup("...").
MakeHomePageActionParametersSets a bookmark to be the home page.
ManualColumnsSelectorParametersCreates one group of columns, according to the selection provided.
MapStorage
MarkdownHtmlRendererParametersUses the default preset of https://github.com/markdown-it/markdown-it to convert Markdown to HTML.
MdxApiManipulate Mdx (MDX), mostly via transforming it to a tree of MdxNodes.
MdxAxesApiContains all the operations related to the axes of a Select statement.
MdxBaseApiContains basic read/write operations on Mdx and MdxNodes.
MdxCellStylerParametersThe default plugin for converting MDX cell properties to CSS.
MdxCleaningApiProvides functions to clean a parsed tree and simplify it.
MdxContextValue
MdxCreateApiContains functions to create MDX nodes.
MdxDefinitionThe definition of a configuration.
MdxDefinitionsApiA collection of enums used throughout the mdx api.
MdxDrillthroughApiContains all the drillthrough statement related functions.
MdxFiltersApiContains functions to manipulate filters of an MDX query.
MdxFilterSelectorImplementationPropertiesMdxFilterSelector are used to retrieve one or more filters matching a specific set of conditions in order to manipulate it: read, write, remove...
MdxFilterSelectorImplementationStaticProperties
MdxFormulasApiContains all functions about calculated members.
MdxFunctionNodeAn MdxNode representing a function call. Some functions are called with syntax that makes them look like an operator or part of the language; see Syntax for the different syntaxes for calling functions.
MdxFunctionsApiAllows reading and manipulating the MDX functions used in a statement.
MdxHeaderCaptionProducerParametersA caption producer relying on an MDX dataSource, useful for producing synthetic headers when grouping columns.
MdxHierarchiesApiContains all the logic for hierarchies transformations.
MdxKpiApiContains all the operations related to KPIs and their functions.
MdxLevelsApiContains all the logic for levels transformations.
MdxMeasuresApiContains all the basic read/write operations about MDX measures.
MdxMembersApiContains functions for manipulating MDX members.
MdxNamedSetsApiContains functions for manipulating [named sets](https://docs.microsoft.com/en-us/sql/analysis-services/multidimensional-models/mdx/mdx-named-sets-building-named-sets).
MdxOrderApiContains the methods to read or change the ordering in a statement.
MdxParsingApiResponsible for the conversion between MDX strings (Mdx) and their equivalent trees of nodes (MdxNode).
MdxPrinterOptions
MdxQueryA MDX query on a given server.
MdxQueryDescription
MdxQueryPayload
MdxRangeFor a given axis, the actual slice of the server result that will be passed to the client on the network.
MdxStatementsApiContains functions used to manipulate the different types of MDX statements that can be encountered (Select, Drillthrough Select).
MdxTabularApiContains additional functions used for the tabular representation of a CellSet.
MdxTuplesApiContains all the operations related to MDX tuples.
MeasureInfoThe name property should represent the raw, unquoted name, not the unique, quoted name.
Member
MemberCaptionProvider
MemberColumnsSelectorParametersCreates a group of columns containing all the levels representing members (as opposed to measures).
MemberCompoundIdentifierNodeA CompoundIdentifierNode that represents a member.
MemberFilterActionParametersOpen a popup to filter on the current column
MemberPropertyDefinitionNodeAn MdxNode representing the definition of a property of a member that is defined in a FormulaNode. Some example property names are FORE_COLOR and FONT_FLAGS.
MonitorAttributesImplementationStaticProperties
MonitorConfiguration
MonitorLocation
MonitorReportReport from ActiveMonitor for a given monitor
MonitorStatistics
MonitorStatusCellFactoryParametersRenders the customized cell of the status of a monitor.
MonoAccentOrdinalColorScaleParametersColor scale of size 1 based on the current theme accent color
MonoTextOrdinalColorScaleParametersColor scale of size 1 based on the current theme text color
MoveBookmarkActionParametersOpens a popup to move a bookmark or a folder.
NamedSetCompoundIdentifierNodeA CompoundIdentifierNode that represents a named set.
NewDashboardActionParametersReset the root widget to a new dashboard.
NodeMatcherCreate this with NodeMatcherFactory to get a fluent API for matching nodes in a parsed statement.
NoopActionParametersAn action that does nothing, used as a fallback in case of deserialization error
NoopLoggerParametersA logger that does not log anything. This is to be used CAREFULLY, because it does not even log errors.
NotChooseableFormatterImplementationStaticProperties
NumericColumnsSelectorParametersCreates a group of columns containing all the levels presenting measures (as opposed to members).
NumericScaleProfileImplementationPropertiesA plugin used when computing numerical scales, in order to customize the mapping of a value on a scale.
NumericScaleProfileImplementationStaticProperties
OpenAlertActionParametersOpens a popup with the details of an alert.
OpenDrillthroughActionParametersOpens a popup to choose where to display a drillthrough widget containing the result of the drillthrough on the given cell.
OpenMessageActionParametersOpens a popup with the details of a message.
OpenMonitorActionParametersOpens a popup with the details of an alert.
OpenWidgetToModifyActionParametersLoads a saved widget bookmark in a root container, opening a popup if several are available.
OptimizedOrdinalColorScaleParametersColor scale of size 9 inspired from http://www.mulinblog.com/a-color-palette-optimized-for-data-visualization/
OptionsForTranslation
OptionsForTranslationSupportingReact
OrdinalColorScaleImplementationPropertiesProvide a set of colors given a set of values. Can be used to associate a particular color to a particular value
OrdinalColorScaleImplementationStaticProperties
OriginalHeaderComparatorParametersKeeps the headers in the same order than in the data table.
OverlayCustomizableParameter
PageDescription
PageLayoutLeaf
PageLayoutNode
Parameter
ParameterChanges
ParameterFromTo
ParameterListApi
ParameterQuery
ParameterQueryResult
ParameterReference
PercentageFormatterParametersFormats axis tick labels into a percentage format. e.g. .1 -> 10%
PivotTableApi
PivotTableToggleGrandTotalActionParametersShow / Hide the grand total on rows
PivotTableToggleSubTotalsActionParametersShow / Hide the sub total on rows
PlotlyOverrides
PluginFactory
PluginParameterSerialization
PluginsRegistry
PointValue
PopupWidgetBuilderThe PopupBuilder
PositiveOrNegativeNumericScaleProfileParametersA binary profile, that returns either 1 or 0 for positive or negative values.
PresentationsApi
PublishCalculatedMeasureActionParametersOpen a popup to publish a calculated measure, moving its definition from the widget’s MDX to the content server.
QueriesApiAPI entry point for all queries to remote servers.
QueriesPool
QueryEditorActionParametersOpen a popup to edit the mdx and context values of the widget
QuickFilterApi
RangeConfigurationExample: for the rows axis, a thresholdPercentage of 0.1 for a chunkSize of 2000 means that the initial table will load the rows 0 to 2000, and when scrolling past row 1800, a new chunk of 2000 rows centered on 1800 will be downloaded from 800 to 2800, and so on. To disable lazy loading, set chunkSize to -1 and any thresholdPercentage.
RangesFor each axis, the actual range of results that is being queried from the server.
RangesConfigurationOn the client side, configure the lazy-loading of featured values, pivot tables and tabular views for each axis, i.e. the ability to defer the download of a subset of the results at the time the user is scrolling through them.
RawFormatterParametersFormats axis tick labels to show just the numerical value without any group separation or other decoration 1,000,000 -> 1000000
ReactContainerApi
ReactContainerBodyA serializable object.
ReactContainerChildApi
ReactContainerComponentProps
ReactContainerImplementationPropertiesNothing, everything declared in ReactContainerImplementationStaticProperties.
ReactContainerImplementationStaticProperties
ReactTranslationParametersParameters used when formatting the template.
RedoActionParametersFor a root widget, loads the next view
RefreshDiscoveryActionParametersExpands a node of a tree, if it is expandable.
RefreshQueryActionParametersRefresh the current query associated with the widget. Only available on widgets with data sources using mdx.
RefreshStatementNodeA type of MdxNode.
RegexpColumnsSelectorParametersCreates a group of columns based on a regexp ran on the column header value.
RegressionChartOverlayParametersAn overlay displaying a line following a regression of a given type, calculated from the values of the measure being used for the y axis.
RelativeTimeCellFactoryParametersRenders an cell displaying the time relatively.
RemoveDockActionParametersAn action to remove the widget from its parent dashboard. Only available when the widget is in a dashboard.
RemoveListenerA function to call to detach a listener.
RenameBookmarkActionParametersOpens a popup to rename a bookmark or a folder.
RenameServerActionParametersOpens a popup to rename a server from the serversPool.
RenderableTabularHeaderThis object is produced after processing the different plugins for generating the columns etc.
RenderOverlayPayload
ReportCarries information about the current version, state or health status of the aplication
ReporterImplementationPropertiesExports a report
ReporterImplementationStaticProperties
ReportingPayloadDescribes what report should be created and how it should be consumed. See https://support.activeviam.com/confluence/display/AP5/Reporting+and+scheduling.
ResetDashboardActionParametersAn action available with dashboards only, to reset a dashboard to its last persisted state. The ActionResult resolved by this action will contain the api of the reloaded bookmark.
ReverseHeaderComparatorParametersSorts the headers in the reverse order than in the data table.
RichTextEditorApi
RootDockApi
RootStructureCSFile
RowActionImplementationPropertiesRenders a row action, displayed by default at the end of each row in a table widget.
RowActionImplementationStaticProperties
RowOrColumnRange
RowStyleImplementationPropertiesCustomizes the style of all the cells in a row.
RowStyleImplementationStaticProperties
SanitizedHtmlRendererParametersUse https://github.com/punkave/sanitize-html to sanitize HTML.
SaveActionParametersSave the changes of the widget.
SaveAsActionParametersSave the current widget in a bookmark. It will display the bookmark popup.
SavedServerParameters
ScientificFormatterParametersFormats axis tick labels into scientific notation. e.g. 1000 -> 1e+3%
ScreenshotReporterParametersExports a screenshot of the application. Does not work under Internet Explorer
SelectedPageAwareProps
SelectedPageProps
SelectedRootDockAwareProps
SelectedRootDockProps
SelectedWidgetAwareProps
SelectedWidgetProps
SelectionHighlightChartElementStylerParametersA styler that highlights selected chart elements.
SelectStatementNodeAn MdxNode representing a SELECT statement.
SemanticVersionSemantic Version Object
SeparatorActionParametersThis is a fake action, it is used to separate items in context menus, but does not do anything on execute.
SerializableApi
Serialization
SerializationHelperAn object that provides predefined Serialization objects that handle different types of plugin parameters. These are useful when defining the PluginParametersSerializationFn of a plugin.
Server
ServerApiVersion
ServerApiVersions
ServerMdxFilterSelectorParametersSelects filters that come from the server.
ServersPool
ServerVersion
SettingsManagerSettings Manager
ShareActionParametersDisplays a popup that allows to edit the permissions of a saved bookmark, and to get a shareable URL for it.
ShowDefaultWidgetsActionParametersAn action to restore the default built-in widgets in the dashboard.
SimpleHeaderCaptionProducerParametersThis caption producer simply returns the caption defined in the caption parameter, or the translated version of a caption defined in the locales files via the captionData and captionPath parameters.
SimpleTableCell
SimpleTableHeader
SimpleTooltipEntry
SimpleTooltipParameters
SimplifiedChartTimeFormatterParametersAutomatically format a date based on how much details the date contains.
SingleDataSourceApi
SortableTabularHeader
SparklineDynamicColorCellFactoryParametersRenders the underlying columns as sparklines, using some of the columns for the color range of the sparklines.
SparklineNoColorCellFactoryParametersRenders the underlying columns as sparklines.
StandaloneActionPayload
StartCloudServerActionParametersAsks a cloud application to start a server.
StatementAndDiscoveryA parsed MDX statement and the discovery it is meant to be run with.
StaticDataQuery
StatReporterParametersExports performance statistics about the application
StopCloudServerActionParametersAsks a cloud application to stop a server.
StringFormulaSpecificationNodeA type of MdxNode.
StructureMetaData
SubMenuActionParametersThis is a fake action, used to offer sub-menus in context menus.
SubSelectNodeAn MdxNode representing a subselect expression.
TableData structure used as the data input for all ActiveUI widgets.
TableAxisRangeDataThe first and last indexes of the axis range, with the total size of the axis
TableCell
TableConversion
TableHeader
TablePagesCellEquivalent of TableCell on the PAGES axis.
TableRangeDataThe range data for the row, column, and page axes
TableSelectionHandlerImplementationPropertiesLets projects interact with the core tabular selection.
TableSelectionHandlerImplementationStaticProperties
TableSelectionRange
TableTransformerA table transformer taking as a first argument the table to transform and as a second argument a callback to call on the transformed table.
TabularApi
TabularClearSortActionParametersRemove the sorting based on the context that received the click.
TabularCollapseEntireFieldActionParametersAn action that allows collapsing down to a given level
TabularCollapseLevelActionParametersA tabular view action that allows to collapse the view on a given member.
TabularColumnDifferenceActionParametersA tabular view action that allows to create a calculated measure that computes the difference between two selected columns.
TabularColumnHeader
TabularColumnProps
TabularEditCellActionParametersSet the cell as edited in the tabular configuration.
TabularEditHeaderActionParametersSet the header as edited in the tabular configuration.
TabularExpandEntireFieldActionParametersAn action that allows expansion of all cells at a given level
TabularExpandLevelActionParametersA tabular view action that allows to expand the view on a given member (opens a popup to choose the level on which to expand).
TabularFreezeHeaderActionParametersFreezes the column so that it is always visible in the table.
TabularHandlerActionPayload
TabularHandlerCellContextActionPayload
TabularHandlerHeaderContextActionPayload
TabularHeaderStyleActionParametersOpens a popup to customize the look of a header.
TabularRememberExpansionOrderActionParametersAn action that allows to remember/forget the order in which levels were expanded in a table.
TabularRemoveHeaderActionParametersRemoves a set of columns from a table.
TabularSelectCellActionParametersSet the cell as selected in the tabular configuration.
TabularSelectColumnActionParametersSet the column as selected in the tabular configuration. Supports the multi-selection when the user uses the keys ctrl or shift while he clicks.
TabularShowSparklinesActionParametersThis action is meant to be used on tabular headers. It adds the tree cell column configuration to the list of column groups of the tabular if it was not there, or removes it if it was already there.
TabularSortActionParametersApply a sorting based on the context that received the click.
TabularSparklineAddColorsActionParametersThis action is meant to be used on tabular headers. It adds the tree cell column configuration to the list of column groups of the tabular if it was not there, or removes it if it was already there.
TabularTooltipShowActionParametersShow a tooltip for the tabular view/pivot table widget.
Theme3OrdinalColorScaleParametersColor scale of size 3 based on the current theme: text, accent and alternate colors
ThemeDescription
ThemeImplementationStaticProperties
Theming
ToggleDockTitleBarActionParametersToggle the title bar of the widget.
ToggleFiltersActionParametersToggle the filters area at the top of the widget. This is only available on widgets that use mdx.
ToggleTextEditingActionParametersToggle between editing and preview mode for the RichTextEditor container.
ToggleTreeNodeActionParametersToggles the expansion of the node of a tree, if it is expandable.
ToggleWizardActionParametersToggle the wizard. This is available on the pivot table widget, and the chart widget.
TooltipImplementationPropertiesDisplays a tooltip (in the UI).
TooltipImplementationStaticProperties
Trace
TranslatedText
TranslationContentDescribe all translations.
TranslationParametersParameters used when formatting the template, to be used in arguments of the message (https://formatjs.io/guides/message-syntax/)
Translator
TreeApi
TreeCellsCellFactoryParametersRenders the underlying columns as a tree.
TreeHandlerActionPayload
TreeNode
TreeTooltipShowActionParametersShow a tooltip for the tree widget, if the node contains information to display.
UndoActionParametersFor a root widget, loads the previous view
UnknownCompoundIdentifierNodeA CompoundIdentifierNode representing an unknown identifier.
UpdateQueryModeActionParametersChange the query update mode to the next mode.
UseActionsOptions
UserMdxFilterSelectorParametersMatches non server filters with the provided key
UserPaletteThe palette the user can configure from which other colors are derived.
UserThemeConfigThe configuration a user can provide when creating a new theme.
VerboseLoggerParametersA logger that logs everything.
WarningsLoggerParametersA logger that only logs warnings and errors.
WatchMeasureActionParametersAn action to start watching a measure in a table.
WhenClauseNodeAn MdxNode representing a WHEN clause of a CaseExpressionNode, including the clause’s THEN true result expression.
WidgetCsvExportActionParametersOpen a popup to export the data of the widget into a csv file. Only available if the underlying table is fully downloaded (i.e. not lazy loaded).
WidgetsApi
WidgetStateEditorActionParametersOpen a popup to edit the bookmark corresponding to the widget.
WorkflowEntity
WorkflowsApi
WorkflowScheme

Variables

VariableDescription
ActiveUIContextThe React context used by ActiveUI.
allActionsPresetPreset containing all the core action plugins.
allAlertAttributesPresetPreset containing all the core alert attributes plugins.
allAuthenticationHoldersPresetPreset containing all the core authentication holder plugins.
allCalculatedMeasuresPresetPreset containing all the core calculated measure plugins.
allCellEditorsPresetPreset containing all the core cell editor plugins.
allCellFactoriesPresetPreset containing all the core cell factory plugins.
allCellRenderersPresetPreset containing all the core cell renderer plugins.
allCellStylersPresetPreset containing all the core cell styler plugins.
allChartElementStylersPresetPreset containing all the core chart element styler plugins.
allChartSelectionHandlersPresetPreset containing all the core chart selection handler plugins.
allChartsPresetPreset containing all the core chart plugins.
allChartTimeFormattersPresetPreset containing all the core chart time formatter plugins.
allColumnsSelectorsPresetPreset containing all the core columns selector plugins.
allContainerDependenciesWrappersPresetPreset containing all the core container dependencies wrapper plugins.
allContainersPresetPreset containing all the core container plugins.
allContextMenusPresetPreset containing all the core context menu plugins.
allDataSourcesPresetPreset containing all the core dataSource plugins.
allFieldChoosersPresetPreset containing all the core field chooser plugins.
allFormattersPresetPreset containing all the core formatter plugins.
allHeaderCaptionProducersPresetPreset containing all the core header caption producer plugins.
allHeaderComparatorsPresetPreset containing all the core header comparator plugins.
allHtmlRenderersPresetPreset containing all the core HTML renderer plugins.
allIconsPresetPreset containing all the core icon plugins.
allLegacyChartOverlaysPresetPreset containing all the core legacy chart overlay plugins.
allMdxFilterSelectorsPresetPreset containing all the core filter selector plugins.
allMdxFiltersPresetPreset containing all the core mdx filter plugins.
allMonitorAttributesPresetPreset containing all the core monitor attributes plugins.
allMonitorConfigurationsPresetPreset containing all the core monitor configuration plugins.
allNumericScaleProfilesPresetPreset containing all the core numeric scale profile plugins.
allOrdinalColorScalesPresetPreset containing all the core ordinal color scale plugins.
allPluginsPreset
allPopupsPresetPreset containing all the core popup plugins.
allReportersPresetPreset containing all the core reporter plugins.
allRowActionsPresetPreset containing all the core row action plugins.
allRowStylesPresetPreset containing all the core row style plugins.
allTableSelectionHandlersPresetPreset containing all the core table selection handler plugins.
allThemesPresetPreset containing all the core theme plugins.
allTooltipsPresetPreset containing all the core tooltip plugins.
allWidgetApiGeneratorsPresetPreset containing all the core widget API generator plugins.
allWidgetApiProvidersPresetPreset containing all the core widget API provider plugins.
allWidgetApisPresetPreset containing all the core widget API plugins.
IconIcons for use with ActiveUI SDK.See the icons snippet for example usage.
pluginContainerActiveMonitorAlertList
pluginContainerActiveMonitorMessageList
pluginContainerActiveMonitorSingleAlert
pluginContainerBookmarkTree
pluginContainerChart
pluginContainerContentEditor
pluginContainerContextValues
pluginContainerDashboard
pluginContainerDiscoveryTree
pluginContainerDrillthrough
pluginContainerFeaturedValues
pluginContainerFilters
pluginContainerHttp
pluginContainerMdxEditor
pluginContainerMonitorList
pluginContainerMonitorView
pluginContainerParameterList
pluginContainerPivotTable
pluginContainerQuickFilter
pluginContainerRichTextEditor
pluginContainerRulesEditor
pluginContainerStateEditor
pluginContainerStaticTabularView
pluginContainerStyleEditor
pluginContainerTabularView
pluginContainerWidgetChooser
pluginFormatterBillions
pluginFormatterMillions
pluginFormatterThousands
pluginHeaderComparatorExplicit
pluginHeaderComparatorOriginal
pluginHeaderComparatorReverse
pluginIconActiveMonitorIconAlertInbox
pluginIconActiveMonitorIconAlerts
pluginIconActiveMonitorIconAllParameters
pluginIconActiveMonitorIconFilter
pluginIconActiveMonitorIconMessageInbox
pluginIconActiveMonitorIconMessages
pluginIconActiveMonitorIconMonitorDashboard
pluginIconActiveMonitorIconMonitorView
pluginIconActiveMonitorIconParameter
pluginIconActiveMonitorIconParameterList
pluginIconActiveMonitorIconSelectAll
pluginIconActiveMonitorIconWorkflow
pluginIconBookmarkOwners
pluginIconBookmarkReaders
pluginIconBusinessIconAlertInbox
pluginIconBusinessIconAlerts
pluginIconBusinessIconBrackets
pluginIconBusinessIconCatalog
pluginIconBusinessIconChartArea
pluginIconBusinessIconChartBar
pluginIconBusinessIconChartBookmark
pluginIconBusinessIconChartBullet
pluginIconBusinessIconChartClusteredBar
pluginIconBusinessIconChartClusteredColumn
pluginIconBusinessIconChartClusteredColumnsAndLines
pluginIconBusinessIconChartColumnsOnMap
pluginIconBusinessIconChartDonut
pluginIconBusinessIconChartGantt
pluginIconBusinessIconChartGauge
pluginIconBusinessIconChartLine
pluginIconBusinessIconChartPie
pluginIconBusinessIconChartPointsOnMap
pluginIconBusinessIconChartRadar
pluginIconBusinessIconChartScatter
pluginIconBusinessIconChartStackedArea
pluginIconBusinessIconChartStackedArea100
pluginIconBusinessIconChartStackedBar
pluginIconBusinessIconChartStackedBar100
pluginIconBusinessIconChartStackedColumn
pluginIconBusinessIconChartStackedColumn100
pluginIconBusinessIconChartTree
pluginIconBusinessIconChartVectorsOnMap
pluginIconBusinessIconChartWaterfall
pluginIconBusinessIconContextValues
pluginIconBusinessIconDrillthroughBookmark
pluginIconBusinessIconEdit
pluginIconBusinessIconFilters
pluginIconBusinessIconHttpBookmark
pluginIconBusinessIconKpi
pluginIconBusinessIconMdxEditor
pluginIconBusinessIconMessageInbox
pluginIconBusinessIconMonitorList
pluginIconBusinessIconMonitorView
pluginIconBusinessIconNumeric
pluginIconBusinessIconOtherBookmark
pluginIconBusinessIconParameterList
pluginIconBusinessIconPivotTableBookmark
pluginIconBusinessIconPuzzle
pluginIconBusinessIconQuickFilter
pluginIconBusinessIconRichTextEditor
pluginIconBusinessIconStateEditor
pluginIconBusinessIconTabularBookmark
pluginIconButtonDetails
pluginIconButtonSaveAsBookmark
pluginIconButtonSaveBookmark
pluginIconButtonView
pluginIconCloudOffline
pluginIconCloudOnline
pluginIconCloudStarting
pluginIconCommonAdd
pluginIconCommonBGColors
pluginIconCommonBlank
pluginIconCommonClear
pluginIconCommonCopy
pluginIconCommonCutter
pluginIconCommonDelete
pluginIconCommonDownArrow
pluginIconCommonEdit
pluginIconCommonFile
pluginIconCommonLink
pluginIconCommonList
pluginIconCommonMdx
pluginIconCommonPause
pluginIconCommonPlay
pluginIconCommonRefresh
pluginIconCommonRefreshEvery
pluginIconCommonRemove
pluginIconCommonSave
pluginIconCommonSearch
pluginIconCommonShare
pluginIconCommonStop
pluginIconCommonSwitch
pluginIconCommonTag
pluginIconCommonText
pluginIconCommonTrash
pluginIconCommonWizard
pluginIconCommonWorld
pluginIconDocksAbout
pluginIconDocksAddWidget
pluginIconDocksHideBar
pluginIconDocksHome
pluginIconDocksLogout
pluginIconDocksMaximize
pluginIconDocksMinimize
pluginIconDocksQueryRate
pluginIconDocksRedo
pluginIconDocksReset
pluginIconDocksShowBar
pluginIconDocksUndo
pluginIconKpiBreach
pluginIconKpiCustomGoal
pluginIconKpiGood
pluginIconKpiLowerGoal
pluginIconKpiTunnelIn
pluginIconKpiTunnelOut
pluginIconKpiUpperGoal
pluginIconKpiWarning
pluginIconMenuItemIconAddKpi
pluginIconMenuItemIconCalculate
pluginIconMenuItemIconChart
pluginIconMenuItemIconCollapse
pluginIconMenuItemIconColors
pluginIconMenuItemIconConditionalFormatting
pluginIconMenuItemIconContextValues
pluginIconMenuItemIconCopyToClipboard
pluginIconMenuItemIconCreateFolder
pluginIconMenuItemIconCsvExport
pluginIconMenuItemIconCsvSeparator
pluginIconMenuItemIconDelete
pluginIconMenuItemIconDockInLegend
pluginIconMenuItemIconDockOutLegend
pluginIconMenuItemIconDrillthrough
pluginIconMenuItemIconEdit
pluginIconMenuItemIconExpand
pluginIconMenuItemIconFavorite
pluginIconMenuItemIconHeaderStyle
pluginIconMenuItemIconHideLegend
pluginIconMenuItemIconHideSubTotals
pluginIconMenuItemIconHideTotal
pluginIconMenuItemIconHome
pluginIconMenuItemIconMore
pluginIconMenuItemIconMove
pluginIconMenuItemIconNewDashboard
pluginIconMenuItemIconNumericAscendingOrder
pluginIconMenuItemIconNumericDescendingOrder
pluginIconMenuItemIconNumericRemoveOrder
pluginIconMenuItemIconOrdinalAscendingOrder
pluginIconMenuItemIconOrdinalDescendingOrder
pluginIconMenuItemIconOrdinalRemoveOrder
pluginIconMenuItemIconPdfExport
pluginIconMenuItemIconPin
pluginIconMenuItemIconPngExport
pluginIconMenuItemIconRefresh
pluginIconMenuItemIconRemoveColumn
pluginIconMenuItemIconRichTextEditor
pluginIconMenuItemIconShowData
pluginIconMenuItemIconShowSubTotals
pluginIconMenuItemIconShowTotal
pluginIconMenuItemIconTabular
pluginIconMenuItemIconTreeColumn
pluginIconMenuItemIconUnpin
pluginIconOtherDead
pluginIconOtherFx
pluginIconOtherNoData
pluginIconOtherValid
pluginIconOtherWarning
pluginIconPaletteColor
pluginIconPaletteFillColor
pluginIconPaletteTextColor
pluginIconPaletteTransparent
pluginIconPaletteUndefined
pluginIconPivotTableHideWizard
pluginIconPivotTableShowWizard
pluginIconPresentationsConnect
pluginIconPresentationsDisconnect
pluginIconPresentationsHideFilters
pluginIconPresentationsShowFilters
pluginIconTreeIconCatalog
pluginIconTreeIconChartBookmark
pluginIconTreeIconCube
pluginIconTreeIconDashboard
pluginIconTreeIconDimension
pluginIconTreeIconDrillthroughBookmark
pluginIconTreeIconError
pluginIconTreeIconExpandPlus
pluginIconTreeIconFilters
pluginIconTreeIconFolder
pluginIconTreeIconHierarchy
pluginIconTreeIconHttpBookmark
pluginIconTreeIconKpi
pluginIconTreeIconLocation
pluginIconTreeIconLocationDimension
pluginIconTreeIconLocationHierarchy
pluginIconTreeIconMdxEditor
pluginIconTreeIconMeasures
pluginIconTreeIconMinus
pluginIconTreeIconMonitor
pluginIconTreeIconNumeric
pluginIconTreeIconOtherBookmark
pluginIconTreeIconPivotTableBookmark
pluginIconTreeIconPlus
pluginIconTreeIconPuzzle
pluginIconTreeIconQuickFilter
pluginIconTreeIconReadOnly
pluginIconTreeIconRegular
pluginIconTreeIconServer
pluginIconTreeIconSlicingDimension
pluginIconTreeIconSlicingHierarchy
pluginIconTreeIconSlicingLocationDimension
pluginIconTreeIconSlicingLocationHierarchy
pluginIconTreeIconSlicingTimeDimension
pluginIconTreeIconSlicingTimeHierarchy
pluginIconTreeIconStateEditor
pluginIconTreeIconTabularBookmark
pluginIconTreeIconTime
pluginIconTreeIconTimeDimension
pluginIconTreeIconTimeHierarchy

Type Aliases

Type AliasDescription
ActionPayload
ActionPluginPlugin defining actions that can be used as DOM event handlers or context menu items
ActiveMonitorAlertId
ActiveMonitorMessageAnswerContent
ActiveMonitorMessageId
ActiveMonitorPeriodString can be a timestamp or "now"
ActiveMonitorResourceRepresentation of a resource as seen by ActiveMonitor. For event coming from ActivePivot, keys are level unique names and values member unique names.
ActiveMonitorServerParameters
AddListener
AlertAttributesPluginPlugin defining the attributes of an ActiveMonitor alert
ApiProvider
AugmentedActiveFilterRepresent a filter that impacts a MDX statement.
AuthenticationHolder
AuthenticationHolderPluginPlugin defining how to authenticate
AutomaticRestoreStorage
AutomaticRestoreStorageType
BookmarkCategoryThe type of bookmark.
BookmarkDescription
BookmarkI18n
BookmarkId
BookmarkName
BookmarkPathThe file path to the bookmark on the content server.
BookmarkValue
BuiltInContainerCategoryThe categories used by built-in containers.
CacheStatus
CalculatedMeasurePluginPlugin defining an MDX formula, how to recognize it and how to edit it
CatalogName
CellEditorPluginPlugin defining a component that can be used as an editor in a table cell
CellFactoryPluginPlugin defining a cell factory
CellRendererPluginPlugin defining a component that can be used as a table cell
CellSetProperties
CellStylerPluginPlugin defining a style that can be applied to a table cell
ChartElementStylerPluginPlugin defining the style that can be applied to chart elements
ChartOverlayPluginPlugin defining an overlay on a chart
ChartPlugin
ChartSelection
ChartSelectionPluginPlugin allowing to listen to the selected elements of a chart
ChartTimeFormatterPluginPlugin defining a way to format time values on a chart
ClosePopup
ColorA CSS valid color: RGB(r,g,b), #hexa, colorName...
ColsAxisNode
ColumnsSelectorPluginPlugin defining a function matching table headers
CompoundIdentifierNodeThe subset of MdxNodes that identify something using hierarchical dot notation, as in the MDX [Measures].[MyMeasure]. Each segment is an IdentifierNode.
ContainerBodyThe body of the bookmark. This is specific to each type of container.
ContainerCategoryThe category in which the container should appear.
ContainerChildKey
ContainerDependenciesPluginPlugin defining pieces of information that should be present for a widget to render, and what to display if they are not.
ContainerFullValue
ContainerImplementationPropertiesProjects should only use ReactContainerImplementationProperties.
ContainerImplementationStaticPropertiesProjects should only use ReactContainerImplementationStaticProperties.
ContainerInstance
ContainerPluginPlugin defining a widget
ContentCSFile
ContentServerParameters
ContentServerPathA sequence of sections forming the full path to a directory or file.
ContentServerPathSectionA directory or file name.
ContextMenuPluginPlugin allowing to retrieve the items of a context menu
CubeName
D3ApiThe D3 api. See https://github.com/d3/d3/blob/master/API.md for more details.
DataSourceRepresent the source of data from the point of view of a presentation. Contains the description of the source so that the presentation can decide which UI is relevant for the data it contains.
DataSourcePluginPlugins defining how data can be retrieved (through an MDX query or statically for instance)
DataVisualizationWidgetApi
DefaultMembersPolicyThe policy that defines whether default members should be kept in the LocationMembers mapping that characterizes a LocationInfo.
Dimensionality
DimensionName
DiscoveryCache
DrillthroughDataSetCell
DrillthroughDataSetRow
EmptyTableCell
EnrichedCubeKpi
ExplicitThemeParametersTheme reading its properties from its parameters.
ExpressionNodeThe subset of MdxNodes that can be used in expression contexts such as the expression of a calculated measure.
FeedId
FetchTranslationTakes locale and default "fetch translation" method and returns a promise resolving to the translation data.
FieldChooserPluginPlugin defining a component allowing users to choose nodes in a tree
FilterPluginPlugin defining an MDX filter, how to recognize it and how to edit it
FilterScopeEnumEnum of the scope of widgets to apply filter on
FilterSourceThe source of the filter. One of Slicers: 0, SubSelects: 1 or Server: 2.
FormatterImplementationStaticPropertiesUse ChooseableFormatterImplementationStaticProperties or NotChooseableFormatterImplementationStaticProperties
FormatterPluginPlugin defining how values should be formatted
GetCaptionProperty
GetCaptionsProperty
HeaderCaptionProducerImplementationPropertiesProduces captions based on the provided headers.
HeaderCaptionProducerPluginPlugin defining the captions of the headers of a table
HeaderComparatorPluginPlugin defining how table headers should be ordered
HierarchyName
HierarchyUniqueName
HtmlRendererPluginPlugin transforming text into HTML
I18nCSFile
IconKeyAn icon key such as "common.world".
IconPluginPlugin defining an icon
KeyValueAsyncCache
KeyValueTooltipEntries
KPIFunctionNode
KpiName
LevelCoordinates
LevelName
ListenerCallback for listener on value<T>.
LocaleA string symbolizing a locale following the ISO/IEC 15897 specification, for example en-US.
LocationMembers
LocationsInfo
LoggerPluginPlugin defining the logger implementation
LoggingDataThe data passed to the logger.
LoggingFormatterA function to format the logging message. It is expecting the LoggingData collection spread.
LoggingTagsAn array of strings providing metadata on the logging message, such as if the category of the message (like the level).
LookupFunctionNode
MaxLevelPerHierarchy
MdxA string representing an [MDX](https://en.wikipedia.org/wiki/MultiDimensional_eXpressions) query or a subset of one.
MdxColorA string or number representing the color.
MdxContextValueKey
MdxContextValues
MdxFilterSelectorPluginPlugin defining a matching function for MDX filters
MdxNodeThe AST node representing an Mdx (MDX) string.
MdxTupleNodeAn MdxFunctionNode whose syntax property has a known value.
MdxUsingDataSource
MeasureGroupName
MeasureName
MeasureNode
MemberPathAsStringThe path of a member within its hierarchy.
MemberUniqueName
MonitorAttributesPluginPlugin defining the attributes of an ActiveMonitor monitor
MonitorConfigurationPluginPlugin defining the configuration of an ActiveMonitor monitor
MonitorPathEither a site or "site/id"
MonitorSite
NestedStringArraysAn array that contains strings or arrays of strings or arrays of arrays of strings, etc.
NodeMatcherFactoryProvides a fluent API to match nodes in a parsed statement.
NumericScaleProfilePluginPlugin defining how values should be scaled
OrderDirection
OrderedColumns
OrderFunctionNodeAn MdxFunctionNode that represents a call to the [Order function](https://docs.microsoft.com/en-us/sql/mdx/order-mdx).
OrderMode
OrderModeLiteralNodeA LiteralNode that represents one of the OrderMode strings.
OrdinalColorScalePluginPlugin definining the colors used on a chart
PageLayout
PageLayoutDirection
ParameterName
PermissionGroup
PermissionGroups
PluginKey
PluginParametersThe implementation has access to a merged object containing the type and implementations parameters.
PluginParametersSerialization
PluginParametersSerializationFnIndicates how to serialize and deserialize the parameters of a plugin implementation.
PluginType
PopupPluginPlugin defining a component that can be rendered in a popup
PortalServerParameters
Query
QueryId
ReactOnlyTranslationParameter
ReactOnlyTranslationResult
ReactTranslationParameter
ReactTranslationPayloadAn object containing the translation or the options in order to generate a translation. The options may include React elements.
ReactTranslationResultThe formatted string, or an array of strings and objects if some of the parameters provided are React elements.
ReporterPluginPlugin defining pieces of information that can be reported as part of an application status check
RichTextEditorContent
Role
RowActionPluginPlugin defining the component for a row action cell, usable by users to interact contextually to its row. The row actions column is traditionally displayed last in the table.
RowsAxisNode
RowStylePluginPlugin defining a style that can be applied to a table row
SelectNodeAn MdxNode representing a SELECT statement or a subselect.
SerializedPluginThe serialized representation of a plugin. When the key & args form is given, the args will be given as parameters to the plugin when deserializing it.
ServerApiKey
ServerKey
SetName
SettingKey
SettingsMap
SettingValue
SimpleTableTuple
SimpleTooltipEntries
SlicerAxisNode
SourceId
StringDeepJoinerA function that takes any number of pieces (strings or nested arrays of strings) as arguments and returns the glued string.
StructureCSFile
TableCellCaptionUsed to display the value of the cell in the UI.
TableCellColumnValue
TableCellValueContains the value of the cell for data manipulation.
TableColumnCountThe size of cellSet columns axis (i.e. number of positions)
TableContentArray of tuples with the same length corresponding to the number of columns in the table.
TableFromCellSetConvert a CellSet to a Table data representation.
TableFromDrillthroughDataSetConvert DrillthroughDataSet to a Table. When a column has both its value and caption asked, the two column are merged into a single one.
TableHeaderCaption
TableHeaders
TableHeaderValueUsed in all the widgets configurations to find the corresponding data column to display.
TableMembersHeaderCountThe size of cellSet rows tuple (i.e. containing only members)
TablePagesHeaders
TableSelection
TableSelectionPluginPlugin allowing to listen to, and control the selected cells in a table
TableTuple
TableVersionInteger that can be incremented to indicate that the data contained in the table has changed.
TabularActionPayloadContextTarget
TabularHeaderCaption
TabularHeaderKey
TabularRememberExpansionOrderMode
ThemeImplementationPropertiesAllows to define the main color of the theme, as well as if it is a dark theme.
ThemePluginPlugin defining a map of colors to be used in all the components of ActiveUI SDK
TooltipPluginPlugin defining a tooltip
TranslationParameter
TranslationPathA string symbolizing the path to the translation in the translation tree. For example 'general.cancel'. The different path segments are separated by dots.
TranslationPayloadAn object containing the translation or the options in order to generate a translation.
TranslationResultThe formatted string.
TranslationTreeContains all translations and configuration for a specific locale
UpdateMode
Url
Username
WidgetApi
WidgetApiGeneratorPluginPlugin defining a generator for Widget APIs
WidgetApiPluginPlugin allowing to create instances of Widget APIs
WidgetApiProviderPluginPlugin defining a provider, with an attached API generator and widget API instance
WidgetMetaApi
WorkflowEntityKey
WorkflowEntityType
WorkflowSchemeName
  • activeui-sdk package
  • Enumerations
  • Functions
  • Interfaces
  • Variables
  • Type Aliases
Copyright © 2023 ActiveViam