IUiState

IUiState.activeSectionpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

activeSection: ILayoutSectionPath | undefined;

IUiState.alertsDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

alertsDialog: {
        open: boolean;
        returnFocusTo?: string;
        context?: IAlertDialogContext;
    };

IUiState.alertsManagementDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

alertsManagementDialog: {
        open: boolean;
        context?: IAlertDialogContext;
    };

IUiState.automationsManagementpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

automationsManagement: {
        invalidationId: number;
    };

IUiState.cancelEditModeDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

cancelEditModeDialog: {
        open: boolean;
    };

IUiState.configurationPanelOpenedpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

configurationPanelOpened: boolean;

IUiState.deleteDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

deleteDialog: {
        open: boolean;
    };

IUiState.densitypropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

density: DashboardDensity;

IUiState.densityDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

densityDialog: {
        open: boolean;
    };

IUiState.draggingWidgetTargetpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

draggingWidgetTarget: ILayoutItemPath | undefined;

IUiState.drillValidationMessagespropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

drillValidationMessages: {
        invalidDrillWidgetRefs: ObjRef[];
        sanitizedDrillWidgetRefs: ObjRef[];
        invalidCustomUrlDrillParameterWidgets: IInvalidCustomUrlDrillParameterInfo[];
    };

IUiState.filterAttributeSelectionOpenpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

filterAttributeSelectionOpen: boolean;

IUiState.filterBarpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

filterBar: {
        expanded: boolean;
    };

IUiState.filterValidationMessagespropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

filterValidationMessages: {
        incompatibleDefaultFiltersOverride: boolean;
    };

IUiState.filterViewspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

filterViews: {
        open: boolean;
        mode: FilterViewDialogMode;
    };

IUiState.ignoreExecutionTimestamppropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

ignoreExecutionTimestamp: boolean;

IUiState.insightListLastUpdateRequestedpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

insightListLastUpdateRequested: number;

IUiState.insightNotSavedDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

insightNotSavedDialog: {
        open: boolean;
        saveConfirmed: boolean;
        draftInsightsToPersist: IInsight[];
    };

IUiState.kpiAlertspropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

kpiAlerts: {
        openedWidgetRef: ObjRef | undefined;
        highlightedWidgetRef: ObjRef | undefined;
    };

IUiState.kpiDeleteDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

kpiDeleteDialog: {
        widgetCoordinates: ILayoutItemPath | undefined;
    };

IUiState.menuButtonpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

menuButton: {
        itemsVisibility: IMenuButtonItemsVisibility;
    };

IUiState.saveAsDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

saveAsDialog: {
        open: boolean;
    };

IUiState.scheduleEmailDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

scheduleEmailDialog: {
        open: boolean;
        defaultAttachmentRef: ObjRef | undefined;
        returnFocusTo?: string;
        context?: IScheduleEmailContext;
    };

IUiState.scheduleEmailManagementDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

scheduleEmailManagementDialog: {
        open: boolean;
        context?: IScheduleEmailContext;
    };

IUiState.selectedFilterIndexpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

selectedFilterIndex: number | undefined;

IUiState.selectedWidgetRefpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

selectedWidgetRef: ObjRef | undefined;

IUiState.settingsDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

settingsDialog: {
        open: boolean;
    };

IUiState.shareDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

shareDialog: {
        open: boolean;
    };

IUiState.timezoneDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

timezoneDialog: {
        open: boolean;
    };

IUiState.timezoneOverridepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Session-only ad-hoc timezone override selected by the viewer in view mode. Always a concrete IANA timezone ID — never the browser-detected sentinel. Undefined means no override is active (the dashboard/workspace configuration applies). This value is never persisted with the dashboard.

timezoneOverride: string | undefined;

IUiState.widgetDateDatasetAutoSelectpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

widgetDateDatasetAutoSelect: boolean;

IUiState.widgetDeleteDialogpropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

widgetDeleteDialog: {
        open: boolean;
        widgetRef: ObjRef | undefined;
    };

IUiState.widgetsLoadingAdditionalDatapropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

widgetsLoadingAdditionalData: ObjRef[];

IUiState.widgetsOverlaypropertyBeta

Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.

widgetsOverlay: Record<string, IDashboardWidgetOverlay>;