Overview of sdk-ui-dashboard

Home > @gooddata/sdk-ui-dashboard

sdk-ui-dashboard package

This package provides a Dashboard component that enables you to embed dashboards into your application as React components.

Remarks

The component also allows for customization of the embedded dashboard using plugins. See also @gooddata/sdk-ui-loaders.

Classes

Class	Description
DashboardStoreAccessor	This class serves the selector and the dispatcher properties of the dashboard component state.
DashboardStoreAccessorRepository	This singleton class serves the selector and the dispatcher properties for given dashboard.
ObjRefMap	(ALPHA) Utility class that assists with type-agnostic mapping of metadata objects by ObjRef. Problem ======= The challenges with ObjRef's start in context of backend that supports both uri and id ref (e.g. bear) and the client. Backend according to contract creates one type of ref - uri ref - so that is fine. However when instances of ref are created by the client code and are passed in through the public API (as is the case with the dashboard component) - problems start. For clients it is often more convenient to use ID refs.. because they are transferable across workspaces and because they appear in the catalog export. Doing strict ref-to-ref matching between user input and the data stored in state will result in no matches because the types of ref's do not match. --- This class addresses the problem by having the get method check the type of ObjRef first and then perform lookups into either id to item or uri to item mapping.
SingleDashboardStoreAccessor	This singleton class uses DashboardStoreAccessorRepository to create a store accessor for a single dashboard.

Abstract Classes

Abstract Class	Description
DashboardPluginV1	Abstract base class for the Dashboard Plugin.

Functions

