UiState

Home > @gooddata/sdk-ui-dashboard > UiState

UiState interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Signature:

export interface UiState 

Properties

Property	Modifiers	Type	Description
activeSection		ILayoutSectionPath | undefined	(BETA)
alertsDialog		{ open: boolean; returnFocusTo?: string; context?: IAlertDialogContext; }	(BETA)
alertsManagementDialog		{ open: boolean; context?: IAlertDialogContext; }	(BETA)
automationsInvalidateRef?		() => void	(ALPHA) (Optional) Ref to invalidate automations list - gets populated by Automations component when it mounts
automationsManagement		{ invalidateItemsRef?: MutableRefObject<() => void>; }	(BETA)
cancelEditModeDialog		{ open: boolean; }	(BETA)
configurationPanelOpened		boolean	(BETA)
deleteDialog		{ open: boolean; }	(BETA)
draggingWidgetTarget		ILayoutItemPath | undefined	(BETA)
drillValidationMessages		{ invalidDrillWidgetRefs: ObjRef[]; invalidCustomUrlDrillParameterWidgets: InvalidCustomUrlDrillParameterInfo[]; }	(ALPHA)
filterAttributeSelectionOpen		boolean	(BETA)
filterBar		{ expanded: boolean; }	(BETA)
filterValidationMessages		{ incompatibleDefaultFiltersOverride: boolean; }	(BETA)
filterViews		{ open: boolean; mode: FilterViewDialogMode; }	(BETA)
ignoreExecutionTimestamp		boolean	(BETA)
insightListLastUpdateRequested		number	(BETA)
kpiAlerts		{ openedWidgetRef: ObjRef | undefined; highlightedWidgetRef: ObjRef | undefined; }	(BETA)
kpiDeleteDialog		{ widgetCoordinates: ILayoutItemPath | undefined; }	(BETA)
menuButton		{ itemsVisibility: IMenuButtonItemsVisibility; }	(BETA)
saveAsDialog		{ open: boolean; }	(BETA)
scheduleEmailDialog		{ open: boolean; defaultAttachmentRef: ObjRef | undefined; returnFocusTo?: string; context?: IScheduleEmailContext; }	(BETA)
scheduleEmailManagementDialog		{ open: boolean; context?: IScheduleEmailContext; }	(BETA)
selectedFilterIndex		number | undefined	(BETA)
selectedWidgetRef		ObjRef | undefined	(BETA)
settingsDialog		{ open: boolean; }	(BETA)
shareDialog		{ open: boolean; }	(BETA)
widgetDateDatasetAutoSelect		boolean	(BETA)
widgetDeleteDialog		{ open: boolean; widgetRef: ObjRef | undefined; }	(BETA)
widgetsLoadingAdditionalData		ObjRef[]	(BETA)
widgetsOverlay		Record<string, IDashboardWidgetOverlay>	(BETA)