Overview of sdk-ui-dashboard

Home > @gooddata/sdk-ui-dashboard

sdk-ui-dashboard package

This package provides the Dashboard component that can be used 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
DashboardPluginV1	Abstract base class for the Dashboard Plugin.
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.
SingleDashboardStoreAccessor	This singleton class uses DashboardStoreAccessorRepository to create a store accessor for a single dashboard.

Functions

Function	Description
addAttributeFilter(displayForm, index, correlationId)	(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.
addLayoutSection(index, initialHeader, initialItems, autoResolveDateFilterDataset, correlationId)	(BETA) Creates the AddLayoutSection command.
addSectionItem(sectionIndex, itemIndex, item, autoResolveDateFilterDataset, correlationId)	(BETA) Creates the AddSectionItems command.
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.
cancelEditRenderMode(correlationId)	(BETA) Creates the ChangeRenderMode command for cancel edit mode.
changeAttributeFilterSelection(filterLocalId, elements, selectionType, correlationId)	Creates the ChangeAttributeFilterSelection command.
changeDateFilterSelection(type, granularity, from, to, dateFilterOptionLocalId, correlationId)	Creates the ChangeDateFilterSelection command.
changeFilterContextSelection(filters, resetOthers, correlationId)	Creates the ChangeFilterContextSelection 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.
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)	(BETA) 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 behavesIf 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 renderedIf 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)	(BETA) 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
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.
clearDateFilterSelection(correlationId)	This convenience function will create ChangeDateFilterSelection configured so that the date filter will be unbounded - showing data for 'All Time'.
createAlert(alert, correlationId)	(BETA) Creates the SaveAlert command. Dispatching this command will result in the creating Kpi alert on the backend.
createScheduledEmail(scheduledEmail, filterContext, correlationId)	(BETA) Creates the CreateScheduledEmail command.Dispatching this command will result in the creating scheduled email on the backend.
dashboardAttributeFilterToAttributeFilter(filter)	Converts to IAttributeFilter instance.
dashboardDateFilterToDateFilterByDateDataSet(filter, dateDataSet)	Converts to IDateFilter instance.
dashboardDateFilterToDateFilterByWidget(filter, widget)	Converts to IDateFilter instance.
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.
disableInsightWidgetDateFilter(ref, correlationId)	(BETA) Creates the ChangeInsightWidgetFilterSettings command for FilterOpDisableDateFilter 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 FilterOpDisableDateFilter operation.Dispatching this command will result in change of KPI widget's date filter setting. The date filtering will be disabled.
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.
enableInsightWidgetDateFilter(ref, dateDataset, correlationId)	(BETA) Creates the ChangeInsightWidgetFilterSettings command for FilterOpEnableDateFilter 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 FilterOpEnableDateFilter 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.
exportDashboardToPdf(correlationId)	(BETA) Creates the ExportDashboardToPdf command. Dispatching this command will result in a request to export the dashboard to a PDF file. If successful, an instance of DashboardExportToPdfResolved will be emitted with the URL of the resulting file.
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.
filterContextItemsToDashboardFiltersByDateDataSet(filterContextItems, dateDataSet)	Gets IDashboardFilter items for filters specified as instances.
filterContextItemsToDashboardFiltersByWidget(filterContextItems, widget)	Gets IDashboardFilter items for filters specified as instances.
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.
ignoreFilterOnInsightWidget(ref, oneOrMoreDisplayForms, correlationId)	(BETA) Creates the ChangeInsightWidgetFilterSettings command for FilterOpIgnoreAttributeFilter 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 FilterOpIgnoreAttributeFilter 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.
initializeDashboard(config, permissions, correlationId)	Creates the InitializeDashboard command.
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.
isDashboardEvent(obj)	Tests whether object is an instance of IDashboardEvent.
isDashboardEventOrCustomDashboardEvent(obj)	Tests whether object is an instance of IDashboardEvent or ICustomDashboardEvent.
isDrillDownDefinition(obj)	(BETA) Type-guard testing whether the provided object is an instance of IDrillDownDefinition.
modifyDrillsForInsightWidget(ref, drills, 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.
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.
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.
newDashboardItem(widget, sizeOrColSize)	Creates a new dashboard item containing the provided custom widget.
newDashboardSection(titleOrHeader, items)	Creates a new dashboard section.
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.
removeAlerts(refs, correlationId)	(BETA) Creates the RemoveAlerts command. Dispatching this command will result in the removing Kpi alerts on the backend.
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.
removeDrillForKpiWidget(ref, correlationId)	(BETA) Creates the RemoveDrillForKpiWidget command. Dispatching this command will result in KPI having its drill removed.
removeDrillsForInsightWidget(ref, origins, correlationId)	(BETA) Creates the RemoveDrillsForInsightWidget command. Dispatching the created command will remove insight widget's drill definition for the provided measure.
removeLayoutSection(index, stashIdentifier, correlationId)	(BETA) Creates the RemoveLayoutSection 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.
replaceInsightWidgetFilterSettings(ref, settings, correlationId)	(BETA) Creates the ChangeInsightWidgetFilterSettings command for FilterOpReplaceAll operation.Dispatching this command will result in replacement of Insight 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.
replaceInsightWidgetIgnoredFilters(ref, displayForms, correlationId)	(BETA) Creates the ChangeInsightWidgetFilterSettings command for FilterOpReplaceAttributeIgnores 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 FilterOpReplaceAttributeIgnores 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.
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.
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 of the dashboard and have their own lifecycle.
resizeHeight(sectionIndex, itemIndexes, height, correlationId)	(BETA) Creates the ResizeHeight command.
resizeWidth(sectionIndex, itemIndex, width, correlationId)	(BETA) Creates the ResizeWidth command.
resolveAsyncRender(id, correlationId)	Notify the dashboard about resolved asynchronous rendering of the component.
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.
saveScheduledEmail(scheduledEmail, filterContextRef, correlationId)	(BETA) Saves existing SaveScheduledEmail command. Dispatching this command will result in saving scheduled email on the backend.
setAttributeFilterDisplayForm(filterLocalId, displayForm)	(BETA) Creates the SetAttributeFilterDisplayForm 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.
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 UpsertExecutionResult command that makes the relevant execution result set new result data and stop loading.
setExecutionResultError(id, error, correlationId)	(BETA) Creates an UpsertExecutionResult command that makes the relevant execution result indicate an error and stop loading.
setExecutionResultLoading(id, correlationId)	(BETA) Creates an UpsertExecutionResult command that makes the relevant execution result indicate it is loading.
singleEventTypeHandler(type, handler)	Creates a DashboardEventHandler instance that will be invoked for one specified event type.
switchToEditRenderMode(correlationId)	(BETA) Creates the ChangeRenderMode command for switch to edit mode.
triggerEvent(eventBody, correlationId)	(BETA) Creates an TriggerEvent command.
undoLayoutChanges(undoPointSelector, correlationId)	(BETA) Creates the UndoLayoutChanges command.
unignoreFilterOnInsightWidget(ref, oneOrMoreDisplayForms, correlationId)	(BETA) Creates the ChangeInsightWidgetFilterSettings command for FilterOpUnignoreAttributeFilter 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 FilterOpUnignoreAttributeFilter 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.
updateAlert(alert, correlationId)	(BETA) Creates the UpdateAlert command. Dispatching this command will result in the updating Kpi alert on the backend.
useCustomWidgetExecutionDataView({ 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, 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.
useInsightWidgetDataView(config)	This hook provides an easy way to read a data view from insight widget.
userInteractionTriggered(interactionPayloadOrType, correlationId)	(BETA) Creates the DashboardUserInteractionTriggered event body.
useWidgetFilters(widget, insight)	Hook for obtaining the effective filters for a widget.

Interfaces

Interface	Description
AddAttributeFilter	(BETA)
AddAttributeFilterPayload	(BETA) Payload of the AddAttributeFilter command.
AddLayoutSection	(BETA)
AddLayoutSectionPayload	(BETA) Payload of the AddLayoutSection command.
AddSectionItems	(BETA)
AddSectionItemsPayload	(BETA) Payload of the AddSectionItems command.
BackendCapabilitiesState
BareUserInteractionPayload	(BETA)
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.
ChangeFilterContextSelectionPayload	Payload of the ChangeFilterContextSelection command.
ChangeInsightWidgetDescription	(BETA)
ChangeInsightWidgetDescriptionPayload	(BETA) Payload of the ChangeInsightWidgetDescription command.
ChangeInsightWidgetFilterSettings	(BETA)
ChangeInsightWidgetFilterSettingsPayload	(BETA) Payload of the ChangeInsightWidgetFilterSettings command.
ChangeInsightWidgetHeader	(BETA)
ChangeInsightWidgetHeaderPayload	(BETA) Payload of the ChangeInsightWidgetHeader command.
ChangeInsightWidgetInsight	(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.
ChangeInsightWidgetInsightPayload	(BETA) Payload of the ChangeInsightWidgetInsight command.
ChangeInsightWidgetVisConfiguration	(BETA)
ChangeInsightWidgetVisConfigurationPayload	(BETA) Payload of the ChangeInsightWidgetVisConfiguration command.
ChangeInsightWidgetVisProperties	(BETA)
ChangeInsightWidgetVisPropertiesPayload	(BETA) Payload of the ChangeInsightWidgetVisProperties command.
ChangeKpiWidgetComparison	(BETA)
ChangeKpiWidgetComparisonPayload	(BETA) Payload of the ChangeKpiWidgetComparison command.
ChangeKpiWidgetConfiguration	(BETA)
ChangeKpiWidgetConfigurationPayload	(BETA) Payload of the ChangeKpiWidgetConfiguration command.
ChangeKpiWidgetDescription	(BETA)
ChangeKpiWidgetDescriptionPayload	(BETA) Payload of the ChangeKpiWidgetDescription command.
ChangeKpiWidgetFilterSettings	(BETA)
ChangeKpiWidgetFilterSettingsPayload	(BETA) Payload of the ChangeKpiWidgetFilterSettings command.
ChangeKpiWidgetHeader	(BETA)
ChangeKpiWidgetHeaderPayload	(BETA) Payload of the ChangeKpiWidgetHeader command.
ChangeKpiWidgetMeasure	(BETA)
ChangeKpiWidgetMeasurePayload	(BETA) Payload of the ChangeKpiWidgetMeasure command.
ChangeLayoutSectionHeader	(BETA)
ChangeLayoutSectionHeaderPayload	(BETA) Payload of the ChangeLayoutSectionHeader command.
ChangeRenderMode	(BETA)
ChangeRenderModePayload	(BETA) Payload of the ChangeRenderMode command.
ChangeSharing	(BETA)
ChangeSharingPayload	(BETA) Payload of the ChangeSharing command.
CommandProcessingMeta
ConfigState
CreateAlert	(BETA) Creates Kpi alert.
CreateAlertPayload	(BETA) Payload of the CreateAlert command.
CreateScheduledEmail	(BETA) Creates scheduled email.
CreateScheduledEmailPayload	(BETA) Payload of the CreateScheduledEmail command.
DashboardAlertCreated	(BETA) This event is emitted after the Kpi alert is successfully saved.
DashboardAlertCreatedPayload	(BETA) Payload of the DashboardAlertCreated event.
DashboardAlertsRemoved	(BETA) This event is emitted after the Kpi alerts are successfully removed.
DashboardAlertsRemovedPayload	(BETA) Payload of the DashboardAlertsRemoved event.
DashboardAlertUpdated	(BETA) This event is emitted after the Kpi alert is updated.
DashboardAlertUpdatedPayload	(BETA) Payload of the DashboardAlertUpdated event.
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.
DashboardAttributeFilterAdded	(BETA) This event is emitted after a new dashboard attribute filter is successfully added into dashboard's filters.
DashboardAttributeFilterAddedPayload	(BETA) Payload of the DashboardAttributeFilterAdded event.
DashboardAttributeFilterMoved	(BETA) This event is emitted after a dashboard attribute filter is moved from one position in the filter bar to a new position
DashboardAttributeFilterMovedPayload	(BETA) Payload of the DashboardAttributeFilterMoved event.
DashboardAttributeFilterParentChanged	(BETA) This event is emitted after the parent relationships of a filter change.
DashboardAttributeFilterParentChangedPayload	(BETA) Payload of the DashboardAttributeFilterParentChanged event.
DashboardAttributeFilterRemoved	(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.
DashboardAttributeFilterRemovedPayload	(BETA) Payload of the DashboardAttributeFilterRemoved event.
DashboardAttributeFilterSelectionChanged	This event is emitted after new elements are selected and applied in an attribute filter.
DashboardAttributeFilterSelectionChangedPayload	Payload of the DashboardAttributeFilterSelectionChanged event.
DashboardCommandFailed	(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.
DashboardCommandFailedPayload	(BETA) Payload of the DashboardCommandFailed event.
DashboardCommandRejected	(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.
DashboardCommandStarted	(BETA) This event is emitted when a particular command processing starts.
DashboardCommandStartedPayload	(BETA) Payload of the DashboardCommandStarted event.
DashboardConfig	Dashboard configuration can influence the available features, look and feel and behavior of the dashboard.
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.
DashboardDeleted	(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 is reset to a state when it shows an empty dashboard.
DashboardDeletedPayload	(BETA) Payload of the DashboardDeleted event.
DashboardEventHandler	Event handlers can be registered for a dashboard.
DashboardExportToPdfRequested	(BETA) This event is emitted at the start of the 'dashboard export to PDF' command processing.
DashboardExportToPdfResolved	(BETA) This event is emitted at the end of successful 'dashboard export to PDF' command processing. In its payload, there is an uri of the resulting PDF file.
DashboardExportToPdfResolvedPayload	(BETA) Payload of the DashboardExportToPdfResolved event.
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.
DashboardInsightWidgetChanged	(BETA) This event is emitted after any change to Insight Widget configuration. It contains the entire new state of the Insight Widget.
DashboardInsightWidgetChangedPayload	(BETA) Payload of the DashboardInsightWidgetChanged event.
DashboardInsightWidgetDescriptionChanged	(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.
DashboardInsightWidgetDescriptionChangedPayload	(BETA) Payload of the DashboardInsightWidgetDescriptionChanged event.
DashboardInsightWidgetDrillsModified	(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.
DashboardInsightWidgetDrillsModifiedPayload	(BETA) Payload of the DashboardInsightWidgetDrillsModified event.
DashboardInsightWidgetDrillsRemoved	(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.
DashboardInsightWidgetDrillsRemovedPayload	(BETA) Payload of the DashboardInsightWidgetDrillsRemoved event.
DashboardInsightWidgetExportRequested	(BETA) This event is emitted after export of an insight widget is requested.
DashboardInsightWidgetExportRequestedPayload	(BETA) Payload of the DashboardInsightWidgetExportRequested event.
DashboardInsightWidgetExportResolved	(BETA) This event is emitted after export of an insight widget is resolved.
DashboardInsightWidgetExportResolvedPayload	(BETA) Payload of the DashboardInsightWidgetExportResolved event.
DashboardInsightWidgetFilterSettingsChanged	(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.
DashboardInsightWidgetFilterSettingsChangedPayload	(BETA) Payload of the DashboardInsightWidgetFilterSettingsChanged event.
DashboardInsightWidgetHeaderChanged	(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.
DashboardInsightWidgetHeaderChangedPayload	(BETA) Payload of the DashboardInsightWidgetHeaderChanged event.
DashboardInsightWidgetInsightSwitched	(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
DashboardInsightWidgetInsightSwitchedPayload	(BETA) Payload of the DashboardInsightWidgetInsightSwitched event.
DashboardInsightWidgetRefreshed	(BETA) This event is emitted after an insight widget is refreshed.
DashboardInsightWidgetRefreshedPayload	(BETA) Payload of the DashboardInsightWidgetRefreshed event.
DashboardInsightWidgetVisConfigurationChanged	(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
DashboardInsightWidgetVisConfigurationChangedPayload	(BETA) Payload of the DashboardInsightWidgetVisPropertiesChanged event.
DashboardInsightWidgetVisPropertiesChanged	(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)
DashboardInsightWidgetVisPropertiesChangedPayload	(BETA) Payload of the DashboardInsightWidgetVisPropertiesChanged event.
DashboardKpiWidgetChanged	(BETA) This event is emitted after any change to KPI Widget configuration. It contains the entire new state of the KPI Widget.
DashboardKpiWidgetChangedPayload	(BETA) Payload of the DashboardKpiWidgetChanged event.
DashboardKpiWidgetComparisonChanged	(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.
DashboardKpiWidgetComparisonChangedPayload	(BETA) Payload of the DashboardKpiWidgetComparisonChanged event.
DashboardKpiWidgetConfigurationChanged	(BETA) This event is emitted when the dashboard's KPI Widget configuration is modified.
DashboardKpiWidgetConfigurationChangedPayload	(BETA) Payload of the DashboardKpiWidgetConfigurationChanged event.
DashboardKpiWidgetDescriptionChanged	(BETA) This event is emitted when the dashboard's KPI Widget description is modified.
DashboardKpiWidgetDescriptionChangedPayload	(BETA) Payload of the DashboardKpiWidgetDescriptionChanged event.
DashboardKpiWidgetDrillRemoved	(BETA) This event is emitted when dashboard's KPI Widget has its drills removed.
DashboardKpiWidgetDrillRemovedPayload	(BETA) Payload of the DashboardKpiWidgetDrillRemoved event.
DashboardKpiWidgetDrillSet	(BETA) This event is emitted when dashboard's KPI Widget has its drill set.
DashboardKpiWidgetDrillSetPayload	(BETA) Payload of the DashboardKpiWidgetDrillSet event.
DashboardKpiWidgetFilterSettingsChanged	(BETA) This event is emitted when dashboard's KPI Widget filter settings are modified.
DashboardKpiWidgetFilterSettingsChangedPayload	(BETA) Payload of the DashboardKpiWidgetFilterSettingsChanged event.
DashboardKpiWidgetHeaderChanged	(BETA) This event is emitted when the dashboard's KPI Widget header is modified.
DashboardKpiWidgetHeaderChangedPayload	(BETA) Payload of the DashboardKpiWidgetHeaderChanged event.
DashboardKpiWidgetMeasureChanged	(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 with a change of the KPI header (change of title). In that case new value of header is also included in the event.
DashboardKpiWidgetMeasureChangedPayload	(BETA) Payload of the DashboardKpiWidgetMeasureChanged event.
DashboardLayoutChanged	(BETA) This event is emitted after any change to the dashboard layout and will include the entire new layout.
DashboardLayoutChangedPayload	(BETA) Payload of the DashboardLayoutChanged event.
DashboardLayoutSectionAdded	(BETA) This event is emitted when a new dashboard layout section is added.
DashboardLayoutSectionAddedPayload	(BETA) Payload of the DashboardLayoutSectionAdded event.
DashboardLayoutSectionHeaderChanged	(BETA) This event is emitted when dashboard layout section changes.
DashboardLayoutSectionHeaderChangedPayload	(BETA) Payload of the DashboardLayoutSectionHeaderChanged event.
DashboardLayoutSectionItemMoved	(BETA) This event is emitted when a dashboard item is moved between sections or within a section.
DashboardLayoutSectionItemMovedPayload	(BETA) Payload of the DashboardLayoutSectionItemMoved event.
DashboardLayoutSectionItemRemoved	(BETA) This event is emitted when an item is removed from dashboard layout section.
DashboardLayoutSectionItemRemovedPayload	(BETA) Payload of the DashboardLayoutSectionItemRemoved event.
DashboardLayoutSectionItemReplaced	(BETA) This event is emitted when an item in a dashboard section is replaced.
DashboardLayoutSectionItemReplacedPayload	(BETA) Payload of the DashboardLayoutSectionItemReplaced event.
DashboardLayoutSectionItemsAdded	(BETA) This event is emitted when items are added to a dashboard section.
DashboardLayoutSectionItemsAddedPayload	(BETA) Payload of the DashboardLayoutSectionItemsAdded event.
DashboardLayoutSectionMoved	(BETA) This event is emitted when a dashboard layout section is moved from one place to another.
DashboardLayoutSectionMovedPayload	(BETA) Payload of the DashboardLayoutSectionMoved event.
DashboardLayoutSectionRemoved	(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.
DashboardLayoutSectionRemovedPayload	(BETA) Payload of the DashboardLayoutSectionRemoved event.
DashboardMetaState	(BETA)
DashboardModelCustomizationFns
DashboardPermissionsState
DashboardPluginDescriptor	Basic set of information about a Dashboard plugin.
DashboardQueryCompleted	(BETA) This event is emitted when query processing completes with success. Both the query payload and the result are included.
DashboardQueryCompletedPayload	(BETA) Payload of the DashboardQueryCompleted event.
DashboardQueryFailed	(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.
DashboardQueryFailedPayload	(BETA) Payload of the DashboardQueryFailed event.
DashboardQueryRejected	(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.
DashboardQueryStarted	(BETA) This event is emitted when query processing starts.
DashboardQueryStartedPayload	(BETA) Payload of the DashboardQueryStarted event.
DashboardRenamed	(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.
DashboardRenamedPayload	(BETA) Payload of the DashboardRenamed event.
DashboardRenderModeChanged	(BETA) This event is emitted after render mode change.
DashboardRenderModeChangedPayload	(BETA) Payload of the DashboardRenderModeChanged event.
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.
DashboardScheduledEmailCreated	(BETA) This event is emitted after the scheduled email is successfully created.
DashboardScheduledEmailCreatedPayload	(BETA) Payload of the DashboardScheduledEmailCreated event.
DashboardScheduledEmailSaved	(BETA) This event is emitted after the scheduled email is successfully saved.
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.
DashboardUserInteractionTriggered	(BETA) This event is emitted after the user interaction that cannot be tracked by other existing events is triggered.
DashboardWasReset	(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.
DashboardWasResetPayload	(BETA) Payload of the DashboardWasReset event.
DashboardWidgetExecutionFailed	(BETA) This event is emitted after execution of an insight widget fails.
DashboardWidgetExecutionFailedPayload	(BETA) Payload of the DashboardWidgetExecutionFailed event.
DashboardWidgetExecutionStarted	(BETA) This event is emitted after execution of an insight widget starts.
DashboardWidgetExecutionStartedPayload	(BETA) Payload of the DashboardWidgetExecutionStarted event.
DashboardWidgetExecutionSucceeded	(BETA) This event is emitted after execution of an insight widget succeeds.
DashboardWidgetExecutionSucceededPayload	(BETA) Payload of the DashboardWidgetExecutionSucceeded event.
DateFilterConfigState	(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.
DeleteDashboard	(BETA)
DrillState	(BETA)
EntitlementsState	(BETA)
ExportDashboardToPdf	(BETA)
ExportInsightWidget	(BETA)
ExportInsightWidgetPayload	(BETA) Payload of the ExportInsightWidget command.
FilterContextState
FilterOp	(BETA)
FilterOpDisableDateFilter	(BETA) This filter operation disabled date filtering for the widget.
FilterOpEnableDateFilter	(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.
FilterOpIgnoreAttributeFilter	(BETA) This filter operation appends one or more attribute filters into the widget's filter ignore-list.
FilterOpReplaceAll	(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.
FilterOpReplaceAttributeIgnores	(BETA) This filter operation replaces the setting which determines which of the dashboard's attribute filters should be ignored for the widget.
FilterOpUnignoreAttributeFilter	(BETA) This filter operation removes one or more attribute filters from the widget's filter ignore-list.
IAttributeFiltersCustomizer	Set of functions you can use to customize how attribute filters are rendered.
IButtonBarProps	(BETA)
ICancelButtonProps	(BETA)
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.
IDashboardAttributeFilterProps
IDashboardBaseProps
IDashboardCommand	Base type for all commands.
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 customization.
IDashboardCustomizer
IDashboardDateFilterConfig	Defines the configuration of the DateFilter component.
IDashboardDateFilterProps
IDashboardDrillEvent	(BETA) A IDrillEvent with added information about the drill event specific to the Dashboard context.
IDashboardEngine	Dashboard Engine encapsulates a particular build of the 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	eventing configuration
IDashboardExtensionProps	Cumulative properties for customization.
IDashboardInsightCustomizer	Set of functions you can use to customize how insights are rendered.
IDashboardInsightProps	Insight widget props.
IDashboardKpiCustomizer	Set of functions you can use to customize how KPIs are rendered.
IDashboardKpiProps	KPI Widget props
IDashboardLayoutCustomizer	Set of functions you can use to customize the layout of the dashboard rendered.
IDashboardPluginContract_V1	Raw, low-level interface that the dashboard plugins need to implement.
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.
IDashboardThemingProps
IDashboardWidgetCustomizer	Set of functions you can use to customize custom widgets.
IDashboardWidgetOverlay	(BETA)
IDashboardWidgetProps	Dashboard widget props.
IDashboardWidgetsOverlayProps	Properties for widgets overlay.
IDateFiltersCustomizer	Set of functions you can use to customize how date filters are rendered.
IDrillDownDefinition	(BETA) Information about the DrillDown interaction - the attribute that is next in the drill down hierarchy.
IEditButtonProps	(BETA)
IExecutionResultEnvelope	(BETA)
IFilterBarCustomizer	Set of functions you can use to customize some aspects of the FilterBar.
IFiltersCustomizer	Set of functions you can use to customize rendering of the filters.
IFluidLayoutCustomizer	Set of functions you can use to customize the fluid layout of the dashboard rendered.
IInsightMenuItemButton	(BETA)
IInsightMenuItemSeparator	(BETA)
IInsightMenuSubmenu	(BETA)
ILayoutCoordinates	(BETA) Coordinates of an item in a layout.
IMenuButtonItemsVisibility	(BETA)
InitializeDashboard	Loads dashboard from analytical backend.
InitializeDashboardPayload	Payload of the InitializeDashboard command.
ISaveAsNewButtonProps	(BETA)
ISaveButtonProps	(BETA)
IShareButtonProps	(BETA)
ISharingProperties	All sharing properties describing sharing changes
IUseCustomWidgetExecutionDataViewConfig	Configuration options for the useCustomWidgetExecutionDataView() hook.
IUseCustomWidgetInsightDataViewConfig	Configuration options for the useCustomWidgetInsightDataView() hook.
IUseInsightWidgetDataView	Configuration for the useInsightWidgetDataView hook.
IXlsxExportConfig	(BETA)
KpiWidgetComparison	(BETA)
LegacyDashboardsState
LoadingState	(BETA)
ModifyDrillsForInsightWidget	(BETA)
ModifyDrillsForInsightWidgetPayload	(BETA) Payload of the ModifyDrillsForInsightWidget command.
MoveAttributeFilter	(BETA)
MoveAttributeFilterPayload	(BETA) Payload of the MoveAttributeFilter command.
MoveLayoutSection	(BETA)
MoveLayoutSectionPayload	(BETA) Payload of the MoveLayoutSection command.
MoveSectionItem	(BETA)
MoveSectionItemPayload	(BETA) Payload of the MoveSectionItem command.
MoveSectionItemToNewSection	(BETA)
MoveSectionItemToNewSectionPayload	(BETA) Payload of the MoveSectionItemToNewSection command.
ObjectAvailabilityConfig	Dashboard component may offer users to pick objects to use on the dashboard.
PermissionsState
QueryProcessingErrorState
QueryProcessingPendingState
QueryProcessingRejectedState
QueryProcessingRunningState
QueryProcessingSuccessState
RefreshInsightWidget	(BETA)
RefreshInsightWidgetPayload	(BETA) Payload of the RefreshInsightWidget command.
RefreshKpiWidget	(BETA)
RefreshKpiWidgetPayload	(BETA) Payload of the RefreshKpiWidget command.
RemoveAlerts	(BETA) Removes Kpi alerts.
RemoveAlertsPayload	(BETA) Payload of the RemoveAlerts command.
RemoveAttributeFilters	(BETA)
RemoveAttributeFiltersPayload	(BETA) Payload of the RemoveAttributeFilters command.
RemoveDrillForKpiWidget	(BETA)
RemoveDrillForKpiWidgetPayload	(BETA) Payload of the RemoveDrillForKpiWidget command.
RemoveDrillsForInsightWidget	(BETA)
RemoveDrillsForInsightWidgetPayload	(BETA) Payload of the RemoveDrillsForInsightWidget command.
RemoveLayoutSection	(BETA)
RemoveLayoutSectionPayload	(BETA) Payload of the RemoveLayoutSection command.
RemoveSectionItem	(BETA)
RemoveSectionItemByWidgetRef	(BETA)
RemoveSectionItemByWidgetRefPayload	(BETA) Payload of the RemoveSectionItemByWidgetRef command.
RemoveSectionItemPayload	(BETA) Payload of the RemoveSectionItem command.
RenameDashboard	(BETA)
RenameDashboardPayload	(BETA) Payload of the RenameDashboard command.
RenderModeChangeOptions	(BETA)
RenderModeState	(BETA)
ReplaceSectionItem	(BETA)
ReplaceSectionItemPayload	(BETA) Payload of the ReplaceSectionItem command.
RequestAsyncRender
RequestAsyncRenderPayload	Payload of the RequestAsyncRender command.
ResetDashboard	(BETA)
ResizeHeight	(BETA)
ResizeHeightPayload	(BETA) Payload of the ResizeHeight command.
ResizeWidth	(BETA)
ResizeWidthPayload	(BETA) Payload of the ResizeWidth command.
ResolveAsyncRender
ResolveAsyncRenderPayload	Payload of the ResolveAsyncRender command.
SaveDashboard	(BETA)
SaveDashboardAs
SaveDashboardAsPayload	Payload of the SaveDashboardAs command.
SaveDashboardPayload	(BETA) Payload of the SaveDashboard command.
SaveScheduledEmail	(BETA) Saves scheduled email.
SaveScheduledEmailPayload	(BETA) Payload of the SaveScheduledEmail command.
SavingState
SetAttributeFilterDisplayForm	(BETA)
SetAttributeFilterDisplayFormPayload	(BETA)
SetAttributeFilterParents	(BETA)
SetAttributeFilterParentsPayload	(BETA) Payload of the SetAttributeFilterParents command.
SetDrillForKpiWidget	(BETA)
SetDrillForKpiWidgetPayload	(BETA) Payload of the SetDrillForKpiWidget command.
TriggerEvent	(BETA) Triggers an event.
TriggerEventPayload	(BETA) Payload of the TriggerEvent command.
UiState	(BETA)
UndoLayoutChanges	(BETA)
UndoLayoutChangesPayload	(BETA) Payload of the UndoLayoutChanges command.
UpdateAlert	(BETA) Updates Kpi alert.
UpdateAlertPayload	(BETA) Payload of the UpdateAlert command.
UpsertExecutionResult	(BETA) Triggers an event.
UseDashboardAsyncRender	Callbacks returned from useDashboardAsyncRender hook.
UserInteractionPayloadWithDataBase	(BETA)
UserState
WidgetDescription	(BETA)
WidgetHeader	(BETA)

Variables

Variable	Description
DefaultDashboardInsight	Default implementation of the Dashboard Insight widget.
defaultDashboardThemeModifier	(BETA) Default modifier applied to any theme passed to Dashboard component
InitialLoadCorrelationId	(BETA) The initial load of the dashboard will use this correlation id.
isDashboardAlertCreated	(BETA) Tests whether the provided object is an instance of DashboardAlertCreated.
isDashboardAlertsRemoved	(BETA) Tests whether the provided object is an instance of DashboardAlertsRemoved.
isDashboardAlertUpdated	(BETA) Tests whether the provided object is an instance of DashboardAlertUpdated.
isDashboardAsyncRenderRequested	Tests whether the provided object is an instance of DashboardAsyncRenderRequested.
isDashboardAsyncRenderResolved	Tests whether the provided object is an instance of DashboardAsyncRenderResolved.
isDashboardAttributeFilterAdded	(BETA) Tests whether the provided object is an instance of DashboardAttributeFilterAdded.
isDashboardAttributeFilterMoved	(BETA) Tests whether the provided object is an instance of DashboardAttributeFilterMoved.
isDashboardAttributeFilterParentChanged	(BETA) Tests whether the provided object is an instance of DashboardAttributeFilterParentChanged.
isDashboardAttributeFilterRemoved	(BETA) Tests whether the provided object is an instance of DashboardAttributeFilterRemoved.
isDashboardAttributeFilterSelectionChanged	Tests whether the provided object is an instance of DashboardAttributeFilterSelectionChanged.
isDashboardCommandFailed	(BETA) Tests whether the provided object is an instance of DashboardCommandFailed.
isDashboardCommandRejected	(BETA) Tests whether the provided object is an instance of DashboardCommandRejected.
isDashboardCommandStarted	(BETA) Tests whether the provided object is an instance of DashboardCommandStarted.
isDashboardCopySaved	Tests whether the provided object is an instance of DashboardCopySaved.
isDashboardDateFilterSelectionChanged	Tests whether the provided object is an instance of DashboardDateFilterSelectionChanged.
isDashboardDeinitialized	Tests whether the provided object is an instance of DashboardDeinitialized.
isDashboardDeleted	(BETA) Tests whether the provided object is an instance of DashboardDeleted
isDashboardExportToPdfRequested	(BETA) Tests whether the provided object is an instance of DashboardExportToPdfRequested.
isDashboardExportToPdfResolved	(BETA) Tests whether the provided object is an instance of DashboardExportToPdfResolved.
isDashboardFilterContextChanged	Tests whether the provided object is an instance of DashboardFilterContextChanged.
isDashboardInitialized	Tests whether the provided object is an instance of DashboardInitialized.
isDashboardInsightWidgetChanged	(BETA) Tests whether the provided object is an instance of DashboardInsightWidgetChanged.
isDashboardInsightWidgetDescriptionChanged	(BETA) Tests whether the provided object is an instance of DashboardInsightWidgetDescriptionChanged.
isDashboardInsightWidgetDrillsModified	(BETA) Tests whether the provided object is an instance of DashboardInsightWidgetDrillsModified.
isDashboardInsightWidgetDrillsRemoved	(BETA) Tests whether the provided object is an instance of DashboardInsightWidgetDrillsRemoved.
isDashboardInsightWidgetExportRequested	(BETA) Tests whether the provided object is an instance of DashboardInsightWidgetExportRequested.
isDashboardInsightWidgetExportResolved	(BETA) Tests whether the provided object is an instance of DashboardInsightWidgetExportResolved.
isDashboardInsightWidgetFilterSettingsChanged	(BETA) Tests whether the provided object is an instance of DashboardInsightWidgetFilterSettingsChanged.
isDashboardInsightWidgetHeaderChanged	(BETA) Tests whether the provided object is an instance of DashboardInsightWidgetHeaderChanged.
isDashboardInsightWidgetInsightSwitched	(BETA) Tests whether the provided object is an instance of DashboardInsightWidgetInsightSwitched.
isDashboardInsightWidgetRefreshed	(BETA) Tests whether the provided object is an instance of DashboardInsightWidgetRefreshed.
isDashboardInsightWidgetVisConfigurationChanged	(BETA) Tests whether the provided object is an instance of DashboardInsightWidgetVisConfigurationChanged.
isDashboardInsightWidgetVisPropertiesChanged	(BETA) Tests whether the provided object is an instance of DashboardInsightWidgetVisPropertiesChanged.
isDashboardKpiWidgetChanged	(BETA) Tests whether the provided object is an instance of DashboardKpiWidgetChanged.
isDashboardKpiWidgetComparisonChanged	(BETA) Tests whether the provided object is an instance of DashboardKpiWidgetComparisonChanged.
isDashboardKpiWidgetConfigurationChanged	(BETA) Tests whether the provided object is an instance of DashboardKpiWidgetConfigurationChanged.
isDashboardKpiWidgetDescriptionChanged	(BETA) Tests whether the provided object is an instance of DashboardKpiWidgetDescriptionChanged.
isDashboardKpiWidgetDrillRemoved	(BETA) Tests whether the provided object is an instance of DashboardKpiWidgetDrillRemoved.
isDashboardKpiWidgetDrillSet	(BETA) Tests whether the provided object is an instance of DashboardKpiWidgetDrillSet.
isDashboardKpiWidgetFilterSettingsChanged	(BETA) Tests whether the provided object is an instance of DashboardKpiWidgetFilterSettingsChanged.
isDashboardKpiWidgetHeaderChanged	(BETA) Tests whether the provided object is an instance of DashboardKpiWidgetHeaderChanged.
isDashboardKpiWidgetMeasureChanged	(BETA) Tests whether the provided object is an instance of DashboardKpiWidgetMeasureChanged.
isDashboardLayoutChanged	(BETA) Tests whether the provided object is an instance of DashboardLayoutChanged.
isDashboardLayoutSectionAdded	(BETA) Tests whether the provided object is an instance of DashboardLayoutSectionAdded.
isDashboardLayoutSectionHeaderChanged	(BETA) Tests whether the provided object is an instance of DashboardLayoutSectionHeaderChanged.
isDashboardLayoutSectionItemMoved	(BETA) Tests whether the provided object is an instance of DashboardLayoutSectionItemMoved.
isDashboardLayoutSectionItemRemoved	(BETA) Tests whether the provided object is an instance of DashboardLayoutSectionItemRemoved.
isDashboardLayoutSectionItemReplaced	(BETA) Tests whether the provided object is an instance of DashboardLayoutSectionItemReplaced.
isDashboardLayoutSectionItemsAdded	(BETA) Tests whether the provided object is an instance of DashboardLayoutSectionItemsAdded.
isDashboardLayoutSectionMoved	(BETA) Tests whether the provided object is an instance of DashboardLayoutSectionMoved.
isDashboardLayoutSectionRemoved	(BETA) Tests whether the provided object is an instance of DashboardLayoutSectionRemoved.
isDashboardQueryCompleted	(BETA) Tests whether the provided object is an instance of DashboardQueryCompleted.
isDashboardQueryFailed	(BETA) Tests whether the provided object is an instance of DashboardCommandFailed.
isDashboardQueryRejected	(BETA) Tests whether the provided object is an instance of DashboardQueryRejected.
isDashboardQueryStarted	(BETA) Tests whether the provided object is an instance of DashboardQueryStarted.
isDashboardRenamed	(BETA) Tests whether the provided object is an instance of DashboardRenamed.
isDashboardRenderModeChanged	(BETA) Tests whether the provided object is an instance of DashboardRenderModeChanged.
isDashboardRenderRequested	Tests whether the provided object is an instance of DashboardRenderRequested.
isDashboardRenderResolved	Tests whether the provided object is an instance of DashboardRenderResolved.
isDashboardSaved	Tests whether the provided object is an instance of DashboardSaved.
isDashboardScheduledEmailCreated	(BETA) Tests whether the provided object is an instance of DashboardScheduledEmailCreated.
isDashboardScheduledEmailSaved	(BETA) Tests whether the provided object is an instance of DashboardScheduledEmailSaved.
isDashboardSharingChanged	Tests whether the provided object is an instance of DashboardSharingChanged.
isDashboardUserInteractionTriggered	(BETA) Tests whether the provided object is an instance of DashboardUserInteractionTriggered.
isDashboardWasReset	(BETA) Tests whether the provided object is an instance of DashboardWasReset.
isDashboardWidgetExecutionFailed	(BETA) Tests whether the provided object is an instance of DashboardWidgetExecutionFailed.
isDashboardWidgetExecutionStarted	(BETA) Tests whether the provided object is an instance of DashboardWidgetExecutionStarted.
isDashboardWidgetExecutionSucceeded	(BETA) Tests whether the provided object is an instance of DashboardWidgetExecutionSucceeded.
isDateFilterValidationFailed	(BETA) Tests whether the provided object is an instance of DateFilterValidationFailed.
selectAttributeFilterDescendants	Creates a selector for selecting all descendants of the attribute filter with given localId.
selectAttributeFilterDisplayForms	Selects list of display form metadata objects referenced by attribute filters.
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.
selectCanCreateAnalyticalDashboard	Returns whether the current user has permissions to create a KPI dashboard object via API.
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 to PDF
selectCanExportReport	Returns whether the current user has permissions necessary to export insights.
selectCanExportTabular	Returns whether the current user has permissions necessary to export insights to 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
selectCatalogAttributes
selectCatalogDateDatasets
selectCatalogFacts
selectCatalogMeasures
selectColorPalette	Returns the color palette for dashboard charts.
selectConfig	Returns dashboard's config.
selectCurrentUser	This selector returns current logged in user.
selectCurrentUserRef	This selector returns current logged in user ref.
selectDashboardDescription	Selects current dashboard description.
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.
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.
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.
selectDateFilterConfig	Returns workspace-level configuration for the of the date filter options and presets.
selectDateFormat	Returns date format.
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.
selectEnableClickableAttributeURL	Returns whether implicit drill to attributes url enabled
selectEnableCompanyLogoInEmbeddedUI	Returns whether company logo should be visible in embedded dashboard.
selectEnableFilterValuesResolutionInDrillEvents	Returns whether filter values in drill events should be resolved.
selectEnableInsightExportScheduling	Returns whether insight export scheduling is enabled.
selectEnableKPIDashboardDrillFromAttribute	Returns whether drill fromAttribute is enabled
selectEnableKPIDashboardDrillToDashboard	Returns whether the drill to dashboard is enabled.
selectEnableKPIDashboardDrillToInsight	Returns whether drill to insight is enabled
selectEnableKPIDashboardDrillToURL	Returns whether drill to url is enabled
selectEnableKPIDashboardExportPDF	Returns whether the export to pdf is enabled.
selectEnableKPIDashboardImplicitDrillDown	Returns whether implicit drill to attributes url enabled
selectEnableKPIDashboardSaveAsNew	Returns whether the save as new dashboard functionality is enabled.
selectEnableKPIDashboardSchedule	Returns whether the current user can schedule emails.
selectEnableKPIDashboardScheduleRecipients	Returns whether the current user can share scheduled email to other recipients.
selectFilterContextAttributeFilterByDisplayForm	Creates a selector for selecting attribute filter by its displayForm ObjRef.
selectFilterContextAttributeFilters	This selector returns dashboard's filter context attribute filters.
selectFilterContextDateFilter	This selector returns dashboard's filter context date filter.
selectFilterContextDefinition	This selector returns current dashboard's filter context definition.
selectFilterContextFilters	This selector returns dashboard's filter context filters.
selectHideKpiDrillInEmbedded	Returns whether Kpi drills in embedded mode are disabled.
selectInsights	Selects all insights used on the dashboard.
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.
selectIsReadOnly	Returns whether the Dashboard is executed in read-only mode.
selectLocale	Returns locale to use for internationalization of the dashboard.
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.
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.
useDashboardAsyncRender	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 2 seconds of the DashboardInitialized event. (If you do not register any asynchronous rendering, after 2 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 2 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.
useDashboardSelector	Hook for retrieving data from the dashboard state.
useDispatchDashboardCommand	Hook that takes command creator and returns function that will result into dispatching this command.
useParentFilters	Returns parent filtering input props for AttributeFilter for particular dashboard attribute filter.

Type Aliases

Type Alias	Description
ActionFailedErrorReason	(BETA)
AttributeFilterComponentProvider
AttributeFilterSelectionType	Attribute filter selection type for ChangeAttributeFilterSelectionPayload.
BareUserInteractionType	(BETA)
CustomButtonBarComponent	(BETA)
CustomCancelButtonComponent	(BETA)
CustomDashboardAttributeFilterComponent
CustomDashboardDateFilterComponent
CustomDashboardInsightComponent
CustomDashboardKpiComponent
CustomDashboardWidgetComponent
CustomEditModeButtonComponent	(BETA)
CustomSaveAsNewButtonComponent	(BETA)
CustomSaveButtonComponent	(BETA)
DashboardCommands	Union type that contains all available built-in dashboard commands.
DashboardCommandType	All available command types.
DashboardDescriptor
DashboardDispatch
DashboardDrillDefinition	(BETA) Supported dashboard drill definitions.
DashboardEventBody
DashboardEventEvalFn
DashboardEventHandlerFn
DashboardEvents	Union type that contains all available built-in dashboard events.
DashboardEventType	A union of all available built-in dashboard event type names.
DashboardItemDefinition	(BETA) Definition of items that may be placed into the dashboard sections.
DashboardLayoutCommands	(BETA)
DashboardQueryType	(BETA)
DashboardSelector	Function that selects part of the Dashboard state.
DashboardSelectorEvaluator	Type of a callback that evaluates a selector function against the Dashboard state
DashboardStateChangeCallback	Callback called whenever the Dashboard's internal state changes.
DashboardTransformFn
DateFilterComponentProvider
DateFilterConfigValidationResult	Validation result.
DateFilterValidationResult
DescriptionTooltipOpenedData	(BETA)
DescriptionTooltipOpenedFrom	(BETA)
DescriptionTooltipOpenedPayload	(BETA)
DescriptionTooltipOpenedType	(BETA)
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.
ExtendedDashboardWidget	Extension of the default type to also include view-only custom widget types.
FilterBarRenderingMode	Mode of rendering of the FilterBar.
FilterOperations	(BETA)
FluidLayoutCustomizationFn
IDashboardFilter	Supported dashboard filter type.
IExportConfig	(BETA)
IInsightMenuItem	(BETA)
InsightComponentProvider
InsightMenuItemsProvider	(BETA)
KpiAlertDialogOpenedPayload	(BETA)
KpiComponentProvider
LayoutStash	(BETA)
OnFiredDashboardDrillEvent	(BETA) Callback called when a drill event occurs.
OptionalAttributeFilterComponentProvider
OptionalDateFilterComponentProvider
OptionalInsightComponentProvider
OptionalKpiComponentProvider
OptionalProvider
OptionalWidgetComponentProvider
QueryProcessingState
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)
ResolvedDashboardConfig	Dashboard configuration resolved using the config passed in via props and any essential data retrieved from backend.
ResolvedEntitlements	(BETA)
ShareDialogInteractionData	(BETA)
ShareDialogInteractionPayload	(BETA)
ShareDialogInteractionType	(BETA)
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.
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.
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)
WidgetComponentProvider
WidgetFilterOperation	(BETA) Widget's filter settings can be manipulated using multiple different granular operations. This is the union type containing all the available operations.