Function	Description
addAttributeFilter(displayForm, index, correlationId, selectionMode, mode, initialSelection, initialIsNegativeSelection, localIdentifier, primaryDisplayForm, title)	(BETA) Creates the AddAttributeFilter command. Dispatching this command will result in the addition of another attribute filter to the dashboard's filter bar, at desired position, or error in case of invalid update (e.g. wrong or duplicated displayForm) The filter will be set for the display form provided by reference. When created, the filter will be no-op - all the elements will be selected.
addDateFilter(dateDataset, index, correlationId)	(ALPHA) Creates the AddDateFilter command. Dispatching this command will result in the addition of another date filter with defined dimension to the dashboard's filter bar, at desired position, or error in case of invalid update (e.g. wrong or duplicated date dimension/data set) The filter will be set for the date dimension provided by reference. When created, the filter will be no-op - all time filter.
addDrillDownForInsightWidget(ref, attributeIdentifier, drillDownIdentifier, drillDownAttributeHierarchyRef, intersectionIgnoredAttributes, correlationId)	(ALPHA) Creates the AddDrillDownForInsightWidget command. Dispatching the created command will create insight widget's drill definition for the provided measure.
addDrillTargets(ref, availableDrillTargets, correlationId)	(ALPHA) Create AddDrillTargets IAddDrillTargets command.
addLayoutSection(index, initialHeader, initialItems, autoResolveDateFilterDataset, correlationId)	(BETA) Creates the AddLayoutSection command.
addNestedLayoutSection(index, initialHeader, initialItems, autoResolveDateFilterDataset, correlationId)	(ALPHA) Creates the AddLayoutSection command.
addNestedLayoutSectionItem(itemPath, item, autoResolveDateFilterDataset, correlationId)	(ALPHA) Creates the AddSectionItems command.
addSectionItem(sectionIndex, itemIndex, item, autoResolveDateFilterDataset, correlationId)	(BETA) Creates the AddSectionItems command.
addVisualizationToSwitcherWidgetContent(ref, visualization, insight, sizeInfo, correlationId)	(BETA) Creates the AddVisualizationToSwitcherWidgetContent command. Dispatching this command will result in addition of visualization to switcher widget.
anyDashboardEventHandler(handler)	Creates a DashboardEventHandler instance that will be invoked for any dashboard event (i.e. not for custom events).
anyEventHandler(handler)	Creates a DashboardEventHandler instance that will be invoked for any event (event for custom events).
applyAttributeFilter(filterLocalId, filter, correlationId)	Creates the ChangeAttributeFilterSelection command.
applyDateFilter(filter, correlationId)	Creates the ChangeDateFilterSelection command.
applyFilterContextWorkingSelection(correlationId)	(ALPHA) Creates the IApplyFilterContextWorkingSelection command.
applyFilterView(ref, correlationId)	(ALPHA) Creates the IApplyFilterView command.
attributeHierarchyModified(correlationId)	(BETA) Creates the AttributeHierarchyModified command , dispatching this command will result on reset of catalog.
cancelEditRenderMode(correlationId)	(BETA) Creates the ChangeRenderMode command for cancel edit mode.
cancelRenamingDashboardTab(tabId, correlationId)	(ALPHA) Creates the CancelRenamingDashboardTab command.
changeAttributeFilterSelection(filterLocalId, elements, selectionType, correlationId, isSelectionInvalid)	Creates the ChangeAttributeFilterSelection command for applied filters.
changeDateFilterSelection(type, granularity, from, to, dateFilterOptionLocalId, correlationId, dataSet, isWorkingSelectionChange, localIdentifier, boundedFilter)	Creates the ChangeDateFilterSelection command.
changeDrillableItems(drillableItems, correlationId)	(ALPHA) Creates the IChangeDrillableItems command. Dispatching this command will result into enabling drilling of the widgets, if they match some of the drillable item definition/predicate.
changeFilterContextSelection(filters, resetOthers, correlationId)	Creates the ChangeFilterContextSelection command.
changeIgnoreExecutionTimestamp(ignoreExecutionTimestamp, correlationId)	(ALPHA) Creates the IChangeIgnoreExecutionTimestamp command.
changeInsightWidgetDescription(ref, description, correlationId)	(BETA) Creates the ChangeInsightWidgetDescription command. Dispatching this command will result in change of the Insight widget's description.
changeInsightWidgetHeader(ref, header, correlationId)	(BETA) Creates the ChangeInsightWidgetHeader command. Dispatching this command will result in change of the Insight widget's header which (now) includes title.
changeInsightWidgetIgnoreCrossFiltering(ref, ignoreCrossFiltering, correlationId)	(ALPHA) Creates the ChangeInsightWidgetCrossFiltering command. Dispatching this command will result in change of the Insight widget's cross-filtering setting.
changeInsightWidgetInsight(ref, insightRef, visualizationProperties, correlationId)	(BETA) Creates the ChangeInsightWidgetInsight command. Dispatching this command will result in change of what insight is rendered inside particular insight widget - while keeping all the other setup the same (filtering, drilling).
changeInsightWidgetVisConfiguration(ref, config, correlationId)	Creates the ChangeInsightWidgetVisConfiguration command. Dispatching this command will result is modification of the visualization configuration that are effective for the particular insight widget. Through visualization configuration, you can modify how particular visualization behaves If you want to clear any widget-level configuration, set config to undefined.
changeInsightWidgetVisProperties(ref, properties, correlationId)	(BETA) Creates the ChangeInsightWidgetVisProperties command. Dispatching this command will result is modification of the visualization properties that are effective for the particular insight widget. Through visualization properties, you can modify how particular visualization looks and behaves (enable/disable tooltips, legend, change axes, enable zooming). If you want to clear any widget-level properties, set properties to undefined.
changeKpiWidgetComparison(ref, comparison, correlationId)	(BETA) Creates the ChangeKpiWidgetComparison command. Dispatching this command will result in change of what comparison method - if any - is used for the KPI's Measure. The KPI may compare measure value from current period (as selected by the date filter) to previous period and then depending on whether the current value grows can visualize that as a good or bad thing.
changeKpiWidgetConfiguration(ref, config, correlationId)	(BETA) Creates the ChangeKpiWidgetConfiguration command. Dispatching this command will result is modification of the configuration that are effective for the particular kpi widget. Through configuration, you can modify how is particular kpi rendered If you want to clear any widget-level configuration, set config to undefined.
changeKpiWidgetDescription(ref, description, correlationId)	(BETA) Creates the ChangeKpiWidgetDescription command. Dispatching this command will result in change of the Kpi widget's description.
changeKpiWidgetHeader(ref, header, correlationId)	(BETA) Creates the ChangeKpiWidgetHeader command. Dispatching this command will result in change of the KPI widget's header which (now) includes title.
changeKpiWidgetMeasure(ref, measureRef, header, correlationId)	(BETA) Creates the ChangeKpiWidgetMeasure command. Dispatching this command will result in change of the measure used by the KPI.
changeLayoutSectionHeader(index, header, merge, correlationId)	Creates the ChangeLayoutSectionHeader command.
changeNestedLayoutSectionHeader(index, header, merge, correlationId)	(ALPHA) Creates the ChangeLayoutSectionHeader command.
changeRenderMode(renderMode, renderModeChangeOptions, correlationId)	(BETA) Creates the ChangeRenderMode command. Dispatching this command will result in change of the render mode of dashboard component
changeRichTextWidgetContent(ref, content, correlationId)	(BETA) Creates the ChangeRichTextWidgetContent command. Dispatching this command will result in change of the rich text widget's Markdown content.
changeSharing(newSharingProperties, correlationId)	(BETA) Creates the ChangeSharing command. Dispatching this command will result in change of sharing status of dashboard. The changes will be done in-memory and also propagated to the backend.
changeWorkingAttributeFilterSelection(filterLocalId, elements, selectionType, correlationId, isSelectionInvalid)	Creates the ChangeAttributeFilterSelection command for working filter.
clearDateFilterSelection(correlationId, dataSet, isWorkingSelectionChange, localIdentifier)	This convenience function will create ChangeDateFilterSelection configured so that the date filter will be unbounded - showing data for 'All Time'.
commandFailedEventHandler(type, handler)	(ALPHA) Creates a DashboardEventHandler instance that will be invoked for a DashboardCommandFailed of a particular command.
commandStartedEventHandler(type, handler)	(ALPHA) Creates a DashboardEventHandler instance that will be invoked for a DashboardCommandStarted of a particular command.
convertDashboardTabFromDefault(title, correlationId)	(ALPHA) Creates the ConvertDashboardTabFromDefault command.
createAlert(alert, correlationId)	(BETA) Creates the SaveAlert command. Dispatching this command will result in the creating alert on the backend.
createDashboardTab(title, index, shouldStartRenaming, correlationId)	(ALPHA) Creates the CreateDashboardTab command.
createScheduledEmail(scheduledEmail, correlationId)	(BETA) Creates the CreateScheduledEmail command. Dispatching this command will result in the creating scheduled email on the backend.
crossFiltering(insight, drillDefinition, drillEvent, correlationId)	(BETA) Creates the ICrossFiltering command. Dispatching this command will result into applying intersection attribute filters to the dashboard and insight will ignore these filters further Eventually a IDashboardCrossFilteringResolved event will be dispatched at the end.
Dashboard(props)
dashboardAttributeFilterToAttributeFilter(filter)	Converts to IAttributeFilter instance.
dashboardDateFilterToDateFilterByDateDataSet(filter, dateDataSet)	Converts to IDateFilter instance.
dashboardDateFilterToDateFilterByWidget(filter, widget)	Converts to IDateFilter instance.
dashboardTabConvertedFromDefault(ctx, newTabId, index, correlationId)	(ALPHA) Creates the DashboardTabConvertedFromDefault event.
dashboardTabCreated(ctx, newTabId, index, correlationId)	(ALPHA) Creates the DashboardTabCreated event.
dashboardTabDeleted(ctx, deletedTabId, previousIndex, nextActiveTabId, correlationId)	(ALPHA) Creates the DashboardTabDeleted event.
dashboardTabRenamed(ctx, tabId, title, correlationId)	(ALPHA) Creates the DashboardTabRenamed event.
dashboardTabRenamingCanceled(ctx, tabId, correlationId)	(ALPHA) Creates the DashboardTabRenamingCanceled event.
dashboardTabRenamingStarted(ctx, tabId, correlationId)	(ALPHA) Creates the DashboardTabRenamingStarted event.
dashboardTabSwitched(ctx, previousTabId, newTabId, correlationId)	(ALPHA) Creates the DashboardTabSwitched event.
DefaultAlertingDialogNew(props)	(ALPHA)
DefaultAlertingDialogOld({ editAlert, editWidget, anchorEl, onCancel, onUpdate, })	(ALPHA)
DefaultAlertingManagementDialogNew({ onPauseSuccess, onPauseError, onEdit, onAdd, onDeleteSuccess, onDeleteError, onClose, isLoadingAlertingData, automations, })	(ALPHA)
DefaultAlertingManagementDialogOld({ onPauseSuccess, onPauseError, onEdit, onDeleteSuccess, onDeleteError, onClose, isLoadingAlertingData, automations, })	(ALPHA)
DefaultButtonBar({ children, cancelButtonProps, saveButtonProps, settingButtonProps, editButtonProps, saveAsNewButtonProps, shareButtonProps, childContentPosition, })	(ALPHA)
DefaultDashboardAttributeFilter(props)	(ALPHA) Default implementation of the attribute filter to use on the dashboard's filter bar. This will use the SDK's AttributeFilter with the button styled same as we have it today on KD.
DefaultDashboardDateFilter({ filter, workingFilter, onFilterChanged, config, readonly, autoOpen, ButtonComponent, overlayPositionType, tabId, })	(ALPHA) Default implementation of the date filter to use on the dashboard's filter bar. This will use the SDK's DateFilter with the button styled same as we have it today on KD.
DefaultDashboardExportVariables({ renderMode })	(ALPHA)
DefaultDashboardInsight(props)	Default implementation of the Dashboard Insight widget.
DefaultDashboardInsightMenu(props)	(ALPHA)
DefaultDashboardLayout(props)	(ALPHA)
DefaultDashboardRichTextMenu(props)	(ALPHA)
DefaultDashboardSettingsDialog({ isVisible, onApply, onCancel, })	(ALPHA)
defaultDashboardThemeModifier(theme)	(BETA) Default modifier applied to any theme passed to Dashboard component
DefaultFilterBar(props)	(ALPHA)
DefaultFlexibleDashboardLayout({ layout: providedLayout, onFiltersChange, onDrill, onError, dashboardItemClasses, })	(ALPHA)
DefaultInsightBody(props)	(ALPHA) Default implementation of the InsightBody.
DefaultLockedStatus(props)	(ALPHA)
DefaultMenuButton({ menuItems })	(ALPHA)
DefaultSaveAsDialog({ onSubmit, onCancel, onError, isVisible, onSuccess, })	(ALPHA)
DefaultScheduledEmailDialog(props)	(ALPHA)
DefaultScheduledEmailManagementDialog({ onAdd, onEdit, onDeleteSuccess: onDelete, onClose, onDeleteError, isLoadingScheduleData, automations, notificationChannels, })	(ALPHA)
DefaultShareButton({ isVisible, onShareButtonClick, })	(ALPHA)
DefaultShareDialog({ workspace, backend, isVisible, sharedObject, currentUser, isLockingSupported, isCurrentUserWorkspaceManager, currentUserPermissions, dashboardFilters, isShareGrantHidden, applyShareGrantOnSelect, showDashboardShareLink, isGranteeShareLoading, onApply, onCancel, onError, onInteraction, onShareLinkCopy, })	(ALPHA)
DefaultShareStatus(props)	(ALPHA)
DefaultTitle({ title })	(ALPHA)
DefaultTopBar(props)	(ALPHA)
DefaultVisualizationSwitcherToolbar(props)	(ALPHA)
deleteDashboard(correlationId)	(BETA) Creates the DeleteDashboard command. Dispatching this command will result in removal of the currently rendered dashboard from analytical backend and reverting the dashboard component to an 'empty' state where it is initialized to create a new dashboard.
deleteDashboardTab(tabId, correlationId)	(ALPHA) Creates the DeleteDashboardTab command.
deleteFilterView(ref, correlationId)	(ALPHA) Creates the IDeleteFilterView command.
disableInsightWidgetDateFilter(ref, correlationId)	(BETA) Creates the ChangeInsightWidgetFilterSettings command for IFilterOpDisableDateFilter operation. Dispatching this command will result in change of Insight widget's date filter setting. The date filtering will be disabled.
disableKpiWidgetDateFilter(ref, correlationId)	(BETA) Creates the ChangeKpiWidgetFilterSettings command for IFilterOpDisableDateFilter operation. Dispatching this command will result in change of KPI widget's date filter setting. The date filtering will be disabled.
disableRichTextWidgetDateFilter(ref, correlationId)	(ALPHA) Creates the ChangeRichTextWidgetFilterSettings command for IFilterOpDisableDateFilter operation. Dispatching this command will result in change of Rich Text widget's date filter setting. The date filtering will be disabled.
dispatchAndWaitFor(dispatch, command)	(ALPHA) Dispatches a command and returns a promise to wait for it to get resolved.
drill(drillEvent, drillContext, correlationId)	(ALPHA) Creates the IDrill command. Dispatching this command will result into dispatching IDashboardDrillResolved event. This is general dashboard drill command with details about all possible more granular drill interactions that can follow. Reason for this general drill command is that it may happen that multiple drill interactions are possible for one drill event. Example: some attribute on the insight has drill down set and also widget has drill to insight set. Then this command must be dispatched with both and definitions. This must be always the first command that occurs after the drill interaction and must be dispatched before more granular drill commands. - Specific drill commands that can follow this general drill command are: IDrillDown, IDrillToInsight, IDrillToDashboard, IDrillToCustomUrl, IDrillToAttributeUrl, IDrillToLegacyDashboard
drillDown(insight, drillDefinition, drillEvent, correlationId)	(ALPHA) Creates the IDrillDown command. Dispatching this command will result into applying drill down definition to the provided insight (result of the drill down application depends on the particular visualization type) and dispatching IDashboardDrillDownResolved event that will contain it. In the default dashboard implementation dispatching this command will also result into opening drill dialog with the insight that has this particular drill down definition applied.
drillTargetsAdded(ctx, ref, availableDrillTargets, correlationId)	(ALPHA) Create DrillTargetsAdded IDrillTargetsAdded event.
drillToAttributeUrl(drillDefinition, drillEvent, correlationId)	(ALPHA) Creates the IDrillToAttributeUrl command. Dispatching this command will result into resolving the target attribute url and dispatching IDashboardDrillToAttributeUrlResolved event that will contain it. For more details, see: https://help.gooddata.com/pages/viewpage.action?pageId=86794855
drillToCustomUrl(drillDefinition, drillEvent, correlationId)	(ALPHA) Creates the IDrillToCustomUrl command. Dispatching this command will result into resolving the target url and dispatching IDashboardDrillToCustomUrlResolved event that will contain it. Custom url can contain various identifier or attribute title placeholders, see: https://help.gooddata.com/pages/viewpage.action?pageId=86794855
drillToDashboard(drillDefinition, drillEvent, correlationId)	(ALPHA) Creates the IDrillToDashboard command. Dispatching this command will result into getting the drill intersection filters that can be applied to the target dashboard and dispatching IDashboardDrillToDashboardResolved event that will contain them.
drillToInsight(drillDefinition, drillEvent, correlationId)	(ALPHA) Creates the IDrillToInsight command. Dispatching this command will result into applying the drill intersection filters to the target insight and dispatching IDashboardDrillToInsightResolved event that will contain it. In the default dashboard implementation this command will also result into opening the drill dialog with the target insight that has the drill intersection filters applied.
drillToLegacyDashboard(drillDefinition, drillEvent, correlationId)	(ALPHA) Creates the IDrillToLegacyDashboard command. Dispatching this command will result into dispatching IDashboardDrillToLegacyDashboardResolved event. Drill to legacy dashboard can be configured for Kpi widgets only.
eagerRemoveNestedLayoutSectionItem(itemPath, stashIdentifier, correlationId)	(ALPHA) Creates the RemoveSectionItem configured to do eager remove of item.
eagerRemoveSectionItem(sectionIndex, itemIndex, stashIdentifier, correlationId)	(BETA) Creates the RemoveSectionItem configured to do eager remove of item.
eagerRemoveSectionItemByWidgetRef(widgetRef, stashIdentifier, correlationId)	(BETA) Creates the RemoveSectionItemByWidgetRef configured to do eager remove of item.
EditableTitle({ title, onTitleChanged })	(ALPHA)
enableInsightWidgetDateFilter(ref, dateDataset, correlationId)	(BETA) Creates the ChangeInsightWidgetFilterSettings command for IFilterOpEnableDateFilter operation. Dispatching this command will result in change of Insight widget's date filter setting. The date filtering will be enabled and the provided date data set will be used for date-filtering widget's insight.
enableKpiWidgetDateFilter(ref, dateDataset, correlationId)	(BETA) Creates the ChangeKpiWidgetFilterSettings command for IFilterOpEnableDateFilter operation. Dispatching this command will result in change of KPI widget's date filter setting. The date filtering will be enabled and the provided date data set will be used for date-filtering widget's KPI.
enableRichTextWidgetDateFilter(ref, dateDataset, correlationId)	(BETA) Creates the ChangeRichTextWidgetFilterSettings command for IFilterOpEnableDateFilter operation. Dispatching this command will result in change of RichText widget's date filter setting. The date filtering will be enabled and the provided date data set will be used for date-filtering widget's RichText.
exportDashboardToExcel(mergeHeaders, exportInfo, widgetIds, fileName, format, pdfConfiguration, correlationId)	(BETA) Creates the IExportDashboardToExcel command. Dispatching this command will result in a request to export the dashboard to a EXCEL file. If successful, an instance of IDashboardExportToExcelResolved will be emitted with the URL of the resulting file.
exportDashboardToPdf(correlationId)	(BETA) Creates the IExportDashboardToPdf command. Dispatching this command will result in a request to export the dashboard to a PDF file. If successful, an instance of IDashboardExportToPdfResolved will be emitted with the URL of the resulting file.
exportDashboardToPdfPresentation(payload, correlationId)	(BETA) Creates the IExportDashboardToPdfPresentation command. Dispatching this command will result in a request to export the dashboard to a PDF presentation file. If successful, an instance of IDashboardExportToPdfPresentationResolved will be emitted with the URL of the resulting file.
exportDashboardToPptPresentation(payload, correlationId)	(BETA) Creates the IExportDashboardToPptPresentation command. Dispatching this command will result in a request to export the dashboard to a Ppt presentation file. If successful, an instance of IDashboardExportToPptPresentationResolved will be emitted with the URL of the resulting file.
exportImageInsightWidget(ref, filename, correlationId)	(ALPHA) Creates the ExportImageInsightWidget command. Dispatching this command will result in exporting of the widget to an image.
exportInsightWidget(ref, config, correlationId)	(BETA) Creates the ExportInsightWidget command. Dispatching this command will result in exporting of the widget to a CSV of XLSX file.
exportRawInsightWidget(ref, widget, insight, filename, correlationId)	(ALPHA) Creates the ExportRawInsightWidget command. Dispatching this command will result in exporting of the widget to a CSV.
exportSlidesInsightWidget(ref, filename, exportType, correlationId)	(ALPHA) Creates the ExportSlidesInsightWidget command. Dispatching this command will result in exporting of the widget to a slides type (pdf, pptx).
ExportThemeProvider({ children })	(ALPHA)
filterContextItemsToDashboardFiltersByDateDataSet(filterContextItems, dateDataSet)	Gets IDashboardFilter items for filters specified as instances.
filterContextItemsToDashboardFiltersByRichTextWidget(filterContextItems, widget)	Gets IDashboardFilter items for filters specified as instances.
filterContextItemsToDashboardFiltersByWidget(filterContextItems, widget)	Gets IDashboardFilter items for filters specified as instances.
filterContextSelectionReset(correlationId)	(ALPHA)
filterContextToDashboardFiltersByDateDataSet(filterContext, dateDataSet)	Gets IDashboardFilter items for filters specified in given filterContext in relation to the given dateDataSet.
filterContextToDashboardFiltersByWidget(filterContext, widget)	Gets IDashboardFilter items for filters specified in given filterContext in relation to the given widget.
formatKeyDriverAnalysisDateRange(range, splitter)	(BETA)
getWidgetTitle(widget, fallbackTitle)	Safely gets the title from an ExtendedDashboardWidget.
HiddenButtonBar()	(ALPHA) This implementation of button bar keeps it out of sight and effectively disables it.
HiddenDashboardAttributeFilter()	(ALPHA) This implementation of dashboard attribute filter keeps the filter hidden out of sight. The attribute filter itself will still be in effect.
HiddenDashboardDateFilter()	(ALPHA) This implementation of dashboard date filter keeps the filter hidden out of sight. The attribute filter itself will still be in effect.
HiddenFilterBar(_props)	(ALPHA) This implementation of Filter Bar will ensure that all the filter controls are out of sight. All the dashboard filtering is still in place however user cannot see or interact with the filters.
HiddenMenuButton()	(ALPHA) This implementation of menu button keeps it out of sight and effectively disables it.
HiddenShareButton()	(ALPHA) This implementation of share button keeps it out of sight and effectively disables it.
HiddenTitle()	(ALPHA) This implementation of title keeps it out of sight and effectively disables it.
HiddenTopBar(_props)	(ALPHA) This implementation of top bar keeps it out of sight.
ignoreDateFilterOnInsightWidget(ref, oneOrMoreDataSets, correlationId)	Creates the ChangeInsightWidgetFilterSettings command for IFilterOpIgnoreDateFilter operation. Dispatching this command will result in addition of one or more filters into Insight widget's date filter ignore-list. Those date filters that use the provided date data sets for filtering will be ignored by the widget on top of any other filters that are already ignored. Ignored date filters are not passed down to the insight and will not be used to filter that insight. The operation is idempotent - trying to ignore a date filter multiple times will have no effect.
ignoreDateFilterOnRichTextWidget(ref, oneOrMoreDataSets, correlationId)	(ALPHA) Creates the ChangeRichTextWidgetFilterSettings command for IFilterOpIgnoreDateFilter operation. Dispatching this command will result in addition of one or more filters into Rich Text widget's date filter ignore-list. Ignored date filters are not passed down to the metrics resolved in rich text references. The operation is idempotent - trying to ignore a date filter multiple times will have no effect.
ignoreFilterOnInsightWidget(ref, oneOrMoreDisplayForms, correlationId)	Creates the ChangeInsightWidgetFilterSettings command for IFilterOpIgnoreAttributeFilter operation. Dispatching this command will result in addition of one or more filters into Insight widget's attribute filter ignore-list. Those attribute filters that use the provided displayForms for filtering will be ignored by the widget on top of any other filters that are already ignored. Ignored attribute filters are not passed down to the insight and will not be used to filter that insight. The operation is idempotent - trying to ignore an attribute filter multiple times will have no effect.
ignoreFilterOnKpiWidget(ref, oneOrMoreDisplayForms, correlationId)	(BETA) Creates the ChangeKpiWidgetFilterSettings command for IFilterOpIgnoreAttributeFilter operation. Dispatching this command will result in addition of one or more filters into KPI widget's attribute filter ignore-list. Those attribute filters that use the provided displayForms for filtering will be ignored by the widget on top of any other filters that are already ignored. Ignored attribute filters are not passed down to the KPI and will not be used to filter that KPI. The operation is idempotent - trying to ignore an attribute filter multiple times will have no effect.
ignoreFilterOnRichTextWidget(ref, oneOrMoreDisplayForms, correlationId)	(ALPHA) Creates the ChangeRichTextWidgetFilterSettings command for IFilterOpIgnoreAttributeFilter operation. Dispatching this command will result in addition of one or more filters into Rich Text widget's attribute filter ignore-list. Those attribute filters that use the provided displayForms for filtering will be ignored by the widget on top of any other filters that are already ignored. Ignored attribute filters are not passed down to the metrics and will not be used to filter those metrics. The operation is idempotent - trying to ignore an attribute filter multiple times will have no effect.
initializeAutomations(correlationId)	(BETA) Creates the InitializeAutomations command. Dispatching this command will result in the initializing dashboard automations. This initialization is necessary for working with alerts and scheduled exports.
initializeDashboard(config, permissions, correlationId, initialTabId)	Creates the InitializeDashboard command.
insightSelectDateDataset({ mostImportantFromInsight, dateDatasetsOrdered, })	(ALPHA) Given results of a query of date datasets available to use for filtering an insight, this function will pick a single date dataset to use.
isAnyPlaceholderWidget(obj)	(ALPHA) Tests whether an object is any type of placeholder widgets.
isBrokenAlertAttributeFilterInfo(item)	(ALPHA) Tests whether the provided object is an instance of BrokenAlertAttributeFilterInfo
isBrokenAlertDateFilterInfo(item)	(ALPHA) Tests whether the provided object is an instance of BrokenAlertDateFilterInfo
isCustomDashboardEvent(obj)	Tests whether object is an instance of ICustomDashboardEvent.
isCustomWidget(obj)	Type-guard that tests whether an object is an instance of ICustomWidget.
isCustomWidgetBase(obj)	Type-guard that tests whether an object is an instance of ICustomWidgetBase.
isCustomWidgetDefinition(obj)	Type-guard that tests whether an object is an instance of ICustomWidgetDefinition.
isDashboardAlertCreated(obj)	(BETA) Tests whether the provided object is an instance of IDashboardAlertCreated.
isDashboardAlertSaved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardAlertSaved.
isDashboardAsyncRenderRequested(obj)	Tests whether the provided object is an instance of DashboardAsyncRenderRequested.
isDashboardAsyncRenderResolved(obj)	Tests whether the provided object is an instance of DashboardAsyncRenderResolved.
isDashboardAttributeFilterAdded(obj)	(BETA) Tests whether the provided object is an instance of IDashboardAttributeFilterAdded.
isDashboardAttributeFilterConfigLimitingItemsChanged(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardAttributeFilterConfigLimitingItemsChanged.
isDashboardAttributeFilterConfigModeChanged(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardAttributeFilterConfigModeChanged.
isDashboardAttributeFilterMoved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardAttributeFilterMoved.
isDashboardAttributeFilterParentChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardAttributeFilterParentChanged.
isDashboardAttributeFilterRemoved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardAttributeFilterRemoved.
isDashboardAttributeFilterSelectionChanged(obj)	Tests whether the provided object is an instance of DashboardAttributeFilterSelectionChanged.
isDashboardAttributeFilterSelectionModeChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardAttributeSelectionModeChanged.
isDashboardAttributeFilterTitleChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardAttributeTitleChanged.
isDashboardAutomationsRefreshed(obj)	(BETA) Tests whether the provided object is an instance of IDashboardAutomationsRefreshed.
isDashboardCommandFailed(obj)	(BETA) Tests whether the provided object is an instance of IDashboardCommandFailed.
isDashboardCommandRejected(obj)	(BETA) Tests whether the provided object is an instance of IDashboardCommandRejected.
isDashboardCommandStarted(obj)	(BETA) Tests whether the provided object is an instance of IDashboardCommandStarted.
isDashboardCopySaved(obj)	Tests whether the provided object is an instance of DashboardCopySaved.
isDashboardCrossFilteringRequested(obj)	(BETA) Tests whether the provided object is an instance of IDashboardCrossFilteringRequested.
isDashboardCrossFilteringResolved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardCrossFilteringResolved.
isDashboardDateFilterSelectionChanged(obj)	Tests whether the provided object is an instance of DashboardDateFilterSelectionChanged.
isDashboardDeinitialized(obj)	Tests whether the provided object is an instance of DashboardDeinitialized.
isDashboardDeleted(obj)	(BETA) Tests whether the provided object is an instance of IDashboardDeleted
isDashboardDrillableItemsChanged(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillableItemsChanged.
isDashboardDrillDownRequested(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillDownRequested.
isDashboardDrillDownResolved(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillDownResolved.
isDashboardDrillRequested(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillRequested.
isDashboardDrillResolved(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillResolved.
isDashboardDrillToAttributeUrlRequested(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillToAttributeUrlRequested.
isDashboardDrillToAttributeUrlResolved(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillToAttributeUrlResolved.
isDashboardDrillToCustomUrlRequested(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillToCustomUrlRequested.
isDashboardDrillToCustomUrlResolved(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillToCustomUrlResolved.
isDashboardDrillToDashboardRequested(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillToDashboardRequested.
isDashboardDrillToDashboardResolved(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillToDashboardResolved.
isDashboardDrillToInsightRequested(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillToInsightRequested.
isDashboardDrillToInsightResolved(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillToInsightResolved.
isDashboardDrillToLegacyDashboardRequested(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillToLegacyDashboardRequested.
isDashboardDrillToLegacyDashboardResolved(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardDrillToLegacyDashboardResolved.
isDashboardEvent(obj)	Tests whether object is an instance of IDashboardEvent.
isDashboardEventOrCustomDashboardEvent(obj)	Tests whether object is an instance of IDashboardEvent or ICustomDashboardEvent.
isDashboardExportToExcelRequested(obj)	(BETA) Tests whether the provided object is an instance of IDashboardExportToExcelRequested.
isDashboardExportToExcelResolved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardExportToExcelResolved.
isDashboardExportToImageRequested(obj)	(BETA) Tests whether the provided object is an instance of IDashboardExportToPptPresentationRequested.
isDashboardExportToImageResolved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardExportToPptPresentationResolved.
isDashboardExportToPdfPresentationRequested(obj)	(BETA) Tests whether the provided object is an instance of IDashboardExportToPdfPresentationRequested.
isDashboardExportToPdfPresentationResolved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardExportToPdfPresentationResolved.
isDashboardExportToPdfRequested(obj)	(BETA) Tests whether the provided object is an instance of IDashboardExportToPdfRequested.
isDashboardExportToPdfResolved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardExportToPdfResolved.
isDashboardExportToPptPresentationRequested(obj)	(BETA) Tests whether the provided object is an instance of IDashboardExportToPptPresentationRequested.
isDashboardExportToPptPresentationResolved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardExportToPptPresentationResolved.
isDashboardFilter(obj)	(ALPHA) Type-guard testing whether the provided object is an instance of IDashboardFilter.
isDashboardFilterContextChanged(obj)	Tests whether the provided object is an instance of DashboardFilterContextChanged.
isDashboardFilterContextSelectionReset(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardFilterContextSelectionReset.
isDashboardFilterViewApplicationFailed(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardFilterViewApplicationFailed.
isDashboardFilterViewApplicationSucceeded(obj)	(BETA) Tests whether the provided object is an instance of IDashboardFilterViewApplicationSucceeded.
isDashboardFilterViewCreationFailed(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardFilterViewCreationFailed.
isDashboardFilterViewCreationSucceeded(obj)	(BETA) Tests whether the provided object is an instance of IDashboardFilterViewCreationSucceeded.
isDashboardFilterViewDefaultStatusChangeFailed(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardFilterViewDefaultStatusChangeFailed.
isDashboardFilterViewDefaultStatusChangeSucceeded(obj)	(BETA) Tests whether the provided object is an instance of IDashboardFilterViewDefaultStatusChangeSucceeded.
isDashboardFilterViewDeletionFailed(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardFilterViewDeletionFailed.
isDashboardFilterViewDeletionSucceeded(obj)	(BETA) Tests whether the provided object is an instance of IDashboardFilterViewDeletionSucceeded.
isDashboardIgnoreExecutionTimestampChanged(obj)	(ALPHA) Tests whether the provided object is an instance of IDashboardIgnoreExecutionTimestampChanged.
isDashboardInitialized(obj)	Tests whether the provided object is an instance of DashboardInitialized.
isDashboardInsightWidgetChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardInsightWidgetChanged.
isDashboardInsightWidgetDescriptionChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardInsightWidgetDescriptionChanged.
isDashboardInsightWidgetDrillsModified(obj)	(BETA) Tests whether the provided object is an instance of IDashboardInsightWidgetDrillsModified.
isDashboardInsightWidgetDrillsRemoved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardInsightWidgetDrillsRemoved.
isDashboardInsightWidgetExportRequested(obj)	(BETA) Tests whether the provided object is an instance of IDashboardInsightWidgetExportRequested.
isDashboardInsightWidgetExportResolved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardInsightWidgetExportResolved.
isDashboardInsightWidgetFilterSettingsChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardInsightWidgetFilterSettingsChanged.
isDashboardInsightWidgetHeaderChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardInsightWidgetHeaderChanged.
isDashboardInsightWidgetInsightSwitched(obj)	(BETA) Tests whether the provided object is an instance of IDashboardInsightWidgetInsightSwitched.
isDashboardInsightWidgetRefreshed(obj)	(BETA) Tests whether the provided object is an instance of IDashboardInsightWidgetRefreshed.
isDashboardInsightWidgetVisConfigurationChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardInsightWidgetVisConfigurationChanged.
isDashboardInsightWidgetVisPropertiesChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardInsightWidgetVisPropertiesChanged.
isDashboardItemVisualization(item)	Tests whether the provided item is a dashboard item with visualization.
isDashboardItemVisualizationContent(item)	Tests whether the provided item is a dashboard item with visualization content.
isDashboardKeyDriverAnalysisRequested(obj)	(BETA) Tests whether the provided object is an instance of IDashboardKeyDriverAnalysisRequested.
isDashboardKeyDriverAnalysisResolved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardKeyDriverAnalysisResolved.
isDashboardKpiWidgetChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardKpiWidgetChanged.
isDashboardKpiWidgetComparisonChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardKpiWidgetComparisonChanged.
isDashboardKpiWidgetConfigurationChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardKpiWidgetConfigurationChanged.
isDashboardKpiWidgetDescriptionChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardKpiWidgetDescriptionChanged.
isDashboardKpiWidgetDrillRemoved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardKpiWidgetDrillRemoved.
isDashboardKpiWidgetDrillSet(obj)	(BETA) Tests whether the provided object is an instance of IDashboardKpiWidgetDrillSet.
isDashboardKpiWidgetFilterSettingsChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardKpiWidgetFilterSettingsChanged.
isDashboardKpiWidgetHeaderChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardKpiWidgetHeaderChanged.
isDashboardKpiWidgetMeasureChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardKpiWidgetMeasureChanged.
isDashboardLayoutChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardLayoutChanged.
isDashboardLayoutSectionAdded(obj)	(BETA) Tests whether the provided object is an instance of IDashboardLayoutSectionAdded.
isDashboardLayoutSectionHeaderChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardLayoutSectionHeaderChanged.
isDashboardLayoutSectionItemMoved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardLayoutSectionItemMoved.
isDashboardLayoutSectionItemMovedToNewSection(obj)	(BETA) Tests whether the provided object is an instance of IDashboardLayoutSectionItemMovedToNewSection.
isDashboardLayoutSectionItemRemoved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardLayoutSectionItemRemoved.
isDashboardLayoutSectionItemReplaced(obj)	(BETA) Tests whether the provided object is an instance of IDashboardLayoutSectionItemReplaced.
isDashboardLayoutSectionItemsAdded(obj)	(BETA) Tests whether the provided object is an instance of IDashboardLayoutSectionItemsAdded.
isDashboardLayoutSectionMoved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardLayoutSectionMoved.
isDashboardLayoutSectionRemoved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardLayoutSectionRemoved.
isDashboardQueryCompleted(obj)	(BETA) Tests whether the provided object is an instance of IDashboardQueryCompleted.
isDashboardQueryFailed(obj)	(BETA) Tests whether the provided object is an instance of IDashboardCommandFailed.
isDashboardQueryRejected(obj)	(BETA) Tests whether the provided object is an instance of IDashboardQueryRejected.
isDashboardQueryStarted(obj)	(BETA) Tests whether the provided object is an instance of IDashboardQueryStarted.
isDashboardRenamed(obj)	(BETA) Tests whether the provided object is an instance of IDashboardRenamed.
isDashboardRenderModeChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardRenderModeChanged.
isDashboardRenderRequested(obj)	Tests whether the provided object is an instance of DashboardRenderRequested.
isDashboardRenderResolved(obj)	Tests whether the provided object is an instance of DashboardRenderResolved.
isDashboardRichTextWidgetContentChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardRichTextWidgetContentChanged.
isDashboardRichTextWidgetFilterSettingsChanged(obj)	(BETA) Tests whether the provided object is an instance of IDashboardInsightWidgetFilterSettingsChanged.
isDashboardSaved(obj)	Tests whether the provided object is an instance of DashboardSaved.
isDashboardScheduledEmailCreated(obj)	(BETA) Tests whether the provided object is an instance of IDashboardScheduledEmailCreated.
isDashboardScheduledEmailSaved(obj)	(BETA) Tests whether the provided object is an instance of IDashboardScheduledEmailSaved.
isDashboardSharingChanged(obj)	Tests whether the provided object is an instance of DashboardSharingChanged.
isDashboardTabConvertedFromDefault(event)	(ALPHA) Type guard that checks if an event is a DashboardTabConvertedFromDefault event.
isDashboardTabCreated(event)	(ALPHA) Type guard that checks if an event is a DashboardTabCreated event.
isDashboardTabDeleted(event)	(ALPHA) Type guard that checks if an event is a DashboardTabDeleted event.
isDashboardTabRenamed(event)	(ALPHA) Type guard for IDashboardTabRenamed.
isDashboardTabRenamingCanceled(event)	(ALPHA) Type guard for IDashboardTabRenamingCanceled.
isDashboardTabRenamingStarted(event)	(ALPHA) Type guard for IDashboardTabRenamingStarted.
isDashboardTabSwitched(event)	(ALPHA) Type guard that checks if an event is a DashboardTabSwitched event.
isDashboardUserInteractionTriggered(obj)	(BETA) Tests whether the provided object is an instance of IDashboardUserInteractionTriggered.
isDashboardVisualizationSwitcherWidgetVisualizationAdded(obj)	(BETA) Tests whether the provided object is an instance of IDashboardVisualizationSwitcherWidgetVisualizationAdded.
isDashboardVisualizationSwitcherWidgetVisualizationsUpdated(obj)	(BETA) Tests whether the provided object is an instance of IDashboardVisualizationSwitcherWidgetVisualizationsUpdated.
isDashboardWasReset(obj)	(BETA) Tests whether the provided object is an instance of IDashboardWasReset.
isDashboardWidgetExecutionFailed(obj)	(BETA) Tests whether the provided object is an instance of IDashboardWidgetExecutionFailed.
isDashboardWidgetExecutionStarted(obj)	(BETA) Tests whether the provided object is an instance of IDashboardWidgetExecutionStarted.
isDashboardWidgetExecutionSucceeded(obj)	(BETA) Tests whether the provided object is an instance of IDashboardWidgetExecutionSucceeded.
isDateFilterValidationFailed(obj)	(BETA) Tests whether the provided object is an instance of DateFilterValidationFailed.
isDrillDownDefinition(obj)	(BETA) Type-guard testing whether the provided object is an instance of IDrillDownDefinition.
isDrillTargetsAdded(obj)	(ALPHA) Tests whether the provided object is an instance of IDrillTargetsAdded.
isExtendedDashboardLayoutWidget(obj)	Type-guard testing whether the provided object is an instance of ExtendedDashboardLayoutWidget.
isInsightPlaceholderWidget(obj)	(ALPHA) Tests whether an object is a IInsightPlaceholderWidget.
isKpiPlaceholderWidget(obj)	(ALPHA) Tests whether an object is a IKpiPlaceholderWidget.
isLayoutCoordinates(obj)	(ALPHA) Tests whenever the provided object is layout coordinates object.
isLayoutDirectionChanged(obj)	(BETA) Tests whether the provided object is an instance of ILayoutDirectionChanged.
isLayoutItemPath(obj)	(ALPHA) Tests whenever the provided object is section path.
isLayoutSectionHeadersToggled(obj)	(BETA) Tests whether the provided object is an instance of ILayoutSectionHeadersToggled.
isLayoutSectionPath(obj)	(ALPHA) Tests whenever the provided object is section path.
isPlaceholderWidget(obj)	(ALPHA) Tests whether an object is a IPlaceholderWidget.
isScreenSizeChanged(obj)	(BETA) Tests whether the provided object is an instance of IScreenSizeChanged.
isShowWidgetAsTableSet(obj)	(BETA) Tests whether the provided object is an instance of IShowWidgetAsTableSet.
keyDriverAnalysis(drillDefinition, drillEvent, filters, keyDriveItem, correlationId)	(BETA) Creates the IKeyDriverAnalysis command. Dispatching this command will result into applying intersection attribute filters to the dashboard and insight will ignore these filters further Eventually a IDashboardKeyDriverAnalysisResolved event will be dispatched at the end.
LockedStatusIndicator(props)	(ALPHA)
modifyDrillDownForInsightWidget(ref, attributeIdentifier, attributeHierarchyRef, blacklistHierarchies, intersectionIgnoredAttributes, correlationId)	(ALPHA) Creates the ModifyDrillDownForInsightWidget command. Dispatching the created command will update insight widget's drill definition for the provided measure.
modifyDrillsForInsightWidget(ref, drills, blacklistHierarchiesToUpdate, correlationId)	(BETA) Creates the ModifyDrillsForInsightWidget command. Dispatching the created command will add or modify a new drill for the insight widget. Drill can be setup for particular measure - meaning elements in the insight will be clickable. Exactly one drill can be specified for a measure. What happens on click depends on the context in which the dashboard lives: When in KPI Dashboard (embedded or not) the defined action is actually triggered and done - it may open a new tab, open overlay with insight, navigate to a new dashboard and carry over the filters. - When the dashboard is embedded using Dashboard component, an event will be emitted describing the defined drill action.
moveAttributeFilter(filterLocalId, index, correlationId)	(BETA) Creates the MoveAttributeFilter command. Dispatching this command will result in move of the dashboard attribute filter with the provided local id to a new spot. The new spot is defined by index. For convenience the index of -1 means move to the end of the attribute filter list.
moveDateFilter(dataSet, index, correlationId)	(BETA) Creates the MoveDateFilter command. Dispatching this command will result in move of the dashboard date filter with the provided dataSet to a new spot. The new spot is defined by index. For convenience the index of -1 means move to the end of the filter list.
moveLayoutSection(sectionIndex, toIndex, correlationId)	(BETA) Creates the MoveLayoutSection command. Dispatching this command will result in move of the section located at sectionIndex to a new place indicated by toIndex.
moveNestedLayoutSection(sectionIndex, toIndex, correlationId)	(ALPHA) Creates the MoveLayoutSection command. Dispatching this command will result in move of the section located at sectionIndex to a new place indicated by toIndex.
moveNestedLayoutSectionItem(fromPath, toPath, correlationId)	(ALPHA) Creates the MoveSectionItem command.
moveNestedLayoutSectionItemAndRemoveOriginalSectionIfEmpty(fromPath, toPath, correlationId)	(ALPHA) Creates the MoveSectionItem command.
moveNestedLayoutSectionItemToNewSection(itemPath, toSection, correlationId)	(ALPHA) Creates the MoveSectionItemToNewSection command.
moveNestedLayoutSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty(itemPath, toSection, correlationId)	(ALPHA) Creates the MoveSectionItemToNewSection command.
moveSectionItem(sectionIndex, itemIndex, toSectionIndex, toItemIndex, correlationId)	(BETA) Creates the MoveSectionItem command.
moveSectionItemAndRemoveOriginalSectionIfEmpty(sectionIndex, itemIndex, toSectionIndex, toItemIndex, correlationId)	(BETA) Creates the MoveSectionItem command.
moveSectionItemToNewSection(sectionIndex, itemIndex, toSectionIndex, correlationId)	(BETA) Creates the MoveSectionItemToNewSection command.
moveSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty(sectionIndex, itemIndex, toSectionIndex, correlationId)	(BETA) Creates the MoveSectionItemToNewSection command.
newCustomWidget(identifier, customType, extras)	Creates a new custom widget.
newDashboardEngine()	A factory function to obtain an instance of IDashboardEngine.
newDashboardEventPredicate(eventType, pred)	(ALPHA) Creates DashboardEvent predicate that test whether the provided event matches it.
newDashboardItem(widget, sizeOrColSize)	Creates a new dashboard item containing the provided custom widget.
newDashboardSection(titleOrHeader, items)	Creates a new dashboard section.
newDisplayFormMap(items, strictTypeCheck)	(ALPHA) Creates ObjRefMap for attribute display form metadata objects.
newDrillToSameDashboardHandler(dashboardRef)	(ALPHA) Event handler with the default implementation for drill to the same dashboard. When IDashboardDrillToDashboardResolved event is fired and contains dashboard ref that matches the provided dashboard ref, or dashboard ref in the event is missing, it sets relevant drill intersection filters to the current dashboard. Note that only filters that are already stored in the dashboard filter context will be applied (attribute filters that are not visible in the filter bar will not be applied).
newInsightPlaceholderWidget()	(ALPHA)
newKpiPlaceholderWidget()	(ALPHA)
newPlaceholderWidget()	(ALPHA)
queryAndWaitFor(dispatch, query)	(ALPHA) Dispatches a query and returns a promise to its result.
queryAttributeByDisplayForm(displayForms, correlationId)	(ALPHA) Creates action through which you can query attributes for given display forms
queryConnectedAttributes(ref, correlationId)	(ALPHA) Creates action through which you can query connected attributes for the information about possibility of parent-child attribute filter relationship as only connected attributes may be dependent on each other.
queryConnectingAttributes(refs, correlationId)	(ALPHA) Creates action through which you can query connecting attributes for the information about possibility of parent-child attribute filter relationship.
queryDateDatasetsForInsight(insightOrRef, correlationId)	(ALPHA) Creates action through which you can query dashboard component for information about the date data sets that are applicable for the provided insight.
queryDateDatasetsForMeasure(measureRef, correlationId)	(ALPHA) Creates action through which you can query dashboard component for information about the date data sets that are applicable for filtering of the provided measure. measures are typically used to obtain value to render on KPIs.
queryInsightAttributesMeta(insightOrRef, correlationId)	(ALPHA) Creates action thought which you can query dashboard component for information about display forms and attributes used by an insight.
queryMetricsAndFacts(correlationId)	(ALPHA) Creates action through which you can query metrics and facts
queryWidgetAlertCount(widgetRef, correlationId)	(ALPHA) Creates action through which you can query dashboard component for information about the total number of alerts all the users have set on a given KPI widget.
queryWidgetBrokenAlerts(widgetRef, correlationId)	(ALPHA) Creates action thought which you can query dashboard component for broken alert filters.
queryWidgetFilters(widgetRef, insight, correlationId)	(ALPHA) Creates action thought which you can query dashboard component for filters that should be used by a given widget.
refreshAutomations(correlationId)	(BETA) Creates the RefreshAutomations command. Dispatching this command will result in refreshing the current dashboard's automation data. This is particularly useful after creating, updating, or removing alerts or scheduled exports, ensuring that the local data remains synchronized with the backend.
refreshInsightWidget(ref, correlationId)	(BETA) Creates the RefreshInsightWidget command. Dispatching this command will result in re-calculation of the widget's insight and re-render.
refreshKpiWidget(ref, correlationId)	(BETA) Creates the RefreshKpiWidget command. Dispatching this command will result in re-calculation of the KPI's value.
reloadFilterViews(correlationId)	(ALPHA) Creates the IReloadFilterViews command.
removeAttributeFilter(filterLocalId, correlationId)	(BETA) Creates the RemoveAttributeFilters command. Dispatching this command will result in the removal of dashboard's attribute filter with the provided local identifier.
removeAttributeFilters(filterLocalIds, correlationId)	(BETA) Creates the RemoveAttributeFilters command. Dispatching this command will result in the removal of dashboard's attribute filters with the provided local identifiers.
removeDateFilter(dataSet, correlationId)	(BETA) Creates the RemoveDateFilters command. Dispatching this command will result in the removal of dashboard's date filter with the provided date data set.
removeDrillDownForInsightWidget(ref, blacklistHierarchies, correlationId)	(ALPHA) Creates the RemoveDrillDownForInsightWidget command. Dispatching the created command will remove insight widget's drill definition for the provided measure.
removeDrillForKpiWidget(ref, correlationId)	(BETA) Creates the RemoveDrillForKpiWidget command. Dispatching this command will result in KPI having its drill removed.
removeDrillsForInsightWidget(ref, localIdentifiers, correlationId)	(BETA) Creates the RemoveDrillsForInsightWidget command. Dispatching the created command will remove insight widget's drill definition for the provided measure.
removeDrillToUrlForInsightWidget(ref, blacklistAttributes, correlationId)	(ALPHA) Creates the RemoveDrillToUrlForInsightWidget command. Dispatching the created command will remove insight widget's drill definition for the provided attribute.
removeLayoutSection(index, stashIdentifier, correlationId)	(BETA) Creates the RemoveLayoutSection command.
removeNestedLayoutSection(index, stashIdentifier, correlationId)	(ALPHA) Creates the RemoveLayoutSection command.
removeNestedLayoutSectionItem(itemPath, stashIdentifier, correlationId)	(ALPHA) Creates the RemoveSectionItem command.
removeSectionItem(sectionIndex, itemIndex, stashIdentifier, correlationId)	(BETA) Creates the RemoveSectionItem command.
removeSectionItemByWidgetRef(widgetRef, stashIdentifier, correlationId)	(BETA) Creates the RemoveSectionItemByWidgetRef command.
renameDashboard(newTitle, correlationId)	(BETA) Creates the RenameDashboard command. Dispatching this command will result in rename of the dashboard. The changes will be done only in-memory and have to be flushed to backend using the SaveDashboard command.
renameDashboardTab(title, tabId, correlationId)	(ALPHA) Creates the RenameDashboardTab command.
replaceInsightWidgetFilterSettings(ref, settings, correlationId)	(BETA) Creates the ChangeInsightWidgetFilterSettings command for IFilterOpReplaceAll operation. Dispatching this command will result in replacement of Insight widget's filter settings; this includes change of data set used for common date filter, disabling common date filtering, ignoring attribute/date filters that are defined on the dashboard for the widget.
replaceInsightWidgetIgnoredFilters(ref, displayForms, correlationId)	(BETA) Creates the ChangeInsightWidgetFilterSettings command for IFilterOpReplaceAttributeIgnores operation. Dispatching this command will result in replacement of Insight widget's attribute filter ignore-list. Those attribute filters that use the provided displayForms for filtering will be ignored by the widget.
replaceKpiWidgetFilterSettings(ref, settings, correlationId)	(BETA) Creates the ChangeKpiWidgetFilterSettings command. Dispatching this command will result in change of KPI widget's filter settings; this includes change of data set used for date filter, disabling date filtering, ignoring attribute filters that are defined on the dashboard for the widget.
replaceKpiWidgetIgnoredFilters(ref, displayForms, correlationId)	(BETA) Creates the ChangeKpiWidgetFilterSettings command for IFilterOpReplaceAttributeIgnores operation. Dispatching this command will result in replacement of KPI widget's attribute filter ignore-list. Those attribute filters that use the provided displayForms for filtering will be ignored by the widget.
replaceNestedLayoutSectionItem(itemPath, item, stashIdentifier, autoResolveDateFilterDataset, correlationId)	(ALPHA) Creates the ReplaceSectionItem command. Dispatching this command will result in replacement of particular dashboard item with a new item. By default, the old item will be discarded, however you may specify to stash it for later use.
replaceSectionItem(sectionIndex, itemIndex, item, stashIdentifier, autoResolveDateFilterDataset, correlationId)	(BETA) Creates the ReplaceSectionItem command. Dispatching this command will result in replacement of particular dashboard item with a new item. By default, the old item will be discarded, however you may specify to stash it for later use.
repositionDashboardTab(oldIndex, newIndex, correlationId)	(ALPHA) Creates the RepositionDashboardTab command.
requestAsyncRender(id, correlationId)	Notify the dashboard about asynchronous rendering (eg when the component needs to load some asynchronous data to be rendered) of the component.
resetAttributeFilterSelection(filterLocalId, correlationId)	A convenience function that will create ChangeAttributeFilterSelection command that will select all elements of the dashboard attribute filter with the provided local id.
resetDashboard(correlationId)	(BETA) Creates the ResetDashboard command. Dispatching this command will result in dropping all in-memory modifications of the dashboard and reverting to a state that is persisted on the backend. In other words reset will get dashboard to a state after the last save. Note: if a dashboard is not saved on a backend, then reset will clear the dashboard to an empty state. Limitation: reset command will have no impact on alerts or scheduled emails. These entites are persisted outside the dashboard and have their own lifecycle.
resetFilterContextWorkingSelection(correlationId)	(ALPHA) Creates the IResetFilterContextWorkingSelection command.
resizeHeight(sectionIndex, itemIndexes, height, correlationId)	(BETA) Creates the ResizeHeight command.
resizeNestedLayoutItemsHeight(sectionIndex, itemIndexes, height, correlationId)	(ALPHA) Creates the ResizeHeight command.
resizeNestedLayoutItemWidth(itemPath, width, correlationId)	(ALPHA) Creates the ResizeWidth command.
resizeWidth(sectionIndex, itemIndex, width, correlationId)	(BETA) Creates the ResizeWidth command.
resolveAsyncRender(id, correlationId)	Notify the dashboard about resolved asynchronous rendering of the component.
resolveFilterValues(filters, backend, workspace)	(ALPHA) Resolves filter values
revertLastLayoutChange(correlationId)	(ALPHA) A convenience function to create UndoLayoutChanges command that will revert the very last command and toss it out of history.
saveAlert(alert, correlationId)	(BETA) Creates the SaveAlert command. Dispatching this command will result in the saving alert on the backend.
saveDashboard(title, correlationId)	(BETA) Creates the SaveDashboard command. Dispatching this command will result in persisting all the accumulated dashboard modification to backend. The command will not have any effect if dashboard is not initialized or is empty.
saveDashboardAs(title, switchToCopy, useOriginalFilterContext, correlationId)	Creates the SaveDashboardAs command.
saveFilterView(name, isDefault, correlationId)	(ALPHA) Creates the ISaveFilterView command.
saveScheduledEmail(scheduledEmail, correlationId)	(BETA) Saves existing SaveScheduledEmail command. Dispatching this command will result in saving scheduled email on the backend.
selectAccessibleDashboards(state)	(ALPHA) Select all accessible dashboard in project.
selectAnalyticalWidgetByRef(ref)	(ALPHA) Selects analytical widget by its ref. This selector will return undefined if the provided widget ref is not analytical widget, eg. custom widget or nested layout.
selectAttributeFilterDescendants(localId)	Creates a selector for selecting all descendants of the attribute filter with given localId.
selectCrossFilteringFiltersLocalIdentifiersByWidgetRef(ref)	(BETA)
selectCrossFilteringItemByWidgetRef(ref)	(BETA)
selectCrossFilteringSelectedPointsByWidgetRef(ref)	(BETA)
selectDashboardUserAutomationAlertsInContext(widgetLocalIdentifier)	(ALPHA) Returns workspace alerts for current dashboard, widget and user context.
selectDashboardUserAutomationSchedulesInContext(widgetLocalIdentifier)	(ALPHA) Returns workspace schedules for current dashboard, widget and user context.
selectDrillTargetsByWidgetRef(ref)	(ALPHA) Selects drill targets by widget ref.
selectExecutionResult(state, id)	(ALPHA)
selectExecutionResultByRef(ref)	(ALPHA)
selectFilterableWidgetByRef(ref)	(ALPHA) Selects filterable widget by its ref (including custom widgets). This selector will return undefined if the provided ref to non-filterable widget.
selectFilterContextAttributeFilterByDisplayForm(displayForm)	Creates a selector for selecting attribute filter by its displayForm ObjRef.
selectFilterContextAttributeFilterByLocalId(localId)	Creates a selector for selecting attribute filter by its localId.
selectFilterContextDateFilterByDataSet(dataSet)	Creates a selector for selecting date filter by its dataset ObjRef.
selectIgnoredDrillDownHierarchiesByWidgetRef(ref)	(ALPHA)
selectInaccessibleDashboards(state)	(ALPHA) Select all inaccessible dashboard in project.
selectInsightByRef(ref)	(ALPHA) Selects insight used on a dashboard by its ref.
selectInsightByWidgetRef(ref)	(ALPHA) Selects insight used on a dashboard by widget ref.
selectInsights(state)	Selects all insights used on the dashboard.
selectIsExecutionResultExportableToCsvByRef(ref)	(ALPHA)
selectIsExecutionResultExportableToCsvRawByRef(ref)	(ALPHA)
selectIsExecutionResultExportableToPdfByRef(ref)	(ALPHA)
selectIsExecutionResultExportableToXlsxByRef(ref)	(ALPHA)
selectIsExecutionResultReadyForExportByRef(ref)	(ALPHA)
selectIsFilterFromCrossFilteringByLocalIdentifier(localIdentifier)	(BETA)
selectIsKpiAlertHighlightedByWidgetRef(ref)	(ALPHA)
selectIsKpiAlertOpenedByWidgetRef(ref)	(ALPHA)
selectListedDashboards(state)	(ALPHA) Select all listed dashboard in project.
selectRawExportOverridesForInsightByRef(ref)	(ALPHA) Selects raw export custom overrides for insight by ref.
selectShowWidgetAsTable(state)	(BETA)
selectTabById(tabId)	(ALPHA) Returns a specific tab by its identifier.
selectWidgetByRef(ref)	(ALPHA) Selects widget by its ref (including custom widgets).
selectWidgetCoordinatesByRef(ref)	(ALPHA) Selects layout coordinates for a given widget.
selectWidgetDrills(ref)	(ALPHA) Selects widget drills by the widget ref.
selectWidgetPathByRef(ref)	(ALPHA) Selects layout path for a given widget.
setAttributeFilterDependentDateFilters(filterLocalId, dependentDateFilters, correlationId)	(BETA) Creates the SetAttributeFilterDependentDateFilters command. Dispatching this command will result in setting a relationship between one dashboard attribute filters and one or more date filters. When an attribute filter has a dependent date filter set up, the attribute elements that will be available in the attribute filter will be influenced by the selection in the date filter. The attribute filter will show only those elements for which a link exists to the selected elements in the dependent date filter.
setAttributeFilterDisplayForm(filterLocalId, displayForm, isWorkingSelectionChange, isResultOfMigration)	(BETA) Creates the ISetAttributeFilterDisplayForm command.
setAttributeFilterLimitingItems(localIdentifier, limitingItems, correlationId)	(ALPHA) Creates the ISetAttributeFilterLimitingItems command.
setAttributeFilterParents(filterLocalId, parentFilters, correlationId)	(BETA) Creates the SetAttributeFilterParents command. Dispatching this command will result in setting a parent-child relationship between two or more dashboard attribute filters. When an attribute filter has a parent set up, the attribute elements that will be available in the child filter will be influenced by the selection in the parent. The child filter will show only those elements for which a link exists to the selected elements in the parent. Take for example a model where there are continent and country attributes. You add continent and country as filters onto a dashboard and establish parent-child relationship between them. When users select some continents in the filter, the country filter will only show elements for countries on the selected contents.
setAttributeFilterSelectionMode(filterLocalId, selectionMode)	(BETA) Creates the ISetAttributeFilterSelectionMode command.
setAttributeFilterTitle(filterLocalId, title, correlationId)	(BETA) Creates the ISetAttributeFilterTitle command.
setDashboardAttributeFilterConfigDisplayAsLabel(localIdentifier, displayAsLabel)	(ALPHA) Creates the ISetDashboardAttributeFilterConfigDisplayAsLabel command.
setDashboardAttributeFilterConfigMode(localIdentifier, mode)	(ALPHA) Creates the ISetDashboardAttributeFilterConfigMode command.
setDashboardDateFilterConfigMode(mode)	(ALPHA) Creates the ISetDashboardDateFilterConfigMode command.
setDashboardDateFilterWithDimensionConfigMode(dataSet, mode)	(ALPHA) Creates the ISetDashboardDateFilterWithDimensionConfigMode command.
setDateFilterConfigTitle(dataSet, title, correlationId)	(BETA) Creates the ISetDateFilterConfigTitle command.
setDrillForKpiWidget(ref, legacyDashboardRef, legacyDashboardTabIdentifier, correlationId)	(BETA) Creates the SetDrillForKpiWidget command. Dispatching this command will result in KPI having its drill set to the given value.
setExecutionResultData(id, executionResult, executionWarnings, correlationId)	(BETA) Creates an IUpsertExecutionResult command that makes the relevant execution result set new result data and stop loading.
setExecutionResultError(id, error, correlationId)	(BETA) Creates an IUpsertExecutionResult command that makes the relevant execution result indicate an error and stop loading.
setExecutionResultLoading(id, correlationId)	(BETA) Creates an IUpsertExecutionResult command that makes the relevant execution result indicate it is loading.
setFilterViewAsDefault(ref, isDefault, correlationId)	(ALPHA) Creates the ISetFilterViewAsDefault command.
setShowWidgetAsTable(ref, showAsTable)	(BETA) Command to set a widget to show as table.
ShareStatusIndicator({ shareStatus, isUnderStrictControl, })	(ALPHA)
showWidgetAsTableSet(ctx, ref, showAsTable, correlationId)	(BETA) Creates a new ShowWidgetAsTableSet event.
singleEventTypeHandler(type, handler)	Creates a DashboardEventHandler instance that will be invoked for one specified event type.
startRenamingDashboardTab(tabId, correlationId, shouldSelectTab)	(ALPHA) Creates the StartRenamingDashboardTab command.
switchDashboardTab(tabId, correlationId)	(ALPHA) Creates the SwitchDashboardTab command.
switchToEditRenderMode(correlationId)	(BETA) Creates the ChangeRenderMode command for switch to edit mode.
toggleLayoutDirection(layoutPath, direction, correlationId)	(ALPHA) Creates the ToggleLayoutDirection command.
toggleLayoutSectionHeaders(layoutPath, enableSectionHeaders, correlationId)	(ALPHA) Creates the ToggleLayoutSectionHeaders command.
triggerEvent(eventBody, correlationId)	(BETA) Creates an ITriggerEvent command.
undoLayoutChanges(undoPointSelector, correlationId)	(BETA) Creates the UndoLayoutChanges command.
unignoreDateFilterOnInsightWidget(ref, oneOrMoreDataSets, correlationId)	(BETA) Creates the ChangeInsightWidgetFilterSettings command for IFilterOpUnignoreDateFilter operation. Dispatching this command will result in removal of one or more filters from Insight widget's date filter ignore-list. Ignored date filters are not passed down to the insight and will not be used to filter that insight. The operation is idempotent - trying to unignore a date filter multiple times will have no effect.
unignoreDateFilterOnRichTextWidget(ref, oneOrMoreDataSets, correlationId)	(ALPHA) Creates the ChangeRichTextWidgetFilterSettings command for IFilterOpUnignoreDateFilter operation. Dispatching this command will result in removal of one or more filters from Rich Text widget's date filter ignore-list. Ignored date filters are not passed down to the metrics resolved in rich text references. The operation is idempotent - trying to unignore a date filter multiple times will have no effect.
unignoreFilterOnInsightWidget(ref, oneOrMoreDisplayForms, correlationId)	(BETA) Creates the ChangeInsightWidgetFilterSettings command for IFilterOpUnignoreAttributeFilter operation. Dispatching this command will result in removal of one or more filters from Insight widget's attribute filter ignore-list. Ignored attribute filters are not passed down to the insight and will not be used to filter that insight. The operation is idempotent - trying to unignore an attribute filter multiple times will have no effect.
unignoreFilterOnKpiWidget(ref, oneOrMoreDisplayForms, correlationId)	(BETA) Creates the ChangeKpiWidgetFilterSettings command for IFilterOpUnignoreAttributeFilter operation. Dispatching this command will result in removal of one or more filters from KPI widget's attribute filter ignore-list. Ignored attribute filters are not passed down to the KPI and will not be used to filter that KPI. The operation is idempotent - trying to unignore an attribute filter multiple times will have no effect.
unignoreFilterOnRichTextWidget(ref, oneOrMoreDisplayForms, correlationId)	(ALPHA) Creates the ChangeRichTextWidgetFilterSettings command for IFilterOpUnignoreAttributeFilter operation. Dispatching this command will result in removal of one or more filters from Rich Text widget's attribute filter ignore-list. Ignored attribute filters are not passed down to the metrics and will not be used to filter those metrics. The operation is idempotent - trying to unignore an attribute filter multiple times will have no effect.
updateVisualizationsFromSwitcherWidgetContent(ref, visualizations, correlationId)	(BETA) Creates the ChangeVisualizationsFromVisualizationSwitcherWidgetContent command. Dispatching this command will result in the update of visualization which form part of the visualization switcher widget.
useAutomationAvailableDashboardFilters()	(ALPHA) Hook to get filters that are available to be used for any automation. Filters are respecting current set dashboard filter context - Cross-filtering filters are omitted as they are not desired to be saved in the automation - If default dashboard filters has overrides, use them instead of the current dashboard filter context - If common date filter is not present in the dashboard filter context, add it
useCustomWidgetExecutionDataView({ enableExecutionCancelling, widget, execution, onCancel, onError, onLoading, onPending, onSuccess, })	This hook provides an easy way to read a data view from a custom widget. It resolves the appropriate filters for the widget based on the filters currently set on the whole dashboard.
useCustomWidgetInsightDataView({ widget, insight, enableExecutionCancelling, onCancel, onError, onLoading, onPending, onSuccess, })	This hook provides an easy way to read a data view for an insight from a custom widget. It resolves the appropriate filters for the widget based on the filters currently set on the whole dashboard.
useDashboardAlerts()	(ALPHA) Hook that handles alert dialogs.
useDashboardAlertsOld()	(ALPHA) Hook that handles alerts dialog
useDashboardAsyncRender(id)	A React hook that allows you to request and inform the dashboard about the rendering of a component that loads asynchronous data (eg Insight, Kpi, but it can be also any custom widget). By registering and resolving asynchronous data retrieval of the each widget, the dashboard is able to recognize and notify that it is fully rendered. This mechanism is necessary for dashboard exports to PDF to work properly. Mechanism is following: - You must request async rendering for at least 1 component within 5 seconds of the DashboardInitialized event. (If you do not register any asynchronous rendering, after 5 seconds the dashboard will announce that it is rendered by dispatching DashboardRenderResolved event.) - You can request async rendering for any number of components. Requests are valid if the first rule is met and not all asynchronous renderings have been resolved and the maximum timeout (20min by default) has not elapsed. - The component may again request asynchronous rendering within 5 seconds of resolution. Maximum 3x. (this is necessary to cover possible re-renders caused by data received from the components themselves, after they are rendered) - Maximum rendering time of the dashboard is 20min - if some asynchronous renderings are not yet resolved at this time, DashboardRenderResolved event is dispatched anyway. Request async rendering of the component by calling onRequestAsyncRender() callback. Resolve async rendering of the component by calling onResolveAsyncRender() callback.
useDashboardAutomations()	(ALPHA)
useDashboardDispatch()	(ALPHA)
useDashboardEventDispatch()	(ALPHA) Convenience hook for dispatching Dashboard events.
useDashboardEventsContext()	(ALPHA)
useDashboardExportData(renderMode, status, type)	(ALPHA)
useDashboardScheduledEmails()	(ALPHA) Hook that handles schedule emailing dialogs.
useDispatchDashboardCommand(commandCreator)	Hook that takes command creator and returns function that will result into dispatching this command.
useFilterBarProps()	(ALPHA)
useInsightWidgetDataView({ insightWidget, onCancel, onError, onLoading, onPending, onSuccess, })	This hook provides an easy way to read a data view from insight widget.
useMetaExportData()	(ALPHA)
useMetaExportImageData(type, loading, error)	(ALPHA)
useMetaPaletteData()	(ALPHA)
useParentFilters(filter, tabId)	Returns parent filtering input props for AttributeFilter() for particular dashboard attribute filter.
useRichTextExportData()	(ALPHA)
userInteractionTriggered(interactionPayloadOrType, correlationId)	(BETA) Creates the IDashboardUserInteractionTriggered event body.
useScheduledExportFilters({ scheduledExportToEdit, widget, insight, })	(ALPHA) Returns filters for scheduled export. If scheduledExportToEdit is provided, it returns its saved filters as is. If scheduledExportToEdit is not provided, it returns sanitized filters ready to be saved in new scheduled export.
useSectionDescriptionExportData(exportData, loading, error)	(ALPHA)
useSectionExportData(depth)	(ALPHA)
useTopBarProps()	(ALPHA)
useVisualizationExportData(widget, loading, error)	(ALPHA)
useWidgetAlertFilters({ alertToEdit, widget, insight, })	(ALPHA) Hook for getting filters for widget alert. Note: - In case of existing widget alert, it returns the saved filters from the widget alert. - Otherwise, it returns the filters ready to be saved in new widget alert, sanitized according to the following rules: - Cross-filtering filters are excluded as they are typically not desired in the widget alert. - The widget's ignored filters configuration is honored.
useWidgetExportData(widget)	(ALPHA)
useWidgetFilters(widget, insight)	Hook for obtaining the effective filters for a widget.
useWidgetScheduledExportFilters({ scheduledExportToEdit, widget, insight, })	(ALPHA) Returns filters for widget scheduled export. In case of existing scheduled export, it returns the saved filters from the scheduled export. - Otherwise, it returns the filters ready to be saved in new scheduled export, sanitized according to the following rules: - Cross-filtering filters are excluded as they are typically not desired in the scheduled export. - The widget's ignored filters configuration is honored.

Interfaces

Interface	Description
IAccessibleDashboardsState	(ALPHA)
IAddAttributeFilter	(BETA)
IAddDateFilter	(ALPHA)
IAddDateFilterPayload	(ALPHA) Payload of the IAddDateFilter command.
IAddDrillDownForInsightWidget	(ALPHA)
IAddDrillDownForInsightWidgetPayload	(ALPHA) Payload of the IAddDrillDownForInsightWidget command.
IAddDrillTargets	(ALPHA) Add widget drill targets
IAddDrillTargetsPayload	(ALPHA) Payload of the IAddDrillTargets command.
IAddLayoutSection	(BETA)
IAddLayoutSectionPayload	(BETA) Payload of the IAddLayoutSection command.
IAddSectionItems	(BETA)
IAddSectionItemsPayload	(BETA) Payload of the IAddSectionItems command.
IAddVisualizationToVisualizationSwitcherWidgetContent	(BETA)
IAddVisualizationToVisualizationSwitcherWidgetContentPayload	(BETA) Payload of the IAddVisualizationToVisualizationSwitcherWidgetContent command.
IAlertingDialogOldProps	(ALPHA)
IAlertingDialogProps	(ALPHA)
IAlertingManagementDialogOldProps	(ALPHA)
IAlertingManagementDialogProps	(ALPHA)
IApplyFilterContextWorkingSelection	(ALPHA) Command for applying all working filters staged for application. Usually used with setting dashboardApplyFiltersMode: ALL_AT_ONCE
IApplyFilterView	(ALPHA) Command for application of a saved filter view.
IApplyFilterViewPayload	(ALPHA) Payload of the IApplyFilterView command.
IAttributeFilterConfigsState	(ALPHA)
IAttributeFiltersCustomizer	Set of functions you can use to customize how attribute filters are rendered.
IAttributeHierarchyModified	(BETA)
IAutomationFiltersTab	(ALPHA) Automation filters grouped by tab.
IAutomationsState	(ALPHA)
IBareUserInteractionPayload	(BETA)
IBrokenAlertFilterBasicInfo	(ALPHA) Information about the broken alert filters. These are filters that are set up on the alert, but the currently applied filters either do not contain them, or the KPI has started ignoring them since the alert was first set up.
IButtonBarProps	(BETA)
ICancelButtonProps	(BETA)
ICancelRenamingDashboardTab	(ALPHA) Command to cancel renaming mode for a tab.
ICancelRenamingDashboardTabPayload	(ALPHA) Payload of the ICancelRenamingDashboardTab command.
IChangeDrillableItems	(ALPHA)
IChangeDrillableItemsPayload	(ALPHA) Payload of the IChangeDrillableItems command.
IChangeIgnoreExecutionTimestamp	(ALPHA) Command for changing the ignore logic of execution timestamp. When executionTimestamp is provided to the dashboard, each execution is using this timestamp. This command instructs the application to change the ignore flag for the execution timestamp in all following executions.
IChangeIgnoreExecutionTimestampPayload	(ALPHA) Payload of the IChangeIgnoreExecutionTimestamp command.
IChangeInsightWidgetDescription	(BETA)
IChangeInsightWidgetDescriptionPayload	(BETA) Payload of the IChangeInsightWidgetDescription command.
IChangeInsightWidgetFilterSettings	(BETA)
IChangeInsightWidgetFilterSettingsPayload	(BETA) Payload of the IChangeInsightWidgetFilterSettings command.
IChangeInsightWidgetHeader	(BETA)
IChangeInsightWidgetHeaderPayload	(BETA) Payload of the IChangeInsightWidgetHeader command.
IChangeInsightWidgetIgnoreCrossFiltering	(ALPHA)
IChangeInsightWidgetIgnoreCrossFilteringPayload	(ALPHA) Payload of the IChangeInsightWidgetIgnoreCrossFiltering command.
IChangeInsightWidgetInsight	(BETA) XXX: don't think this is needed right away. should definitely allow such flexibility though. Would allow to switch between insights that are of different vis type but show same data.
IChangeInsightWidgetInsightPayload	(BETA) Payload of the IChangeInsightWidgetInsight command.
IChangeInsightWidgetVisProperties	(BETA)
IChangeInsightWidgetVisPropertiesPayload	(BETA) Payload of the IChangeInsightWidgetVisProperties command.
IChangeKpiWidgetComparison	(BETA)
IChangeKpiWidgetComparisonPayload	(BETA) Payload of the IChangeKpiWidgetComparison command.
IChangeKpiWidgetConfiguration	(BETA)
IChangeKpiWidgetConfigurationPayload	(BETA) Payload of the IChangeKpiWidgetConfiguration command.
IChangeKpiWidgetDescription	(BETA)
IChangeKpiWidgetDescriptionPayload	(BETA) Payload of the IChangeKpiWidgetDescription command.
IChangeKpiWidgetFilterSettings	(BETA)
IChangeKpiWidgetFilterSettingsPayload	(BETA) Payload of the IChangeKpiWidgetFilterSettings command.
IChangeKpiWidgetHeader	(BETA)
IChangeKpiWidgetHeaderPayload	(BETA) Payload of the IChangeKpiWidgetHeader command.
IChangeKpiWidgetMeasure	(BETA)
IChangeKpiWidgetMeasurePayload	(BETA) Payload of the IChangeKpiWidgetMeasure command.
IChangeRenderMode	(BETA)
IChangeRenderModePayload	(BETA) Payload of the IChangeRenderMode command.
IChangeRichTextWidgetContent	(BETA)
IChangeRichTextWidgetContentPayload	(BETA) Payload of the IChangeRichTextWidgetContent command.
IChangeRichTextWidgetFilterSettings	(BETA)
IChangeRichTextWidgetFilterSettingsPayload	(BETA) Payload of the IChangeRichTextWidgetFilterSettings command.
IChangeSharing	(BETA)
IChangeSharingPayload	(BETA) Payload of the IChangeSharing command.
IConvertDashboardTabFromDefault	(ALPHA) Command to convert a default dashboard tab into a regular tab.
IConvertDashboardTabFromDefaultPayload	(ALPHA) Payload of the IConvertDashboardTabFromDefault command.
ICreateAlert	(BETA) Creates alert.
ICreateAlertPayload	(BETA) Payload of the ICreateAlert command.
ICreateDashboardTab	(ALPHA) Command to create a new dashboard tab.
ICreateDashboardTabPayload	(ALPHA) Payload of the ICreateDashboardTab command.
ICreateScheduledEmail	(BETA) Creates scheduled email.
ICreateScheduledEmailPayload	(BETA) Payload of the ICreateScheduledEmail command.
ICrossFiltering	(BETA)
ICrossFilteringItem	(BETA)
ICrossFilteringPayload	(BETA) Payload of the ICrossFiltering command.
ICsvExportConfig	(BETA)
ICustomDashboardEvent	Base type for all custom events.
ICustomWidget	Custom widget with assigned identity.
ICustomWidgetBase	Base type for custom widgets. Custom widgets may extend this and add extra properties to hold widget-specific configuration.
ICustomWidgetDefinition	Definition of custom widget. The definition may not specify identity. In that case a temporary identity will be assigned to the widget as it is added onto a dashboard.
IDashboardAlertCreated	(BETA) This event is emitted after the alert is successfully saved.
IDashboardAlertCreatedPayload	(BETA) Payload of the IDashboardAlertCreated event.
IDashboardAlertSaved	(BETA) This event is emitted after the alert is saved.
IDashboardAlertSavedPayload	(BETA) Payload of the IDashboardAlertCreated event.
IDashboardAttributeFilterAdded	(BETA) This event is emitted after a new dashboard attribute filter is successfully added into dashboard's filters.
IDashboardAttributeFilterAddedPayload	(BETA) Payload of the IDashboardAttributeFilterAdded event.
IDashboardAttributeFilterConfigLimitingItemsChanged	(ALPHA) This event is emitted when the attribute filter limiting items are changed.
IDashboardAttributeFilterConfigLimitingItemsChangedPayload	(ALPHA) Payload of the isDashboardAttributeFilterConfigLimitingItemsChanged() event.
IDashboardAttributeFilterConfigModeChanged	(ALPHA) This event is emitted when the attribute filter mode is change.
IDashboardAttributeFilterConfigModeChangedPayload	(ALPHA) Payload of the isDashboardAttributeFilterConfigModeChanged() event.
IDashboardAttributeFilterMoved	(BETA) This event is emitted after a dashboard attribute filter is moved from one position in the filter bar to a new position
IDashboardAttributeFilterMovedPayload	(BETA) Payload of the IDashboardAttributeFilterMoved event.
IDashboardAttributeFilterParentChanged	(BETA) This event is emitted after the parent relationships of a filter change.
IDashboardAttributeFilterParentChangedPayload	(BETA) Payload of the IDashboardAttributeFilterParentChanged event.
IDashboardAttributeFilterProps
IDashboardAttributeFilterRemoved	(BETA) This event is emitted after a dashboard attribute filter is successfully removed. If the removed filter figured as a parent to one or more child filters, then the removal also cleaned up the parent relationship.
IDashboardAttributeFilterRemovedPayload	(BETA) Payload of the IDashboardAttributeFilterRemoved event.
IDashboardAttributeSelectionModeChanged	(BETA) This event is emitted when the attribute filter selection mode is change.
IDashboardAttributeSelectionModeChangedPayload	(BETA) Payload of the IDashboardAttributeSelectionModeChanged event.
IDashboardAttributeTitleChanged	(BETA) This event is emitted when the attribute filter title change.
IDashboardAttributeTitleChangedPayload	(BETA) Payload of the IDashboardAttributeTitleChanged event.
IDashboardAutomationsRefreshed	(BETA) This event is emitted after the automations are refreshed (after creating, updating, or removing alerts or scheduled exports).
IDashboardBaseProps
IDashboardCommand	Base type for all commands.
IDashboardCommandFailed	(BETA) This event is emitted if a particular command processing fails. The failure may be for two general reasons: A user error was made; dispatched command is found to have bad payload or the dispatched command is not applicable in the current state of the dashboard An internal error has occurred in the dashboard component - highly likely due to a bug.
IDashboardCommandFailedPayload	(BETA) Payload of the IDashboardCommandFailed event.
IDashboardCommandRejected	(BETA) This event is emitted when the submitted command has been rejected by the dashboard component because it does not know how to handle the command. This typically indicates user error, perhaps a typo in the command type name.
IDashboardCommandStarted	(BETA) This event is emitted when a particular command processing starts.
IDashboardCommandStartedPayload	(BETA) Payload of the IDashboardCommandStarted event.
IDashboardContentCustomizer	(ALPHA)
IDashboardCrossFilteringRequested	(BETA) This event is emitted on start of the resolution of the ICrossFiltering command.
IDashboardCrossFilteringRequestedPayload	(BETA) Payload of the IDashboardCrossFilteringRequested event.
IDashboardCrossFilteringResolved	(BETA) This event is emitted as a result of the ICrossFiltering command.
IDashboardCrossFilteringResolvedPayload	(BETA) Payload of the IDashboardCrossFilteringResolved event.
IDashboardCustomComponentProps	These props allow you to specify custom components or custom component providers that the Dashboard component will use for rendering different parts of the dashboard.
IDashboardCustomizationProps	Properties for Dashboard() customization.
IDashboardCustomizer
IDashboardDateFilterConfig	Defines the configuration of the DateFilter component.
IDashboardDateFilterProps
IDashboardDeleted	(BETA) This event is emitted at the end of successful 'dashboard delete' command processing. At this point, the dashboard no longer exist on the backend and the component are reset to a state when it shows an empty dashboard.
IDashboardDeletedPayload	(BETA) Payload of the IDashboardDeleted event.
IDashboardDrillableItemsChanged	(ALPHA) This event is emitted as a result of the IChangeDrillableItems command, if drillable items was successfully changed.
IDashboardDrillableItemsChangedPayload	(ALPHA) Payload of the IDashboardDrillableItemsChanged event.
IDashboardDrillContext	(ALPHA)
IDashboardDrillDownRequested	(ALPHA) This event is emitted on start of the resolution of the IDrillDown command. It contains the target insight to apply the drill-down on (result of the drill-down application depends on the particular visualization type).
IDashboardDrillDownRequestedPayload	(ALPHA) Payload of the IDashboardDrillDownRequested event.
IDashboardDrillDownResolved	(ALPHA) This event is emitted as a result of the IDrillDown command. It contains the target insight with the drill-down definition applied (result of the drill-down application depends on the particular visualization type). In the default dashboard implementation this event also opens drill dialog with the insight that has this particular drill down definition applied.
IDashboardDrillDownResolvedPayload	(ALPHA) Payload of the IDashboardDrillDownResolved event.
IDashboardDrillEvent	(BETA) A IDrillEvent with added information about the drill event specific to the Dashboard context.
IDashboardDrillRequested	(ALPHA) This event is emitted on start of the resolution of the IDrill command. It contains details about all possible drill definitions that are available for this particular drill interaction
IDashboardDrillRequestedPayload	(ALPHA) Payload of the IDashboardDrillRequested event.
IDashboardDrillResolved	(ALPHA) A general drill event that is emitted each time any dashboard drill is resolved. It contains only valid drillDefinitions for this particular drill interaction, so you can select and dispatch relevant more granular drill command(s). This is general dashboard drill event with details about all possible more granular drill interactions that can follow. Reason for this general drill event is that it may happen that multiple drill interactions are possible for one drill event. Example: some attribute on the insight has drilled down set and also widget has drilled to insight set. Then this event will be dispatched with both and definitions. This must be always the first event that occurs after the drill interaction, and must be dispatched before more granular drill events. - Specific drill commands that can follow this general drill event are: IDrillDown, IDrillToInsight, IDrillToDashboard, IDrillToCustomUrl, IDrillToAttributeUrl, IDrillToLegacyDashboard
IDashboardDrillResolvedPayload	(ALPHA) Payload of the IDashboardDrillResolved event.
IDashboardDrillToAttributeUrlRequested	(ALPHA) This event is emitted on start of the resolution of the IDrillToAttributeUrl command.
IDashboardDrillToAttributeUrlRequestedPayload	(ALPHA) Payload of the IDashboardDrillToAttributeUrlRequested event.
IDashboardDrillToAttributeUrlResolved	(ALPHA) This event is emitted as a result of the IDrillToAttributeUrl command. It contains resolved attribute url from the drill definition.
IDashboardDrillToAttributeUrlResolvedPayload	(ALPHA) Payload of the IDashboardDrillToAttributeUrlResolved event.
IDashboardDrillToCustomUrlRequested	(ALPHA) This event is emitted on start of the resolution of the IDrillToCustomUrl command.
IDashboardDrillToCustomUrlRequestedPayload	(ALPHA) Payload of the IDashboardDrillToCustomUrlRequested event.
IDashboardDrillToCustomUrlResolved	(ALPHA) This event is emitted as a result of the IDrillToCustomUrl command. It contains resolved custom url from the drill definition.
IDashboardDrillToCustomUrlResolvedPayload	(ALPHA) Payload of the IDashboardDrillToCustomUrlResolved event.
IDashboardDrillToDashboardRequested	(ALPHA) This event is emitted on start of the resolution of the IDrillToDashboard command.
IDashboardDrillToDashboardRequestedPayload	(ALPHA) Payload of the IDashboardDrillToDashboardRequested event.
IDashboardDrillToDashboardResolved	(ALPHA) This event is emitted as a result of the IDrillToDashboard command. It contains the drill intersection filters that can be applied to the target dashboard. There is a factory function to create default event handler for drill to same dashboard - see newDrillToSameDashboardHandler().
IDashboardDrillToDashboardResolvedPayload	(ALPHA) Payload of the IDashboardDrillToDashboardResolved event.
IDashboardDrillToInsightRequested	(ALPHA) This event is emitted on start of the resolution of the IDrillToInsight command. It contains the target insight to apply drill intersection filters on.
IDashboardDrillToInsightRequestedPayload	(ALPHA) Payload of the IDashboardDrillToInsightRequested event.
IDashboardDrillToInsightResolved	(ALPHA) This event is emitted as a result of the IDrillToInsight command. It contains the target insight with the drill intersection filters applied. In the default dashboard implementation this event also opens drill dialog with the insight that has the drill intersection filters applied.
IDashboardDrillToInsightResolvedPayload	(ALPHA) Payload of the IDashboardDrillToInsightResolved event.
IDashboardDrillToLegacyDashboardRequested	(ALPHA) This event is emitted on start of the resolution of the IDrillToLegacyDashboard command.
IDashboardDrillToLegacyDashboardRequestedPayload	(ALPHA) Payload of the IDashboardDrillToLegacyDashboardRequested event.
IDashboardDrillToLegacyDashboardResolved	(ALPHA) This event is emitted as a result of the IDrillToLegacyDashboard command. Drill to legacy dashboard can be configured for Kpi widgets only.
IDashboardDrillToLegacyDashboardResolvedPayload	(ALPHA) Payload of the IDashboardDrillToLegacyDashboardResolved event.
IDashboardEngine	Dashboard Engine encapsulates a particular build of the Dashboard() component and provides factory methods to create the Dashboard component's customization-related props using one or more plugins.
IDashboardEvent	Base type for all dashboard events.
IDashboardEventHandling	Defines a facade that you can use to register or unregister dashboard event handlers.
IDashboardEventing	Dashboard() eventing configuration
IDashboardEventsContext	(ALPHA)
IDashboardExportSlideConfig	(ALPHA) Specifies the size of the slide where visualization will be fit and rendered.
IDashboardExportToExcelRequested	(BETA) This event is emitted at the start of the 'dashboard export to Excel' command processing.
IDashboardExportToExcelResolved	(BETA) This event is emitted at the end of successful 'dashboard export to Excel' command processing. In its payload, there is a uri of the resulting XLS file.
IDashboardExportToExcelResolvedPayload	(BETA) Payload of the IDashboardExportToExcelResolved event.
IDashboardExportToImageRequested	(BETA) This event is emitted at the start of the 'dashboard export to image' command processing.
IDashboardExportToImageResolved	(BETA) This event is emitted at the end of successful 'dashboard export to image' command processing. In its payload, there is a uri of the resulting image file.
IDashboardExportToImageResolvedPayload	(BETA) Payload of the IDashboardExportToPptPresentationResolved event.
IDashboardExportToPdfPresentationRequested	(BETA) This event is emitted at the start of the 'dashboard export to PDF presentation' command processing.
IDashboardExportToPdfPresentationResolved	(BETA) This event is emitted at the end of successful 'dashboard export to PDF presentation' command processing. In its payload, there is a uri of the resulting PDF file.
IDashboardExportToPdfPresentationResolvedPayload	(BETA) Payload of the IDashboardExportToPdfPresentationResolved event.
IDashboardExportToPdfRequested	(BETA) This event is emitted at the start of the 'dashboard export to PDF' command processing.
IDashboardExportToPdfResolved	(BETA) This event is emitted at the end of successful 'dashboard export to PDF' command processing. In its payload, there is a uri of the resulting PDF file.
IDashboardExportToPdfResolvedPayload	(BETA) Payload of the IDashboardExportToPdfResolved event.
IDashboardExportToPptPresentationRequested	(BETA) This event is emitted at the start of the 'dashboard export to PPT presentation' command processing.
IDashboardExportToPptPresentationResolved	(BETA) This event is emitted at the end of successful 'dashboard export to PPT presentation' command processing. In its payload, there is a uri of the resulting PDF file.
IDashboardExportToPptPresentationResolvedPayload	(BETA) Payload of the IDashboardExportToPptPresentationResolved event.
IDashboardExtensionProps	Cumulative properties for Dashboard() customization.
IDashboardFilterContextSelectionReset	(ALPHA) This event is emitted after dashboard selection filters have been reset.
IDashboardFilterViewApplicationFailed	(ALPHA) This event is emitted after a dashboard filter view application failed.
IDashboardFilterViewApplicationSucceeded	(ALPHA) This event is emitted after a dashboard filter view is successfully applied.
IDashboardFilterViewApplicationSucceededPayload	(ALPHA) Payload of the IDashboardFilterViewApplicationSucceeded event.
IDashboardFilterViewCreationFailed	(ALPHA) This event is emitted after a new dashboard filter view creation failed.
IDashboardFilterViewCreationSucceeded	(ALPHA) This event is emitted after a new dashboard filter view is successfully created.
IDashboardFilterViewCreationSucceededPayload	(ALPHA) Payload of the IDashboardFilterViewCreationSucceeded event.
IDashboardFilterViewDefaultStatusChangeFailed	(ALPHA) This event is emitted after a dashboard filter view default status change failed.
IDashboardFilterViewDefaultStatusChangeFailedPayload	(ALPHA) Payload of the IDashboardFilterViewDefaultStatusChangeFailed event.
IDashboardFilterViewDefaultStatusChangeSucceeded	(ALPHA) This event is emitted after a dashboard filter view default status is successfully changed. See the enclosed filterView object in the payload to check its new status.
IDashboardFilterViewDefaultStatusChangeSucceededPayload	(ALPHA) Payload of the IDashboardFilterViewDefaultStatusChangeSucceeded event.
IDashboardFilterViewDeletionFailed	(ALPHA) This event is emitted after a dashboard filter view deletion failed.
IDashboardFilterViewDeletionSucceeded	(ALPHA) This event is emitted after a dashboard filter view is successfully deleted.
IDashboardFilterViewDeletionSucceededPayload	(ALPHA) Payload of the IDashboardFilterViewDeletionSucceeded event.
IDashboardFocusObject	(BETA) Specifies the focus object for the dashboard.
IDashboardIgnoreExecutionTimestampChanged	(ALPHA) This event is emitted at the end of successful 'change ignore execution timestamp' command processing. When executionTimestamp is provided to the dashboard, each execution is using this timestamp. This event instructs the application to react on the ignore flag for execution timestamp in all following executions.
IDashboardIgnoreExecutionTimestampChangedPayload	(ALPHA) Payload of the IDashboardIgnoreExecutionTimestampChanged event.
IDashboardInsightCustomizer	Set of functions you can use to customize how insights are rendered.
IDashboardInsightMenuButtonProps	(ALPHA)
IDashboardInsightMenuProps	(ALPHA)
IDashboardInsightProps	Insight widget props.
IDashboardInsightWidgetChanged	(BETA) This event is emitted after any change to Insight Widget configuration. It contains the entire new state of the Insight Widget.
IDashboardInsightWidgetChangedPayload	(BETA) Payload of the IDashboardInsightWidgetChanged event.
IDashboardInsightWidgetDescriptionChanged	(BETA) This event is emitted when the description of an insight widget changed. The new value of the description (summary) is included in the event.
IDashboardInsightWidgetDescriptionChangedPayload	(BETA) Payload of the IDashboardInsightWidgetDescriptionChanged event.
IDashboardInsightWidgetDrillsModified	(BETA) This event is emitted when the insight widget's drill definitions change. The change may include addition or change of drill definition for one or more drillable measures.
IDashboardInsightWidgetDrillsModifiedPayload	(BETA) Payload of the IDashboardInsightWidgetDrillsModified event.
IDashboardInsightWidgetDrillsRemoved	(BETA) This event is emitted when the insight widget's drill definitions are removed. The measures for which the drill definitions were set up will no longer be clickable.
IDashboardInsightWidgetDrillsRemovedPayload	(BETA) Payload of the IDashboardInsightWidgetDrillsRemoved event.
IDashboardInsightWidgetExportRequested	(BETA) This event is emitted after export of an insight widget is requested.
IDashboardInsightWidgetExportRequestedPayload	(BETA) Payload of the IDashboardInsightWidgetExportRequested event.
IDashboardInsightWidgetExportResolved	(BETA) This event is emitted after export of an insight widget is resolved.
IDashboardInsightWidgetExportResolvedPayload	(BETA) Payload of the IDashboardInsightWidgetExportResolved event.
IDashboardInsightWidgetFilterSettingsChanged	(BETA) This event is emitted when the insight widget's filter settings change. Filter settings influence what date dataset to use for filter or which of the dashboard's attribute filters should be used for the widget. A change of filter settings means the insight rendered in the widget will be re-rendered.
IDashboardInsightWidgetFilterSettingsChangedPayload	(BETA) Payload of the IDashboardInsightWidgetFilterSettingsChanged event.
IDashboardInsightWidgetHeaderChanged	(BETA) This event is emitted when the header of an insight widget changed. The new value of the header (title) is included in the event.
IDashboardInsightWidgetHeaderChangedPayload	(BETA) Payload of the IDashboardInsightWidgetHeaderChanged event.
IDashboardInsightWidgetInsightSwitched	(BETA) This event is emitted when the insight rendered inside an insight widget gets switched for another one. That essentially means the insight widget now renders a different visualization
IDashboardInsightWidgetInsightSwitchedPayload	(BETA) Payload of the IDashboardInsightWidgetInsightSwitched event.
IDashboardInsightWidgetRefreshed	(BETA) This event is emitted after an insight widget is refreshed.
IDashboardInsightWidgetRefreshedPayload	(BETA) Payload of the IDashboardInsightWidgetRefreshed event.
IDashboardInsightWidgetVisConfigurationChanged	(BETA) This event is emitted when the insight widget's visualization configuration change. The configuration specified influence how the insight rendered in the widget appears visually
IDashboardInsightWidgetVisConfigurationChangedPayload	(BETA) Payload of the IDashboardInsightWidgetVisPropertiesChanged event.
IDashboardInsightWidgetVisPropertiesChanged	(BETA) This event is emitted when the insight widget's visualization properties change. The properties specified influence how the insight rendered in the widget appears visually (legend, tooltips, axes, etc.)
IDashboardInsightWidgetVisPropertiesChangedPayload	(BETA) Payload of the IDashboardInsightWidgetVisPropertiesChanged event.
IDashboardKeyDriverAnalysisRequested	(BETA) This event is emitted on start of the resolution of the IKeyDriverAnalysis command.
IDashboardKeyDriverAnalysisRequestedPayload	(BETA) Payload of the IDashboardKeyDriverAnalysisRequested event.
IDashboardKeyDriverAnalysisResolved	(BETA) This event is emitted as a result of the IKeyDriverAnalysis command.
IDashboardKeyDriverAnalysisResolvedPayload	(BETA) Payload of the IDashboardKeyDriverAnalysisResolved event.
IDashboardKpiWidgetChanged	(BETA) This event is emitted after any change to KPI Widget configuration. It contains the entire new state of the KPI Widget.
IDashboardKpiWidgetChangedPayload	(BETA) Payload of the IDashboardKpiWidgetChanged event.
IDashboardKpiWidgetComparisonChanged	(BETA) This event is emitted when dashboard's KPI Widget has its comparison type changed. The event includes the new definition of the KPI that has uses same measure as before however has new setup of the over-time comparison.
IDashboardKpiWidgetComparisonChangedPayload	(BETA) Payload of the IDashboardKpiWidgetComparisonChanged event.
IDashboardKpiWidgetConfigurationChanged	(BETA) This event is emitted when the dashboard's KPI Widget configuration is modified.
IDashboardKpiWidgetConfigurationChangedPayload	(BETA) Payload of the IDashboardKpiWidgetConfigurationChanged event.
IDashboardKpiWidgetDescriptionChanged	(BETA) This event is emitted when the dashboard's KPI Widget description is modified.
IDashboardKpiWidgetDescriptionChangedPayload	(BETA) Payload of the IDashboardKpiWidgetDescriptionChanged event.
IDashboardKpiWidgetDrillRemoved	(BETA) This event is emitted when dashboard's KPI Widget has its drills removed.
IDashboardKpiWidgetDrillRemovedPayload	(BETA) Payload of the IDashboardKpiWidgetDrillRemoved event.
IDashboardKpiWidgetDrillSet	(BETA) This event is emitted when dashboard's KPI Widget has its drill set.
IDashboardKpiWidgetDrillSetPayload	(BETA) Payload of the IDashboardKpiWidgetDrillSet event.
IDashboardKpiWidgetFilterSettingsChanged	(BETA) This event is emitted when dashboard's KPI Widget filter settings are modified.
IDashboardKpiWidgetFilterSettingsChangedPayload	(BETA) Payload of the IDashboardKpiWidgetFilterSettingsChanged event.
IDashboardKpiWidgetHeaderChanged	(BETA) This event is emitted when the dashboard's KPI Widget header is modified.
IDashboardKpiWidgetHeaderChangedPayload	(BETA) Payload of the IDashboardKpiWidgetHeaderChanged event.
IDashboardKpiWidgetMeasureChanged	(BETA) This event is emitted when the dashboard's KPI Widget measure is modified - the KPI now shows value for different measure. The change of measure to use may be accompanied by a change of the KPI header (change of title). In that case new value of header is also included in the event.
IDashboardKpiWidgetMeasureChangedPayload	(BETA) Payload of the IDashboardKpiWidgetMeasureChanged event.
IDashboardLayoutChanged	(BETA) This event is emitted after any change to the dashboard layout and will include the entire new layout.
IDashboardLayoutChangedPayload	(BETA) Payload of the IDashboardLayoutChanged event.
IDashboardLayoutCustomizer	Set of functions you can use to customize the layout of the dashboard rendered.
IDashboardLayoutProps	(ALPHA)
IDashboardLayoutSectionAdded	(BETA) This event is emitted when a new dashboard layout section is added.
IDashboardLayoutSectionAddedPayload	(BETA) Payload of the IDashboardLayoutSectionAdded event.
IDashboardLayoutSectionHeaderChanged	(BETA) This event is emitted when dashboard layout section changes.
IDashboardLayoutSectionHeaderChangedPayload	(BETA) Payload of the IDashboardLayoutSectionHeaderChanged event.
IDashboardLayoutSectionItemMoved	(BETA) This event is emitted when a dashboard item is moved between sections or within a section.
IDashboardLayoutSectionItemMovedPayload	(BETA) Payload of the IDashboardLayoutSectionItemMoved event.
IDashboardLayoutSectionItemMovedToNewSection	(BETA) This event is emitted when a dashboard item is moved to new section.
IDashboardLayoutSectionItemMovedToNewSectionPayload	(BETA) Payload of the IDashboardLayoutSectionItemMovedToNewSection event.
IDashboardLayoutSectionItemRemoved	(BETA) This event is emitted when an item is removed from dashboard layout section.
IDashboardLayoutSectionItemRemovedPayload	(BETA) Payload of the IDashboardLayoutSectionItemRemoved event.
IDashboardLayoutSectionItemReplaced	(BETA) This event is emitted when an item in a dashboard section is replaced.
IDashboardLayoutSectionItemReplacedPayload	(BETA) Payload of the IDashboardLayoutSectionItemReplaced event.
IDashboardLayoutSectionItemsAdded	(BETA) This event is emitted when items are added to a dashboard section.
IDashboardLayoutSectionItemsAddedPayload	(BETA) Payload of the IDashboardLayoutSectionItemsAdded event.
IDashboardLayoutSectionMoved	(BETA) This event is emitted when a dashboard layout section is moved from one place to another.
IDashboardLayoutSectionMovedPayload	(BETA) Payload of the IDashboardLayoutSectionMoved event.
IDashboardLayoutSectionRemoved	(BETA) This event is emitted when a dashboard layout section is removed from the layout. Note: this event will be emitted also when the section is removed as part of eager removal of its items. E.g. item is removed, it is last item in the section, and the whole section is removed as well.
IDashboardLayoutSectionRemovedPayload	(BETA) Payload of the IDashboardLayoutSectionRemoved event.
IDashboardMetaState	(BETA)
IDashboardProps
IDashboardQuery	(BETA) Base type for all dashboard queries. A dashboard query encapsulates how complex, read-only dashboard-specific logic can be can be executed.
IDashboardQueryCompleted	(BETA) This event is emitted when query processing completes with success. Both the query payload and the result are included.
IDashboardQueryCompletedPayload	(BETA) Payload of the IDashboardQueryCompleted event.
IDashboardQueryFailed	(BETA) This event is emitted if a particular query processing fails. The failure may be for two general reasons: A user error was made; dispatched query is found to have bad payload or the dispatched query is not applicable in the current state of the dashboard An internal error has occurred in the dashboard component - highly likely due to a bug.
IDashboardQueryFailedPayload	(BETA) Payload of the IDashboardQueryFailed event.
IDashboardQueryRejected	(BETA) This event is emitted when the submitted query has been rejected by the dashboard component because it does not know how to handle the query.
IDashboardQueryStarted	(BETA) This event is emitted when query processing starts.
IDashboardQueryStartedPayload	(BETA) Payload of the IDashboardQueryStarted event.
IDashboardRenamed	(BETA) This event is emitted at the end of successful 'dashboard rename' command processing. At this point, only the in-memory title is changed and the changes are not saved on the backend.
IDashboardRenamedPayload	(BETA) Payload of the IDashboardRenamed event.
IDashboardRenderModeChanged	(BETA) This event is emitted after render mode change.
IDashboardRenderModeChangedPayload	(BETA) Payload of the IDashboardRenderModeChanged event.
IDashboardRichTextMenuButtonProps	(ALPHA)
IDashboardRichTextMenuProps	(ALPHA)
IDashboardRichTextProps	Rich text widget props.
IDashboardRichTextWidgetContentChanged	(BETA) This event is emitted when the dashboard's rich text widget content is changed.
IDashboardRichTextWidgetContentChangedPayload	(BETA) Payload of the IDashboardRichTextWidgetContentChanged event.
IDashboardRichTextWidgetFilterSettingsChanged	(BETA) This event is emitted when the RichText widget's filter settings change. Filter settings influence what date dataset to use for filter or which of the dashboard's attribute filters should be used for the widget. A change of filter settings means the RichText rendered in the widget will be re-rendered.
IDashboardRichTextWidgetFilterSettingsChangedPayload	(BETA) Payload of the IDashboardRichTextWidgetFilterSettingsChanged event.
IDashboardScheduledEmailCreated	(BETA) This event is emitted after the scheduled email is successfully created.
IDashboardScheduledEmailCreatedPayload	(BETA) Payload of the IDashboardScheduledEmailCreated event.
IDashboardScheduledEmailSaved	(BETA) This event is emitted after the scheduled email is successfully saved.
IDashboardSettingsApplyPayload	(ALPHA)
IDashboardSettingsDialogProps	(ALPHA)
IDashboardTabConvertedFromDefault	(ALPHA) This event is emitted when a default dashboard tab is converted to a regular tab.
IDashboardTabConvertedFromDefaultPayload	(ALPHA) Payload of the IDashboardTabConvertedFromDefault event.
IDashboardTabCreated	(ALPHA) This event is emitted when a dashboard tab is created.
IDashboardTabCreatedPayload	(ALPHA) Payload of the IDashboardTabCreated event.
IDashboardTabDeleted	(ALPHA) This event is emitted when a dashboard tab is deleted.
IDashboardTabDeletedPayload	(ALPHA) Payload of the IDashboardTabDeleted event.
IDashboardTabRenamed	(ALPHA) This event is emitted when a dashboard tab is renamed.
IDashboardTabRenamedPayload	(ALPHA) Payload of the IDashboardTabRenamed event.
IDashboardTabRenamingCanceled	(ALPHA) This event is emitted when renaming mode is canceled for a dashboard tab.
IDashboardTabRenamingCanceledPayload	(ALPHA) Payload of the IDashboardTabRenamingCanceled event.
IDashboardTabRenamingStarted	(ALPHA) This event is emitted when renaming mode is started for a dashboard tab.
IDashboardTabRenamingStartedPayload	(ALPHA) Payload of the IDashboardTabRenamingStarted event.
IDashboardTabSwitched	(ALPHA) This event is emitted when the active dashboard tab is switched.
IDashboardTabSwitchedPayload	(ALPHA) Payload of the IDashboardTabSwitched event.
IDashboardThemingProps
IDashboardUserInteractionTriggered	(BETA) This event is emitted after the user interaction that cannot be tracked by other existing events is triggered.
IDashboardVisualizationSwitcherProps	Visualization switcher widget props.
IDashboardVisualizationSwitcherWidgetVisualizationAdded	(BETA) This event is emitted when the new visualization is added to the dashboard's visualization switcher widget.
IDashboardVisualizationSwitcherWidgetVisualizationAddedPayload	(BETA) Payload of the IDashboardVisualizationSwitcherWidgetVisualizationAdded event.
IDashboardVisualizationSwitcherWidgetVisualizationsUpdated	(BETA) This event is emitted when the dashboard's visualization switcher visualizations is updated.
IDashboardVisualizationSwitcherWidgetVisualizationsUpdatedPayload	(BETA) Payload of the IDashboardVisualizationSwitcherWidgetVisualizationsUpdated event.
IDashboardWasReset	(BETA) This event is emitted at the end of successful 'dashboard reset' command processing. At this point, the dashboard is reset to the state it was after initial load.
IDashboardWasResetPayload	(BETA) Payload of the IDashboardWasReset event.
IDashboardWidgetCustomizer	Set of functions you can use to customize custom widgets.
IDashboardWidgetExecutionFailed	(BETA) This event is emitted after execution of an insight widget fails.
IDashboardWidgetExecutionFailedPayload	(BETA) Payload of the IDashboardWidgetExecutionFailed event.
IDashboardWidgetExecutionStarted	(BETA) This event is emitted after execution of an insight widget starts.
IDashboardWidgetExecutionStartedPayload	(BETA) Payload of the IDashboardWidgetExecutionStarted event.
IDashboardWidgetExecutionSucceeded	(BETA) This event is emitted after execution of an insight widget succeeds.
IDashboardWidgetExecutionSucceededPayload	(BETA) Payload of the IDashboardWidgetExecutionSucceeded event.
IDashboardWidgetOverlay	(BETA)
IDashboardWidgetProps	Dashboard widget props.
IDashboardWidgetsOverlayProps	Properties for Dashboard() widgets overlay.
IDateFilterConfigsState	(ALPHA)
IDateFilterConfigState	(BETA)
IDateFiltersCustomizer	Set of functions you can use to customize how date filters are rendered.
IDefaultDashboardExportVariablesProps	(ALPHA)
IDeleteDashboard	(BETA)
IDeleteDashboardTab	(ALPHA) Command to delete a dashboard tab.
IDeleteDashboardTabPayload	(ALPHA) Payload of the IDeleteDashboardTab command.
IDeleteFilterView	(ALPHA) Command for deletion of a saved filter view.
IDeleteFilterViewPayload	(ALPHA) Payload of the IDeleteFilterView command.
IDrill	(ALPHA)
IDrillDown	(ALPHA)
IDrillDownContext	(ALPHA) Implicit drill down context
IDrillDownDefinition	(BETA) Information about the DrillDown interaction - the attribute that is next in the drill down hierarchy.
IDrillDownPayload	(ALPHA) Payload of the IDrillDown command.
IDrillPayload	(ALPHA) Payload of the IDrill command.
IDrillState	(BETA)
IDrillStep	(BETA)
IDrillTargets	(ALPHA) Represent state item of widget reported available drill targets.
IDrillTargetsAdded	(ALPHA) Widget drill targets added event
IDrillTargetsAddedPayload	(ALPHA) Payload of the IDrillTargetsAdded event.
IDrillToAttributeUrl	(ALPHA)
IDrillToAttributeUrlPayload	(ALPHA) Payload of the IDrillToAttributeUrl command.
IDrillToCustomUrl	(ALPHA)
IDrillToCustomUrlPayload	(ALPHA) Payload of the IDrillToCustomUrl command.
IDrillToDashboard	(ALPHA)
IDrillToDashboardPayload	(ALPHA) Payload of the IDrillToDashboard command.
IDrillToInsight	(ALPHA)
IDrillToInsightPayload	(ALPHA) Payload of the IDrillToInsight command.
IDrillToLegacyDashboard	(ALPHA)
IDrillToLegacyDashboardPayload	(ALPHA) Payload of the IDrillToLegacyDashboard command.
IEditButtonProps	(BETA)
IEntitlementsState	(BETA)
IExecutedState	(BETA)
IExecutionResultEnvelope	(BETA)
IExportDashboardToExcel	(BETA)
IExportDashboardToExcelPayload	(BETA)
IExportDashboardToPdf	(BETA)
IExportDashboardToPdfPresentation	(BETA)
IExportDashboardToPptPresentation	(BETA)
IExportDashboardToPresentationPayload	(BETA)
IExportImageInsightWidget	(ALPHA)
IExportImageInsightWidgetPayload	(ALPHA) Payload of the IExportImageInsightWidget command.
IExportInsightWidget	(BETA)
IExportInsightWidgetPayload	(BETA) Payload of the IExportInsightWidget command.
IExportLayoutCustomizer	(ALPHA) Set of functions you can use to customize the export layout of the dashboard rendered.
IExportRawInsightWidget	(ALPHA)
IExportRawInsightWidgetPayload	(ALPHA) Payload of the IExportRawInsightWidget command.
IExportSlidesInsightWidget	(ALPHA)
IExportSlidesInsightWidgetPayload	(ALPHA) Payload of the IExportSlidesInsightWidget command.
IExportThemeProviderProps	(ALPHA)
IFilterBarCustomizer	Set of functions you can use to customize some aspects of the FilterBar.
IFilterBarProps	(ALPHA)
IFilterOp	(BETA)
IFilterOpDisableDateFilter	(BETA) This filter operation disabled date filtering for the widget.
IFilterOpEnableDateFilter	(BETA) This filter operation enables date filtering for the widget. A ref to date data set must be specified as it is passed down to widget content. Insights or KPIs can be typically date-filtered using different date data sets and so this selection is essential.
IFilterOpIgnoreAttributeFilter	(BETA) This filter operation appends one or more attribute filters into the widget's filter ignore-list.
IFilterOpIgnoreDateFilter	(BETA) This filter operation appends one or more date filters into the widget's filter ignore-list.
IFilterOpReplaceAll	(BETA) This filter operation completely replaces widget's filter settings. Both date data set (and thus date filter) setting and the attribute filter ignore list will be replaced using the parameters in the operation body.
IFilterOpReplaceAttributeIgnores	(BETA) This filter operation replaces the setting which determines which of the dashboard's attribute filters should be ignored for the widget.
IFilterOpUnignoreAttributeFilter	(BETA) This filter operation removes one or more attribute filters from the widget's filter ignore-list.
IFilterOpUnignoreDateFilter	(BETA) This filter operation removes one or more date filters from the widget's filter ignore-list.
IFiltersCustomizer	Set of functions you can use to customize rendering of the filters.
IFilterViews	(ALPHA)
IFilterViewsState	(ALPHA)
IFluidLayoutCustomizer	Set of functions you can use to customize the fluid layout of the dashboard rendered.
IInaccessibleDashboard	(ALPHA) Dashboard which is inaccessible by current user.
IInitializeAutomations	(BETA) Initialize dashboard automations by loading essential data such as notification channels. This initialization is necessary for working with alerts and scheduled exports.
IInsightAttributesMeta	(ALPHA)
IInsightBodyProps	Insight body props.
IInsightDateDatasets	(ALPHA) The insight date datasets is a digest of information related to what date datasets are used by the insight and what date datasets are also relevant to the insight.
IInsightMenuGroup	(BETA)
IInsightMenuItemButton	(BETA)
IInsightMenuItemSeparator	(BETA)
IInsightMenuSubmenu	(BETA)
IInsightMenuSubmenuComponentProps	(ALPHA)
IInsightPlaceholderWidget	(ALPHA)
IInvalidCustomUrlDrillParameterInfo	(ALPHA)
IIRichTextMenuItemSeparator	(ALPHA)
IKeyDriverAnalysis	(BETA)
IKeyDriverAnalysisPayload	(BETA) Payload of the IKeyDriverAnalysis command.
IKpiPlaceholderWidget	(ALPHA)
IKpiWidgetComparison	(BETA)
ILayoutCoordinates	(BETA) Coordinates of an item in a layout.
ILayoutDirectionChanged	(ALPHA) This event is emitted after a layout's direction was changed.
ILayoutDirectionChangedPayload	(BETA) Payload of the ILayoutDirectionChanged event.
ILayoutSectionHeadersToggled	(ALPHA) This event is emitted after layout section headers were toggled.
ILayoutSectionHeadersToggledPayload	(BETA) Payload of the ILayoutSectionHeadersToggled event.
ILayoutSectionPath	(ALPHA) Coordinates of a section in a nested layout.
ILayoutState	(ALPHA)
ILegacyDashboard	(ALPHA) Legacy Dashboard (a.k.a. PP Dashboard).
ILegacyDashboardTab	(ALPHA) Legacy Dashboard (a.k.a. PP Dashboard) tab.
ILoadingCustomizer	Set of functions you can use to customize some aspects of the Loading.
ILoadingState	(BETA)
ILockedStatusProps	(ALPHA)
IMeasureDateDatasets	(ALPHA) The measure date datasets holds information about available date datasets that can be used for date-filtering a particular measure. The data included herein can be used to select an appropriate date dataset to filter a KPI widget that renders value of particular measure.
IMenuButtonConfiguration	(ALPHA)
IMenuButtonItemButton	(ALPHA)
IMenuButtonItemHeader	(ALPHA)
IMenuButtonItemMenu	(ALPHA)
IMenuButtonItemSeparator	(ALPHA)
IMenuButtonItemsVisibility	(BETA)
IMenuButtonProps	(ALPHA)
IMenuItemCommonProps	(ALPHA)
IMetricsAndFacts	(ALPHA)
IModifyDrillDownForInsightWidget	(ALPHA)
IModifyDrillDownForInsightWidgetPayload	(ALPHA) Payload of the IModifyDrillDownForInsightWidget command.
IModifyDrillsForInsightWidget	(BETA)
IModifyDrillsForInsightWidgetPayload	(BETA) Payload of the IModifyDrillsForInsightWidget command.
IMoveAttributeFilter	(BETA)
IMoveDateFilter	(BETA)
IMoveLayoutSection	(BETA)
IMoveLayoutSectionPayload	(BETA) Payload of the IMoveLayoutSection command.
IMoveSectionItem	(BETA)
IMoveSectionItemPayload	(BETA) Payload of the IMoveSectionItem command.
IMoveSectionItemToNewSection	(BETA)
IMoveSectionItemToNewSectionPayload	(BETA) Payload of the IMoveSectionItemToNewSection command.
INestedLayoutProps	(ALPHA)
INotificationChannelsState	(ALPHA)
IObjRefMapConfig	(ALPHA) Configuration for the ObjRefMap.
IPdfExportConfig	(BETA)
IPlaceholderWidget	(ALPHA)
IQueryAttributeByDisplayForm	(ALPHA)
IQueryConnectedAttributes	(ALPHA)
IQueryConnectingAttributes	(ALPHA)
IQueryInsightAttributesMeta	(ALPHA) Given a reference to an insight, this query will obtain metadata about the display forms used in the insight. For each display form, the result will also contain attribute to which the display form belongs.
IQueryInsightDateDatasets	(ALPHA) Given a reference to an insight, this query will obtain list of all date datasets that may be used to filter it.
IQueryMeasureDateDatasets	(ALPHA) Given a reference to a measure, this query will obtain list of all date datasets that may be used to filter it.
IQueryMetricsAndFacts	(ALPHA)
IQueryWidgetAlertCount	(ALPHA) Given a reference to a KPI widget, this query will obtain the total number of alerts all the users have set on it.
IQueryWidgetBrokenAlerts	(ALPHA) This query base on given kpi widgetRef calculate BrokenAlertFilterBasicInfo IBrokenAlertFilterBasicInfo In case any broken alert filters query return empty array.
IQueryWidgetFilters	(ALPHA) Given a reference to a widget, this query will obtain the filters that should be used when executing it. These will respect the ignored filters on widget level as well as the filters specified in the insight itself. Filters returned by this query should be used with insightSetFilters() to obtain insight that is ready for execution or used to execute a KPI.
IRefreshAutomations	(BETA) Refresh the current dashboard's automation data. This is particularly useful after creating, updating, or removing alerts or scheduled exports, ensuring that the local data remains synchronized with the backend.
IRefreshInsightWidget	(BETA)
IRefreshInsightWidgetPayload	(BETA) Payload of the IRefreshInsightWidget command.
IRefreshKpiWidget	(BETA)
IRefreshKpiWidgetPayload	(BETA) Payload of the IRefreshKpiWidget command.
IReloadFilterViews	(ALPHA) Command for refreshing of the cache with saved filter views from persistent storage.
IRemoveAttributeFilters	(BETA)
IRemoveAttributeFiltersPayload	(BETA) Payload of the IRemoveAttributeFilters command.
IRemoveDateFilters	(BETA)
IRemoveDateFiltersPayload	(BETA) Payload of the IRemoveDateFilters command.
IRemoveDrillDownForInsightWidget	(ALPHA)
IRemoveDrillDownForInsightWidgetPayload	(ALPHA) Payload of the IRemoveDrillDownForInsightWidget command.
IRemoveDrillForKpiWidget	(BETA)
IRemoveDrillForKpiWidgetPayload	(BETA) Payload of the IRemoveDrillForKpiWidget command.
IRemoveDrillsForInsightWidget	(BETA)
IRemoveDrillsForInsightWidgetPayload	(BETA) Payload of the IRemoveDrillsForInsightWidget command.
IRemoveDrillToUrlForInsightWidget	(ALPHA)
IRemoveDrillToUrlForInsightWidgetPayload	(ALPHA)
IRemoveLayoutSection	(BETA)
IRemoveLayoutSectionPayload	(BETA) Payload of the IRemoveLayoutSection command.
IRemoveSectionItem	(BETA)
IRemoveSectionItemByWidgetRef	(BETA)
IRemoveSectionItemByWidgetRefPayload	(BETA) Payload of the IRemoveSectionItemByWidgetRef command.
IRemoveSectionItemPayload	(BETA) Payload of the IRemoveSectionItem command.
IRenameDashboard	(BETA)
IRenameDashboardPayload	(BETA) Payload of the IRenameDashboard command.
IRenameDashboardTab	(ALPHA) Command to rename a dashboard tab.
IRenameDashboardTabPayload	(ALPHA) Payload of the IRenameDashboardTab command.
IRenderingWorkerConfiguration	(BETA)
IRenderModeChangeOptions	(BETA)
IRenderModeState	(BETA)
IReplaceSectionItem	(BETA)
IReplaceSectionItemPayload	(BETA) Payload of the IReplaceSectionItem command.
IRepositionDashboardTab	(ALPHA) Command to reposition a dashboard tab.
IRepositionDashboardTabPayload	(ALPHA) Payload of the IRepositionDashboardTab command.
IResetDashboard	(BETA)
IResetFilterContextWorkingSelection	(ALPHA) Command for resetting all working filters. It resets the working filters in to same state as applied filters.
IResizeHeight	(BETA)
IResizeHeightPayload	(BETA) Payload of the IResizeHeight command.
IResizeWidth	(BETA)
IResizeWidthPayload	(BETA) Payload of the IResizeWidth command.
IResolvedAttributeFilterValues	(ALPHA)
IResolvedDateFilterValue	(ALPHA)
IResolvedFilterValues	(ALPHA) Resolved values types for all resolvable filters.
IRichTextCustomizer	Set of functions you can use to customize some aspects of the RichText.
IRichTextMenuItemButton	(ALPHA)
IRichTextMenuSubmenu	(ALPHA)
IRichTextMenuSubmenuComponentProps	(ALPHA)
ISaveAlert	(BETA) Saves alert.
ISaveAlertPayload	(BETA) Payload of the ISaveAlert command.
ISaveAsDialogProps	(ALPHA)
ISaveAsNewButtonProps	(BETA)
ISaveButtonProps	(BETA)
ISaveDashboard	(BETA)
ISaveDashboardPayload	(BETA) Payload of the ISaveDashboard command.
ISavedFilterViewInteractionData	(ALPHA)
ISaveFilterView	(ALPHA) Command for snapshotting current filter context and saving it as a filter view.
ISaveFilterViewPayload	(ALPHA) Payload of the ISaveFilterView command.
ISaveScheduledEmail	(BETA) Saves scheduled email.
ISaveScheduledEmailPayload	(BETA) Payload of the ISaveScheduledEmail command.
IScheduledEmailDialogProps	(ALPHA)
IScheduledEmailManagementDialogProps	(ALPHA)
IScreenSizeChanged	(BETA) This event is emitted after change of the dashboard layout screen size.
IScreenSizeChangedPayload	(BETA) Payload of the IScreenSizeChanged event.
ISectionSlidesTransformerFunction	(ALPHA)
ISetAttributeFilterDependentDateFilters	(BETA)
ISetAttributeFilterDisplayForm	(BETA)
ISetAttributeFilterDisplayFormPayload	(BETA)
ISetAttributeFilterLimitingItems	(ALPHA) Command for changing of attribute filter limiting items.
ISetAttributeFilterLimitingItemsPayload	(ALPHA) Payload of the ISetAttributeFilterLimitingItems command.
ISetAttributeFilterParents	(BETA)
ISetAttributeFilterSelectionMode	(BETA)
ISetAttributeFilterSelectionModePayload	(BETA)
ISetAttributeFilterTitle	(BETA) Command for changing attribute filter title.
ISetAttributeFilterTitlePayload	(BETA) Payload of the ISetAttributeFilterTitle command.
ISetDashboardAttributeFilterConfigDisplayAsLabel	(ALPHA) Command for changing attribute filter mode.
ISetDashboardAttributeFilterConfigDisplayAsLabelPayload	(ALPHA) Payload of the ISetDashboardAttributeFilterConfigDisplayAsLabel command.
ISetDashboardAttributeFilterConfigMode	(ALPHA) Command for changing attribute filter mode.
ISetDashboardAttributeFilterConfigModePayload	(ALPHA) Payload of the ISetDashboardAttributeFilterConfigMode command.
ISetDashboardDateFilterConfigMode	(ALPHA) A command that set the mode of a date filter configuration in a dashboard.
ISetDashboardDateFilterConfigModePayload	(ALPHA) Payload of the ISetDashboardDateFilterConfigMode command.
ISetDashboardDateFilterWithDimensionConfigMode	(ALPHA) Command for changing date filter mode.
ISetDashboardDateFilterWithDimensionConfigModePayload	(ALPHA) Payload of the ISetDashboardDateFilterConfigMode command.
ISetDateFilterConfigTitle	(BETA) Command for changing date filter title.
ISetDateFilterConfigTitlePayload	(BETA) Payload of the ISetDateFilterConfigTitle command.
ISetDrillForKpiWidget	(BETA)
ISetDrillForKpiWidgetPayload	(BETA) Payload of the ISetDrillForKpiWidget command.
ISetFilterViewAsDefault	(ALPHA) Command for setting a saved filter view as a default one or removing the default status from it.
ISetFilterViewAsDefaultPayload	(ALPHA) Payload of the ISetFilterViewAsDefault command.
ISetShowWidgetAsTable	(BETA)
ISetShowWidgetAsTablePayload	(BETA)
ISettingButtonProps	(BETA)
IShareButtonProps	(BETA)
IShareDialogProps	(ALPHA)
IShareStatusProps	(ALPHA)
ISharingApplyPayload	(ALPHA)
ISharingProperties	All sharing properties describing sharing changes
IShowAsTableButtonProps	(ALPHA)
IShowWidgetAsTableSet	(BETA) This event is emitted after a widget's show as table state has been set.
IShowWidgetAsTableSetPayload	(BETA) Payload of the IShowWidgetAsTableSet event.
IShowWidgetAsTableState	(BETA)
ISidebarProps	(ALPHA)
IStartRenamingDashboardTab	(ALPHA) Command to start renaming mode for a tab.
IStartRenamingDashboardTabPayload	(ALPHA) Payload of the IStartRenamingDashboardTab command.
ISwitchDashboardTab	(ALPHA) Command to switch to a different dashboard tab.
ISwitchDashboardTabPayload	(ALPHA) Payload of the ISwitchDashboardTab command.
ITabsState	(ALPHA)
ITabState	(ALPHA)
ITitleCustomizer	Set of functions you can use to customize some aspects of the Title.
ITitleProps	(ALPHA)
ITopBarCustomizer	Set of functions you can use to customize some aspects of the TopBar.
ITopBarProps	(ALPHA)
ITriggerEvent	(BETA) Triggers an event.
ITriggerEventPayload	(BETA) Payload of the ITriggerEvent command.
IUiState	(BETA)
IUndoEnhancedState	(ALPHA) Slice that can be undo-enabled needs to include the undo section which will contain the essential undo metadata.
IUndoEntry	(ALPHA) An entry on undo stack contains patches required
IUndoLayoutChanges	(BETA)
IUndoLayoutChangesPayload	(BETA) Payload of the IUndoLayoutChanges command.
IUpdateVisualizationsFromVisualizationSwitcherWidgetContent	(BETA)
IUpdateVisualizationsFromVisualizationSwitcherWidgetContentPayload	(BETA) Payload of the IUpdateVisualizationsFromVisualizationSwitcherWidgetContent command.
IUpsertExecutionResult	(BETA) Triggers an event.
IUseCustomWidgetExecutionDataViewConfig	Configuration options for the useCustomWidgetExecutionDataView() hook.
IUseCustomWidgetInsightDataViewConfig	Configuration options for the useCustomWidgetInsightDataView() hook.
IUseInsightWidgetDataView	Configuration for the useInsightWidgetDataView hook.
IUserInteractionPayloadWithDataBase	(BETA)
IUsersState	(ALPHA)
IUseScheduledExportFiltersProps	(ALPHA)
IUseWidgetAlertFiltersProps	(ALPHA)
IUseWidgetScheduledExportFiltersProps	(ALPHA)
IVisualizationSwitcherCustomizer	Set of functions you can use to customize some aspects of the VisualizationSwitcher.
IVisualizationSwitcherToolbarProps	(ALPHA)
IWidgetDescription	(BETA)
IWidgetHeader	(BETA)
IWorkingFilterContextDefinition	(ALPHA) Working filter context.
IXlsxExportConfig	(BETA)

Variables

Variable	Description
DEFAULT_MAX_AUTOMATIONS	(ALPHA) Default maximum number of automations.
DefaultDashboardNestedLayout	Default implementation of the dashboard layout widget.
DefaultDashboardRichText	Default implementation of the dashboard rich text widget.
DefaultDashboardVisualizationSwitcher	Default implementation of the dashboard visualization switcher widget.
InitialLoadCorrelationId	(BETA) The initial load of the dashboard will use this correlation id.
ReactDashboardContext	(ALPHA)
selectAccessibleDashboardsLoaded	(ALPHA) Select if accessible dashboards were loaded
selectAccessibleDashboardsMap	(ALPHA) Select all accessible dashboard in project and returns them in a mapping of obj ref to the insight object.
selectActiveCalendars	(ALPHA) Returns the active calendars configuration from workspace settings. Controls which calendar types (standard/fiscal) are available.
selectActiveTab	(ALPHA) Returns the currently active tab, or undefined if no tab is active or tabs are not present.
selectActiveTabLocalIdentifier	(ALPHA) Returns the local identifier of the currently active tab.
selectAdhocDateHierarchies	(ALPHA)
selectAllAnalyticalWidgets	(ALPHA) Selects all non-custom widgets in the layout.
selectAllAutomationsCount	(ALPHA) Returns workspace automations count.
selectAllCatalogAttributeHierarchies	(ALPHA)
selectAllCatalogAttributesMap	(ALPHA) Selects all attributes in the catalog as a mapping of ref to catalog's attribute object. The mapping will include both 'normal' attributes and attributes from date datasets.
selectAllCatalogDateDatasetsMap	(ALPHA) Selects all date datasets in the catalog as a mapping of obj ref to date dataset.
selectAllCatalogDisplayFormsMap	(ALPHA) Selects all display forms in the catalog as a mapping of obj ref to display form
selectAllCatalogMeasuresMap	(ALPHA) Selects all measures in the catalog as a mapping of ref to catalog's measure object.
selectAllCustomWidgets	(ALPHA) Selects all custom widgets in the layout.
selectAllInsightWidgets	(ALPHA) Selects all insight widgets in the layout.
selectAllKpiWidgets	(ALPHA) Selects all KPI widgets in the layout.
selectAttributeFilterConfigsDisplayAsLabelMap	(ALPHA) Get a map of attribute filter displayAsLabels
selectAttributeFilterConfigsModeMap	(ALPHA) Get a map of attribute filter modes directly from dashboard attribute filter configurations.
selectAttributeFilterConfigsOverrides	(ALPHA) Returns attribute filter configs that is specified on the loaded dashboard. The dashboard-level attribute filter configuration MAY contain overrides and additional configuration to apply on top of the workspace-level attribute filter config. If the dashboard-level overrides are not specified, then the workspace-level config should be taken as-is.
selectAttributeFilterDisplayForms	Selects list of display form metadata objects referenced by attribute filters.
selectAttributesWithDrillDown	(ALPHA)
selectAutomationAvailableDashboardFilters	(ALPHA)
selectAutomationCommonDateFilterId	(ALPHA)
selectAutomationDefaultSelectedFilters	(ALPHA)
selectAutomationFiltersByTab	(ALPHA) Returns automation-available filters structured per tab. Each entry includes tab information and the filters applicable to that tab. This selector is useful for whole dashboard automations when dashboard tabs are enabled.
selectAutomationsError	(ALPHA) Returns organization automations error
selectAutomationsInvalidationId	(ALPHA) Returns the invalidation ID for automations management. When this value changes (and is not 0 or undefined), the Automations component should reload its data.
selectAutomationsIsInitialized	(ALPHA) Returns workspace automations loading
selectAutomationsIsLoading	(ALPHA) Returns workspace automations loading
selectBackendCapabilities	This selector returns capabilities of the backend with which the dashboard works.
selectCanAddMoreAttributeFilters	This selector returns whether any more attribute filters can be added.
selectCanAddMoreFilters	This selector returns whether any more attribute filters can be added.
selectCanCreateAnalyticalDashboard	Returns whether the current user has permissions to create a KPI dashboard object via API.
selectCanCreateFilterView	Returns whether the current user has permissions necessary to create a filter view
selectCanCreateScheduledMail	Returns whether the current user has permissions to create a scheduled email object and a KPI alert object.
selectCanCreateVisualization	Returns whether the current user has permissions to create a KPI object, KPI widget object, and an insight object via API.
selectCanEditDashboardPermission	Returns whether the current user has permissions to edit dashboard.
selectCanEditLockedDashboardPermission	Returns whether the current user has permissions to edit locked dashboard.
selectCanExecuteRaw	Returns whether the current user has permissions necessary to export insights to CSV..
selectCanExportPdf	Returns whether the current user has permissions necessary to export insights in visual form (pdf, pptx, png)
selectCanExportReport	Returns whether the current user has permissions necessary to export insights.
selectCanExportTabular	Returns whether the current user has permissions necessary to export insights in tabular form (csv, xlsx)
selectCanInitData	Returns whether the current user has permissions to run MAQL DDL and DML, access a workspace staging directory.
selectCanInviteUserToWorkspace	Returns whether the current user has permissions to invite a user to a workspace or delete an invitation.
selectCanListUsersInWorkspace	Returns whether the current user has permissions to list users, roles, and permissions.
selectCanManageACL	Returns whether the current user has permissions to add, remove, and list ACLs (Access Control Lists) on an object.
selectCanManageAnalyticalDashboard	Returns whether the current user has permissions to modify and delete a KPI dashboard object.
selectCanManageDomain	Returns whether the current user has permissions to modify and delete a domain, run MAQL DDL.
selectCanManageMetric	Returns whether the current user has permissions to modify and delete a metric, run MAQL DDL, run the MAQL validator, change metric visibility via the unlisted flag.
selectCanManageScheduledMail	Returns whether the current user has permissions to manage scheduled email objects.
selectCanManageWorkspace	Returns whether the current user has permissions to modify workspace metadata, see the workspace token, lock and unlock objects, delete locked objects, set and unset the restricted flag on objects, clear cache, delete a workspace.
selectCanRefreshData	Returns whether the current user has permissions to run uploads, load date dimensions, access a workspace staging directory.
selectCanShareDashboardPermission	Returns whether the current user has permissions to share dashboard.
selectCanShareLockedDashboardPermission	Returns whether the current user has permissions to share a locked dashboard.
selectCanUploadNonProductionCSV	Returns whether the current user has permissions to upload CSV files via CSV Uploader.
selectCanViewDashboardPermission	Returns whether the current user has permissions to view dashboard.
selectCatalogAttributeDisplayForms
selectCatalogAttributeDisplayFormsById
selectCatalogAttributeHierarchies	(BETA)
selectCatalogAttributes
selectCatalogDateAttributes
selectCatalogDateDatasets
selectCatalogFacts
selectCatalogIsLoaded	(ALPHA)
selectCatalogMeasures
selectColorPalette	Returns the color palette for dashboard charts.
selectConfig	Returns dashboard's config.
selectCrossFilteringFiltersLocalIdentifiers	(BETA)
selectCrossFilteringItems	(BETA) Returns cross filtering items for the active tab (when tabs enabled) or default tab (when tabs disabled).
selectCurrentUser	This selector returns current logged in user.
selectCurrentUserRef	This selector returns current logged in user ref.
selectDashboardDescription	Selects current dashboard description.
selectDashboardFiltersApplyMode	(ALPHA) Setting of dashboard filters apply mode. The value is resolved in the following order: If set on workspace level, workspace setting is used. If not set on workspace level, organization setting is used. If none of them are set, INDIVIDIAL mode is default.
selectDashboardFiltersWithoutCrossFiltering	(ALPHA)
selectDashboardHiddenFilters	(ALPHA)
selectDashboardId	Selects identifier of the persisted dashboard object that backs and is rendered-by the dashboard component.
selectDashboardIdRef	Selects idRef of the persisted dashboard object that backs and is rendered-by the dashboard component.
selectDashboardLockedFilters	(ALPHA)
selectDashboardLockStatus	(ALPHA) Selects dashboard lock status.
selectDashboardPermissions	This selector returns user's dashboard permissions.
selectDashboardRef	Selects ref of the persisted dashboard object that backs and is rendered-by the dashboard component.
selectDashboardShareInfo	(ALPHA) Selects complete dashboard share info.
selectDashboardShareStatus	(ALPHA) Selects dashboard share status.
selectDashboardTags	Selects dashboard tags.
selectDashboardTitle	Selects current dashboard title.
selectDashboardUri	Selects URI of the persisted dashboard object that backs and is rendered-by the dashboard component.
selectDashboardUriRef	Selects uriRef of the persisted dashboard object that backs and is rendered-by the dashboard component.
selectDashboardUserAutomationAlerts	(ALPHA) Returns workspace alerts.
selectDashboardUserAutomations	(ALPHA) Returns workspace automations.
selectDashboardUserAutomationSchedules	(ALPHA) Returns workspace schedules.
selectDateFilterConfig	Returns workspace-level configuration for the of the date filter options and presets.
selectDateFilterConfigOverrides	(ALPHA) Returns date filter config that is specified on the loaded dashboard. The dashboard-level date filter configuration MAY contain overrides and additional configuration to apply on top of the workspace-level date filter config. If the dashboard-level overrides are not specified, then the workspace-level config should be taken as-is.
selectDateFilterConfigsModeMap	(ALPHA) Get a map of date filter modes directly from dashboard date filter configurations.
selectDateFilterConfigsOverrides	(ALPHA) Returns date filter configs that is specified on the loaded dashboard. The dashboard-level date filter configuration MAY contain overrides and additional configuration to apply on top of the workspace-level date filter config. If the dashboard-level overrides are not specified, then the workspace-level config should be taken as-is.
selectDateFilterConfigValidationWarnings	(ALPHA) Returns the date filter config validation result warnings indicating any problems encountered during the date filter config resolution.
selectDateFormat	Returns date format.
selectDateHierarchyTemplates	(ALPHA)
selectDefaultFilterOverrides	(BETA) Selects default filter overrides for the dashboard.
selectDisableDashboardCrossFiltering	Selects whether dashboard cross filtering is disabled.
selectDisableDashboardUserFilterReset	Selects whether user filter reset is disabled.
selectDisableDashboardUserFilterSave	Selects whether user filter save is disabled.
selectDisableDefaultDrills	Returns whether the default drills configured on the widgets or implicit drills (eg. drill down) are disabled. This option does not affect drilling enabled by drillableItems.
selectDisableFilterViews	Selects whether filter views are disabled.
selectDrillableItems	(ALPHA) Returns drillable items for the active tab (when tabs enabled) or default tab (when tabs disabled).
selectDrillTargets	(ALPHA) Return all widgets drill targets
selectEffectiveAttributeFiltersModeMap	(ALPHA) Get a map of attribute filter modes based on the current screen mode (edit or view).
selectEffectiveDateFilterAvailableGranularities	(ALPHA) Returns effective date filter options from. This is created by merging the workspace-level date filter config and the dashboard-level date filter config. These are the date filter options that the DateFilter SHOULD use when rendering filtering presets.
selectEffectiveDateFilterConfig	(ALPHA) Returns effective date filter config. The effective date filter config is created by merging the workspace-level date filter config and the dashboard-level date filter config. This is the configuration that the DateFilter SHOULD use when rendering filtering presets.
selectEffectiveDateFilterMode	(ALPHA) Returns display mode for the effective date filter. This always comes from the dashboard-level date filter config overrides - regardless whether the rest of the overrides are actually used.
selectEffectiveDateFilterOptions	(ALPHA) Returns effective date filter options. This is created by merging the workspace-level date filter config and the dashboard-level date filter config. These are the date filter options that the DateFilter SHOULD use when rendering filtering presets.
selectEffectiveDateFiltersModeMap	(ALPHA) Get a map of date filter modes based on the current screen mode (edit or view).
selectEffectiveDateFilterTitle	(ALPHA) Returns custom title to use for the date filter. Custom title comes from the dashboard-level date filter config overrides. If no overrides were defined OR the effective date filter config is not using them (because applying them means the final date filter config is invalid), then no custom filter should be used.
selectEnableAlertAttributes	(ALPHA)
selectEnableAlerting	(ALPHA)
selectEnableAutomations	(ALPHA)
selectEnableComparisonInAlerting	(ALPHA)
selectEnableDashboardFilterGroups	(ALPHA) Returns whether dashboard filter group feature is enabled.
selectEnableDashboardSectionHeadersDateDataSet	(ALPHA) Returns whether dashboard-level date dataset configuration for section headers is enabled.
selectEnableFilterValuesResolutionInDrillEvents	Returns whether filter values in drill events should be resolved.
selectEnableFiscalCalendars	(ALPHA) Returns whether fiscal calendars feature flag is enabled.
selectEnableImplicitDrillToUrl	(ALPHA) Returns whether implicit drill to url feature is enabled.
selectEnableKPIDashboardExportPDF	Returns whether the export to pdf is enabled.
selectEnableRichTextWidgetFilterConfiguration	(ALPHA) Returns whether rich text widget filter configuration is enabled.
selectEnableScheduling	(ALPHA)
selectEntitlementMaxAutomationRecipients	(ALPHA)
selectEntitlementMaxAutomations	(ALPHA)
selectEntitlementMinimumRecurrenceMinutes	(ALPHA)
selectEntitlementUnlimitedAutomations	(ALPHA)
selectErrorUsers	(ALPHA) Returns error if users loading failed.
selectEvaluationFrequency	Selects evaluation frequency.
selectExportResultPollingTimeout	(ALPHA) Returns the timeout to use when polling for export results (in milliseconds).
selectFilterBarExpanded	(ALPHA)
selectFilterContextAttributeFilters	This selector returns dashboard's applied filter context attribute filters.
selectFilterContextDateFilter	This selector returns dashboard's applied filter context date filter.
selectFilterContextDateFiltersWithDimension	This selector returns dashboard's applied filter context date filter with dimension specified.
selectFilterContextDefinition	This selector returns current applied dashboard's filter context definition.
selectFilterContextFilters	This selector returns dashboard's applied filter context filters.
selectFilterGroupsConfig	(ALPHA) Returns the filter group config of currently active tab.
selectFiltersWithInvalidSelection	This selector returns array of filter localIds that have invalid selections.
selectFilterViews	(ALPHA)
selectFilterViewsAreLoading	(ALPHA)
selectFocusObject	(BETA) Returns dashboard focus object.
selectHasCatalogAttributes	(ALPHA)
selectHasCatalogDateDatasets	(ALPHA)
selectHasCatalogFacts	(ALPHA)
selectHasCatalogMeasures	(ALPHA)
selectHasSomeExecutionResult	(ALPHA)
selectHasTabs	(ALPHA) Returns whether tabs are present in the dashboard.
selectInaccessibleDashboardsMap	(ALPHA) Select all inaccessible dashboard in project and returns them in a mapping of obj ref to the insight object.
selectInsightRefs	(ALPHA) Selects refs of all insights used on the dashboard.
selectInsightsMap	(ALPHA) Selects all insights and returns them in a mapping of obj ref to the insight object.
selectIsAddTabButtonHidden	(ALPHA) Returns whether the add tab button should be hidden in edit mode.
selectIsAlertingDialogOpen	(ALPHA)
selectIsAlertingManagementDialogContext	(ALPHA)
selectIsAlertsManagementDialogOpen	(ALPHA)
selectIsCrossFiltering	(BETA)
selectIsDashboardPrivate	(ALPHA) Returns whether dashboard is private.
selectIsDashboardSaving
selectIsEmbedded	Returns whether the Dashboard is executed in embedded context.
selectIsExport	Returns whether the Dashboard is rendered in the export mode. In export mode, some components can be hidden, or rendered differently.
selectIsFilterAttributeSelectionOpen	(ALPHA)
selectIsInEditMode	Returns whether the current Dashboard is on edit mode.
selectIsLayoutEmpty	(ALPHA) Selects a boolean indicating if the dashboard is empty.
selectIsReadOnly	Returns whether the Dashboard is executed in read-only mode.
selectIsSaveAsDialogOpen	(ALPHA)
selectIsScheduleEmailDialogContext	(ALPHA)
selectIsScheduleEmailDialogOpen	(ALPHA)
selectIsScheduleEmailManagementDialogContext	(ALPHA)
selectIsScheduleEmailManagementDialogOpen	(ALPHA)
selectIsSettingsDialogOpen	(ALPHA)
selectIsShareDialogOpen	(ALPHA)
selectIsWorkingFilterContextChanged	(ALPHA) Returns true if working filters and applied filters are same. Attribute filters are considered equal if - they have same localIdentifier - they have same elements (order does not matter) - all other fields are deep equal EXCEPT displayForm We exclude diplayForm becuase of primary display form migration code. Which changes display forms after update.
selectLayout	This selector returns dashboard's layout. It is expected that the selector is called only after the layout state is correctly initialized. Invocations before initialization lead to invariant errors.
selectLayoutHasAnalyticalWidgets	(ALPHA) Selects a boolean indicating if the dashboard contains at least one non-custom widget.
selectListedDashboardsMap	(ALPHA) Select all listed dashboard in project and returns them in a mapping of obj ref to the insight object.
selectLocale	Returns locale to use for internationalization of the dashboard.
selectMenuButtonItemsVisibility	(ALPHA)
selectNamesOfFiltersWithInvalidSelection	This selector returns an array of attribute names related to filters with invalid selection.
selectNotificationChannels	(ALPHA) Returns organization notification channels.
selectNotificationChannelsCount	(ALPHA) Returns organization notification channels count.
selectNotificationChannelsCountWithoutInPlatform	(ALPHA) Returns notification channels suitable for scheduled exports.
selectNotificationChannelsWithoutInPlatform	(ALPHA) Returns notification channels suitable for scheduled exports.
selectObjectAvailabilityConfig	Returns the object availability configuration for this dashboard.
selectOriginalFilterContextDefinition	This selector returns original (stored) dashboard's filter context definition.
selectOriginalFilterContextFilters	This selector returns original (stored) dashboard's filters.
selectPermissions	This selector returns user's permissions in the workspace where the dashboard is stored.
selectPlatformEdition	Returns current platform edition.
selectScheduleEmailDialogDefaultAttachment	(ALPHA)
selectScreen	This selector returns dashboard's current layout screen size. Valid screen size is provided after first render.
selectSectionHeadersDateDataSet	(ALPHA) Selects the date dataset to use for filtering metrics in section header rich text.
selectSelectedFilterIndex	(ALPHA)
selectSeparators	Returns number separators to use when rendering numeric values on charts or KPIs.
selectSettings	Returns settings that are in effect for the current dashboard.
selectSupportsElementsQueryParentFiltering	This selector returns capability if parent child filtering is enabled.
selectTabs	(ALPHA) Returns all tabs with their configurations.
selectTimezone	Returns timezone
selectUsers	(ALPHA) Returns workspace users.
selectUsersLoadingStatus	(ALPHA) Returns true if users are loading.
selectWidgetLocalIdToTabIdMap	(ALPHA) Maps widget local identifiers to the tab that contains them.
selectWorkingFilterContextAttributeFilters	This selector returns dashboard's working filter context attribute filters.
selectWorkingFilterContextDateFilter	This selector returns dashboard's working filter context date filter.
selectWorkingFilterContextDateFiltersWithDimension	This selector returns dashboard's working filter context date filter with dimension specified.
selectWorkingFilterContextDefinition	(ALPHA) This selector returns current working dashboard's filter context definition.
selectWorkingFilterContextFilters	This selector returns dashboard's working filter context filters.
useDashboardSelector	Hook for retrieving data from the dashboard state.

Type Aliases

Type Alias	Description
ActionFailedErrorReason	(BETA)
AddAttributeFilterPayload	(BETA) Payload of the IAddAttributeFilter command.
AttributeFilterComponentProvider
AttributeFilterInteractionType	(BETA)
AttributeFilterSelectionType	Attribute filter selection type for ChangeAttributeFilterSelectionPayload.
AttributeHierarchiesInteractionType	(BETA)
AutomationInteractionData	(ALPHA)
AutomationInteractionPayload	(ALPHA)
AutomationInteractionType	(ALPHA)
BackendCapabilitiesState
BareUserInteractionType	(BETA)
BrokenAlertAttributeFilterInfo	(ALPHA) Broken alert attribute filter basic info .
BrokenAlertDateFilterInfo	(ALPHA) Broken alert date filter basic info .
BrokenAlertType	(ALPHA) Type of broken alert filter basic info
CatalogState
ChangeAttributeFilterSelection	Command for attribute filter selection change.
ChangeAttributeFilterSelectionPayload	Payload type for ChangeAttributeFilterSelection command.
ChangeDateFilterSelection	Command for date filter selection change.
ChangeFilterContextSelection	Command for changing multiple filters at once.
ChangeFilterContextSelectionParams	Params for command.
ChangeFilterContextSelectionPayload	Payload of the ChangeFilterContextSelection command.
ChangeInsightWidgetVisConfiguration
ChangeInsightWidgetVisConfigurationPayload	Payload of the ChangeInsightWidgetVisConfiguration command.
ChangeLayoutSectionHeader
ChangeLayoutSectionHeaderPayload	Payload of the ChangeLayoutSectionHeader command.
CommandProcessingMeta
CommonExportDataAttributes	(ALPHA) Data attributes with export specification for components.
ConfigState
CustomAlertingDialogComponent	(ALPHA)
CustomAlertingManagementDialogComponent	(ALPHA)
CustomButtonBarComponent	(BETA)
CustomCancelButtonComponent	(BETA)
CustomDashboardAttributeFilterComponent
CustomDashboardContentComponent	(ALPHA)
CustomDashboardDateFilterComponent
CustomDashboardInsightComponent
CustomDashboardInsightMenuButtonComponent	(ALPHA)
CustomDashboardInsightMenuComponent	(ALPHA)
CustomDashboardLayoutComponent	(ALPHA)
CustomDashboardRichTextComponent
CustomDashboardRichTextMenuButtonComponent	(ALPHA)
CustomDashboardRichTextMenuComponent	(ALPHA)
CustomDashboardSettingsDialogComponent	(ALPHA)
CustomDashboardVisualizationSwitcherComponent
CustomDashboardWidgetComponent
CustomEditModeButtonComponent	(BETA)
CustomFilterBarComponent	(ALPHA)
CustomInsightBodyComponent
CustomMenuButtonComponent	(ALPHA)
CustomSaveAsDialogComponent	(ALPHA)
CustomSaveAsNewButtonComponent	(BETA)
CustomSaveButtonComponent	(BETA)
CustomScheduledEmailDialogComponent	(ALPHA)
CustomScheduledEmailManagementDialogComponent	(ALPHA)
CustomSettingButtonComponent	(BETA)
CustomShareButtonComponent	(ALPHA)
CustomShareDialogComponent	(ALPHA)
CustomShowAsTableButtonComponent	(ALPHA)
CustomSidebarComponent	(ALPHA)
CustomTitleComponent	(ALPHA)
CustomTopBarComponent	(ALPHA)
CustomVisualizationSwitcherToolbarComponent	(ALPHA)
DashboardAccessibilityLimitation	(ALPHA) Represents different kinds of accessibility limitation for dashboard. Dashboard is forbidden when strict access control is supported and user does not have permission to see it or drill to it. Dashboard is not shared when user is able to drill to it but not see it directly.
DashboardAsyncRenderRequested	This event is emitted when a component on the dashboard requests async rendering.
DashboardAsyncRenderRequestedPayload	Payload of the DashboardAsyncRenderRequested event.
DashboardAsyncRenderResolved	This event is emitted when a component on the dashboard resolves async rendering.
DashboardAsyncRenderResolvedPayload	Payload of the DashboardAsyncRenderResolved event.
DashboardAttributeFilterSelectionChanged	This event is emitted after new elements are selected and applied in an attribute filter.
DashboardAttributeFilterSelectionChangedPayload	Payload of the DashboardAttributeFilterSelectionChanged event.
DashboardCommands	Union type that contains all available built-in dashboard commands.
DashboardCommandType	All available command types.
DashboardConfig	Dashboard configuration can influence the available features, look and feel and behavior of the dashboard.
DashboardContentComponentProvider	(ALPHA)
DashboardContext
DashboardCopySaved	This event is emitted at the end of successful 'dashboard save as' command processing.
DashboardCopySavedPayload	Payload of the DashboardCopySaved event.
DashboardDateFilterSelectionChanged	This event is emitted after the dashboard's date filter selection is changed.
DashboardDateFilterSelectionChangedPayload	Payload of the DashboardDateFilterSelectionChanged event.
DashboardDeinitialized	This event is emitted when a dashboard is deinitialized. The event contains contextual information such as the ref of dashboard being deinitialized if the dashboard being deinitialized contained a persisted dashboard object.
DashboardDeinitializedPayload	Payload of the DashboardDeinitialized event.
DashboardDescriptor
DashboardDispatch
DashboardDrillCommand	(ALPHA)
DashboardDrillDefinition	(BETA) Supported dashboard drill definitions.
DashboardEventBody
DashboardEventEvalFn
DashboardEventHandler	Event handlers can be registered for a dashboard.
DashboardEventHandlerFn
DashboardEvents	Union type that contains all available built-in dashboard events.
DashboardEventType	A union of all available built-in dashboard event type names.
DashboardFilterContextChanged	This event is emitted after _any_ change to dashboard filters (be it date or attribute filter). The event describes the new state of the entire filter context.
DashboardFilterContextChangedPayload	Payload of the DashboardFilterContextChanged event.
DashboardInitialized	This event is emitted when a dashboard is successfully initialized.
DashboardInitializedPayload	Payload of the DashboardInitialized event.
DashboardItem	Dashboard item
DashboardItemDefinition	(BETA) Definition of items that may be placed into the dashboard sections.
DashboardItemVisualization	Dashboard item with visualization
DashboardItemVisualizationContent	Dashboard item with visualization content
DashboardLayoutCommands	(BETA)
DashboardLayoutComponentProvider	(ALPHA)
DashboardLayoutExportTransformFn
DashboardModelCustomizationFns
DashboardPermissionsState
DashboardPluginDescriptor	Basic set of information about a Dashboard plugin.
DashboardQueries	(ALPHA)
DashboardQueryType	(BETA)
DashboardRelatedFilter	(ALPHA)
DashboardRenderRequested	This event is emitted as soon as the dashboard component is mounted, and rendering of its content started.
DashboardRenderResolved
DashboardSaved	This event is emitted at the end of successful dashboard save command processing. At this point, the dashboard state is persisted on the backend.
DashboardSavedPayload	Payload of the DashboardSaved event.
DashboardSelector	Function that selects part of the Dashboard state.
DashboardSelectorEvaluator	Type of a callback that evaluates a selector function against the Dashboard state
DashboardSharingChanged	This event is emitted at the end of successful 'change sharing status of dashboard' command processing.
DashboardSharingChangedPayload	Payload of the DashboardSharingChanged event.
DashboardState	Layout of the dashboard component's state. State modifications are always done using Command API. Reading from state must always be done using the Selectors API. Accessing state props directly is dangerous practice. We reserve the rights to refactor and otherwise break the shape of the state at any time while keeping the Selectors and Command APIs stable.
DashboardStateChangeCallback	Callback called whenever the Dashboard's internal state changes.
DashboardTransformFn
DateFilterComponentProvider
DateFilterConfigValidationResult	Validation result.
DateFilterInteractionType	(BETA)
DateFilterSelection	Payload type for ChangeDateFilterSelection command.
DateFilterValidationFailed	This event may occur while the dashboard is handling the Load Dashboard command and is loading and validating dashboard configuration from the backend.
DateFilterValidationFailedPayload	Payload of the DateFilterValidationFailed event.
DateFilterValidationResult
DescriptionExportData	(ALPHA) Data attributes for export mode to be added to the description.
DescriptionTooltipOpenedData	(BETA)
DescriptionTooltipOpenedFrom	(BETA)
DescriptionTooltipOpenedPayload	(BETA)
DescriptionTooltipOpenedType	(BETA)
ExportElementType	(ALPHA) Export element type.
ExportLayoutCustomizationFn	(ALPHA)
ExportMetaType	(ALPHA) Export meta type.
ExtendedDashboardItem	Specialization of the IDashboardLayoutItem which also includes the extended dashboard widgets - KPI and Insight placeholders.
ExtendedDashboardItemType	Utility type to get the widget type from a given ExtendedDashboardItem type.
ExtendedDashboardItemTypes	Utility type to get the widget type from a given ExtendedDashboardItem array.
ExtendedDashboardLayoutSection	Dashboard layout section that can contain extended set of items - including KPI and Insight placeholders.
ExtendedDashboardLayoutWidget	Extension of the default type to also include view-only custom widget types.
ExtendedDashboardWidget	Extension of the default type to also include view-only custom widget types.
FilterableDashboardWidget	Subset of widget types which support filtering.
FilterBarComponentProvider
FilterBarRenderingMode	Mode of rendering of the FilterBar.
FilterContextState
FilterOperations	(BETA)
FiltersInfo	(ALPHA) Contains information about dashboard filters.
FilterViewDialogMode	(BETA)
FluidLayoutCustomizationFn
HeaderExportData	(ALPHA) Data attributes for export mode to be added to the header.
IDashboardFilter	Supported dashboard filter type.
IDashboardPluginContract_V1	Raw, low-level interface that the dashboard plugins need to implement.
IExportConfig	(BETA)
IInsightMenuItem	(BETA)
ILayoutItemPath	(ALPHA) Coordinates of an item in a nested layout.
IMenuButtonItem	(ALPHA)
InitializeDashboard	Loads dashboard from analytical backend.
InitializeDashboardPayload	Payload of the InitializeDashboard command.
InsightBodyComponentProvider	(ALPHA)
InsightComponentProvider
InsightMenuButtonComponentProvider	(ALPHA)
InsightMenuComponentProvider	(ALPHA)
InsightMenuItemsProvider	(BETA)
IRichTextMenuItem	(ALPHA)
IWidgetFilterOperation	(BETA) Widget's filter settings can be manipulated using multiple different granular operations. This is the union type containing all the available operations.
KpiAlertDialogOpenedPayload	(BETA)
LayoutComponentProvider
LayoutStash	(BETA)
LoadingComponentProvider
MetaExportData	(ALPHA) Data attributes for export mode to be added to the header.
MetaExportDataAttributes	(ALPHA) Data attributes with export specification for meta.
MoveAttributeFilterPayload	(BETA) Payload of the IMoveAttributeFilter command.
MoveDateFilterPayload	(BETA) Payload of the IMoveDateFilter command.
NestedLayoutInteractionType	(BETA)
ObjectAvailabilityConfig	Dashboard component may offer users to pick objects to use on the dashboard.
OnDrillDownSuccess	(ALPHA)
OnDrillToAttributeUrlSuccess	(ALPHA)
OnDrillToCustomUrlSuccess	(ALPHA)
OnDrillToDashboardSuccess	(ALPHA)
OnDrillToInsightSuccess	(ALPHA)
OnFiredDashboardDrillEvent	(BETA) Callback called when a drill event occurs.
OnWidgetDrill	(ALPHA)
OptionalAttributeFilterComponentProvider
OptionalDashboardContentComponentProvider	(ALPHA)
OptionalDashboardLayoutComponentProvider	(ALPHA)
OptionalDateFilterComponentProvider
OptionalFilterBarComponentProvider
OptionalInsightBodyComponentProvider	(ALPHA)
OptionalInsightComponentProvider
OptionalInsightMenuButtonComponentProvider	(ALPHA)
OptionalInsightMenuComponentProvider	(ALPHA)
OptionalLayoutComponentProvider
OptionalLoadingComponentProvider
OptionalProvider
OptionalRichTextComponentProvider
OptionalRichTextMenuComponentProvider	(ALPHA)
OptionalShowAsTableButtonComponentProvider	(ALPHA)
OptionalTitleComponentProvider
OptionalTopBarComponentProvider
OptionalVisualizationSwitcherComponentProvider	(ALPHA)
OptionalVisualizationSwitcherToolbarComponentProvider	(ALPHA)
OptionalWidgetComponentProvider
PdfConfiguration	(BETA)
PermissionsState
QueryProcessingErrorState
QueryProcessingPendingState
QueryProcessingRejectedState
QueryProcessingRunningState
QueryProcessingState
QueryProcessingSuccessState
RelativeIndex	(BETA) This is a mark-up type that is used for properties and arguments that can contain relative index: a zero-based index with added convenience of referencing last spot using index of -1.
RemoveDrillsSelector	(BETA)
RenderMode	(BETA)
RequestAsyncRender
RequestAsyncRenderPayload	Payload of the RequestAsyncRender command.
ResolvableFilter	(ALPHA) Supported dashboard filter types for values resolution.
ResolveAsyncRender
ResolveAsyncRenderPayload	Payload of the ResolveAsyncRender command.
ResolvedDashboardConfig	Dashboard configuration resolved using the config passed in via props and any essential data retrieved from backend.
ResolvedDateFilterValues	(ALPHA)
ResolvedEntitlements	(BETA)
RichTextComponentProvider
RichTextDataAttributes	(ALPHA) Data attributes for export mode to be added to the rich text widget.
RichTextExportData	(ALPHA) Data attributes for export mode to be added to the rich text widget and its components. When customizing a rich text widget component, spread these properties in the element intended for export.
RichTextMenuComponentProvider	(ALPHA)
RichTextMenuItemsProvider	(ALPHA)
SaveDashboardAs
SaveDashboardAsPayload	Payload of the SaveDashboardAs command.
SavedFilterViewInteractionPayload	(ALPHA)
SavedFilterViewInteractionType	(ALPHA)
SavingState
SectionDescriptionExportDataAttributes	(ALPHA) Data attributes with export specification for section description component.
SectionExportData	(ALPHA) Data attributes for export mode to be added to the layout section header and its components.
SectionSlidesTransformer	(ALPHA)
SetAttributeFilterDependentDateFiltersPayload	(BETA) Payload of the ISetAttributeFilterDependentDateFilters command.
SetAttributeFilterParentsPayload	(BETA) Payload of the ISetAttributeFilterParents command.
SetCatalogItemsPayload
SetCatalogMeasuresAndFactsPayload
ShareDialogInteractionData	(BETA)
ShareDialogInteractionPayload	(BETA)
ShareDialogInteractionType	(BETA)
ShowAsTableButtonComponentProvider	(ALPHA)
StashedDashboardItemsId	(BETA) Identifier of a stashed dashboard items. When removing one or more item, the caller may decide to 'stash' these items under some identifier. This stashed items can then be used in subsequent command that places items on the layout by providing the stash identifier.
TabsReducer	(ALPHA)
TitleComponentProvider
TopBarComponentProvider
UndoPointSelector	(BETA) The undo point selector function will be called during layout undo processing to determine up to (and including) which command should the undo be done. Commands are sorted in the list in reversed chronological order - last command processed command is at index 0, command before that at index 1 etc. The function must return index of command up to (and including) which the undo should be done. It is not possible to undo just some command randomly.
UseCustomWidgetExecutionDataViewCallbacks	Callbacks for useCustomWidgetExecutionDataView() hook.
UseCustomWidgetInsightDataViewCallbacks	Callbacks for useCustomWidgetInsightDataView() hook.
UseDashboardAsyncRender	Callbacks returned from useDashboardAsyncRender() hook.
UseInsightWidgetInsightDataViewCallbacks	Callbacks for useInsightWidgetDataView() hook.
UseParentFiltersResult	Result of the useParentFilters() hook, that can be used as parent filtering input props for AttributeFilter().
UserInteractionPayload	(BETA)
UserInteractionPayloadWithData	(BETA)
UserInteractionType	(BETA)
UserState
VisualizationSwitcherComponentProvider
VisualizationSwitcherInteractionType	(BETA)
VisualizationSwitcherToolbarComponentProvider	(ALPHA)
WidgetComponentProvider
WidgetExportData	(ALPHA) Data attributes for export mode to be added to the widget and its components. When customizing a widget component, spread these properties in the element intended for export.
WidgetExportDataAttributes	(ALPHA) Data attributes for export mode to be added to the widget.
WidgetExportDimensionsAttributes	(ALPHA) Data attributes for visualization dimensions.
WidgetsOverlayFn	(ALPHA)
WorkingDashboardAttributeFilter	(ALPHA) Partial working attribute filter used in working filter context.
WorkingFilterContextItem	(ALPHA) Partial working filter context item.