@gooddata/sdk-ui-dashboard 10.20.0-alpha.9 → 10.20.0

package/esm/sdk-ui-dashboard.d.ts

@@ -18,7 +18,6 @@ import { CaseReducer } from '@reduxjs/toolkit';
 import { CaseReducerActions } from '@reduxjs/toolkit';
 import { CatalogState as CatalogState_2 } from './catalogState.js';
 import { CommandProcessingStatus as CommandProcessingStatus_2 } from '../../../model/index.js';
-import { Component } from 'react';
 import { ComponentPropsWithRef } from 'react';
 import { ComponentType } from 'react';
 import { CreateAttributeHierarchyRequested as CreateAttributeHierarchyRequested_2 } from '../events/attributeHierarchies.js';
@@ -145,6 +144,7 @@ import { IAttributeFilter } from '@gooddata/sdk-model';
 import { IAttributeFilterBaseProps } from '@gooddata/sdk-ui-filters';
 import { IAttributeMetadataObject } from '@gooddata/sdk-model';
 import { IAttributeOrMeasure } from '@gooddata/sdk-model';
+import { IAttributeWithReferences } from '@gooddata/sdk-backend-spi';
 import { IAutomationMetadataObject } from '@gooddata/sdk-model';
 import { IAutomationMetadataObjectDefinition } from '@gooddata/sdk-model';
 import { IAvailableDrillTargets } from '@gooddata/sdk-ui';
@@ -183,6 +183,7 @@ import { IDashboardLayoutSectionHeader } from '@gooddata/sdk-model';
 import { IDashboardLayoutSizeByScreenSize } from '@gooddata/sdk-model';
 import { IDashboardObjectIdentity } from '@gooddata/sdk-model';
 import { IDashboardPermissions } from '@gooddata/sdk-model';
+import { IDashboardReferences } from '@gooddata/sdk-backend-spi';
 import { IDashboardRichTextProps as IDashboardRichTextProps_2 } from './types.js';
 import { IDashboardVisualizationSwitcherProps as IDashboardVisualizationSwitcherProps_2 } from './types.js';
 import { IDashboardWidget } from '@gooddata/sdk-model';
@@ -212,6 +213,7 @@ import { IExecutionResult } from '@gooddata/sdk-backend-spi';
 import { IExportResult } from '@gooddata/sdk-backend-spi';
 import { IFilter } from '@gooddata/sdk-model';
 import { IFilterableWidget } from '@gooddata/sdk-model';
+import { IFilterBarProps as IFilterBarProps_2 } from './types.js';
 import { IFilterContext } from '@gooddata/sdk-model';
 import { IFilterContextDefinition } from '@gooddata/sdk-model';
 import { IHeaderPredicate } from '@gooddata/sdk-ui';
@@ -255,6 +257,7 @@ import { ISharingApplyPayload as ISharingApplyPayload_2 } from '@gooddata/sdk-ui
 import { ITempFilterContext } from '@gooddata/sdk-model';
 import { ITheme } from '@gooddata/sdk-model';
 import { ITitleProps as ITitleProps_2 } from './types.js';
+import { ITopBarProps as ITopBarProps_2 } from './types.js';
 import { ITranslations } from '@gooddata/sdk-ui';
 import { IUser } from '@gooddata/sdk-model';
 import { IUserWorkspaceSettings } from '@gooddata/sdk-backend-spi';
@@ -285,7 +288,6 @@ import { default as React_2 } from 'react';
 import { ReactNode } from 'react';
 import { ReactReduxContextValue } from 'react-redux';
 import { Reducer } from '@reduxjs/toolkit';
-import { RefAttributes } from 'react';
 import { RenderMode as RenderMode_2 } from '../../../types.js';
 import { RenderModeState as RenderModeState_2 } from './renderModeState.js';
 import { SagaIterator } from 'redux-saga';
@@ -2091,6 +2093,15 @@ export declare type CommandProcessingStatus = "running" | "success" | "error";
  */
 export declare function commandStartedEventHandler<TCommand extends IDashboardCommand>(type: TCommand["type"], handler: DashboardEventHandler<DashboardCommandStarted<TCommand>>["handler"]): DashboardEventHandler<DashboardCommandStarted<TCommand>>;
 
+/**
+ * Data attributes with export specification for components.
+ *
+ * @alpha
+ */
+export declare type CommonExportDataAttributes = {
+    "data-export-type": ExportElementType;
+};
+
 /**
  * @public
  */
@@ -3159,6 +3170,21 @@ export declare interface DashboardConfig {
      * @remarks Only provide one of the focus properties at a time.
      */
     focusObject?: DashboardFocusObject;
+    /**
+     * @alpha
+     *
+     * Specify the slide configuration for the dashboard. This sizes will be used in export mode as size
+     * of the slide where visualization will be fit and rendered.
+     *
+     */
+    slideConfig?: DashboardExportSlideConfig;
+    /**
+     * @alpha
+     *
+     * Dashboard referenced objects.
+     * If provided, initialization of the dashboard avoid additional requests to resolve them.
+     */
+    references?: IDashboardReferences;
 }
 
 /**
@@ -3973,6 +3999,22 @@ export declare type DashboardEvents = DashboardInitialized | DashboardDeinitiali
  */
 export declare type DashboardEventType = "GDC.DASH/EVT.COMMAND.FAILED" | "GDC.DASH/EVT.COMMAND.REJECTED" | "GDC.DASH/EVT.COMMAND.STARTED" | "GDC.DASH/EVT.QUERY.FAILED" | "GDC.DASH/EVT.QUERY.REJECTED" | "GDC.DASH/EVT.QUERY.STARTED" | "GDC.DASH/EVT.QUERY.COMPLETED" | "GDC.DASH/EVT.USER_INTERACTION.TRIGGERED" | "GDC.DASH/EVT.INITIALIZED" | "GDC.DASH/EVT.DEINITIALIZED" | "GDC.DASH/EVT.SAVED" | "GDC.DASH/EVT.COPY_SAVED" | "GDC.DASH/EVT.RENAMED" | "GDC.DASH/EVT.RESET" | "GDC.DASH/EVT.DELETED" | "GDC.DASH/EVT.RENDER_MODE.CHANGED" | "GDC.DASH/EVT.EXPORT.PDF.REQUESTED" | "GDC.DASH/EVT.EXPORT.PDF.RESOLVED" | "GDC.DASH/EVT.FILTER_CONTEXT.DATE_FILTER.VALIDATION.FAILED" | "GDC.DASH/EVT.FILTER_CONTEXT.DATE_FILTER.SELECTION_CHANGED" | "GDC.DASH/EVT.FILTER_CONTEXT.DATE_FILTER.ADDED" | "GDC.DASH/EVT.FILTER_CONTEXT.DATE_FILTER.REMOVED" | "GDC.DASH/EVT.FILTER_CONTEXT.DATE_FILTER.MOVED" | "GDC.DASH/EVT.FILTER_CONTEXT.ATTRIBUTE_FILTER.ADDED" | "GDC.DASH/EVT.FILTER_CONTEXT.ATTRIBUTE_FILTER.REMOVED" | "GDC.DASH/EVT.FILTER_CONTEXT.ATTRIBUTE_FILTER.MOVED" | "GDC.DASH/EVT.FILTER_CONTEXT.ATTRIBUTE_FILTER.SELECTION_CHANGED" | "GDC.DASH/EVT.FILTER_CONTEXT.ATTRIBUTE_FILTER.PARENT_CHANGED" | "GDC.DASH/EVT.FILTER_CONTEXT.ATTRIBUTE_FILTER.DISPLAY_FORM_CHANGED" | "GDC.DASH/EVT.FILTER_CONTEXT.ATTRIBUTE_FILTER.SELECTION_MODE_CHANGED" | "GDC.DASH/EVT.FILTER_CONTEXT.ATTRIBUTE_FILTER.TITLE_CHANGED" | "GDC.DASH/EVT.ATTRIBUTE_FILTER_CONFIG.MODE_CHANGED" | "GDC.DASH/EVT.ATTRIBUTE_FILTER_CONFIG.LIMITING_ITEMS_CHANGED" | "GDC.DASH/EVT.ATTRIBUTE_FILTER_CONFIG.DISPLAY_AS_LABEL_CHANGED" | "GDC.DASH/EVT.DATE_FILTER_CONFIG.TITLE_CHANGED" | "GDC.DASH/EVT.DATE_FILTER_CONFIG.MODE_CHANGED" | "GDC.DASH/EVT.FILTER_CONTEXT.CHANGED" | "GDC.DASH/EVT.FLUID_LAYOUT.SECTION_ADDED" | "GDC.DASH/EVT.FLUID_LAYOUT.SECTION_MOVED" | "GDC.DASH/EVT.FLUID_LAYOUT.SECTION_REMOVED" | "GDC.DASH/EVT.FLUID_LAYOUT.SECTION_HEADER_CHANGED" | "GDC.DASH/EVT.FLUID_LAYOUT.SECTION_ITEM_WIDTH_RESIZED" | "GDC.DASH/EVT.FLUID_LAYOUT.SECTION_ITEMS_HEIGHT_RESIZED" | "GDC.DASH/EVT.FLUID_LAYOUT.ITEMS_ADDED" | "GDC.DASH/EVT.FLUID_LAYOUT.ITEM_REPLACED" | "GDC.DASH/EVT.FLUID_LAYOUT.ITEM_MOVED" | "GDC.DASH/EVT.FLUID_LAYOUT.ITEM_MOVED_TO_NEW_SECTION" | "GDC.DASH/EVT.FLUID_LAYOUT.ITEM_REMOVED" | "GDC.DASH/EVT.FLUID_LAYOUT.LAYOUT_CHANGED" | "GDC.DASH/EVT.FLUID_LAYOUT.SCREEN_SIZE_CHANGED" | "GDC.DASH/EVT.FLEXIBLE_LAYOUT.LAYOUT_SECTION_HEADERS_TOGGLED" | "GDC.DASH/EVT.KPI_WIDGET.HEADER_CHANGED" | "GDC.DASH/EVT.KPI_WIDGET.DESCRIPTION_CHANGED" | "GDC.DASH/EVT.KPI_WIDGET.CONFIGURATION_CHANGED" | "GDC.DASH/EVT.KPI_WIDGET.MEASURE_CHANGED" | "GDC.DASH/EVT.KPI_WIDGET.FILTER_SETTINGS_CHANGED" | "GDC.DASH/EVT.KPI_WIDGET.COMPARISON_CHANGED" | "GDC.DASH/EVT.KPI_WIDGET.DRILL_REMOVED" | "GDC.DASH/EVT.KPI_WIDGET.DRILL_SET" | "GDC.DASH/EVT.KPI_WIDGET.WIDGET_CHANGED" | "GDC.DASH/EVT.INSIGHT_WIDGET.HEADER_CHANGED" | "GDC.DASH/EVT.INSIGHT_WIDGET.DESCRIPTION_CHANGED" | "GDC.DASH/EVT.INSIGHT_WIDGET.FILTER_SETTINGS_CHANGED" | "GDC.DASH/EVT.INSIGHT_WIDGET.PROPERTIES_CHANGED" | "GDC.DASH/EVT.INSIGHT_WIDGET.CONFIGURATION_CHANGED" | "GDC.DASH/EVT.INSIGHT_WIDGET.IGNORE_CROSS_FILTERING_CHANGED" | "GDC.DASH/EVT.INSIGHT_WIDGET.INSIGHT_SWITCHED" | "GDC.DASH/EVT.INSIGHT_WIDGET.DRILLS_MODIFIED" | "GDC.DASH/EVT.INSIGHT_WIDGET.DRILLS_REMOVED" | "GDC.DASH/EVT.INSIGHT_WIDGET.DRILL_DOWN_REMOVED" | "GDC.DASH/EVT.INSIGHT_WIDGET.DRILL_DOWN_ADDED" | "GDC.DASH/EVT.INSIGHT_WIDGET.DRILL_DOWN_MODIFIED" | "GDC.DASH/EVT.INSIGHT_WIDGET.WIDGET_CHANGED" | "GDC.DASH/EVT.INSIGHT_WIDGET.EXPORT_REQUESTED" | "GDC.DASH/EVT.INSIGHT_WIDGET.EXPORT_RESOLVED" | "GDC.DASH/EVT.INSIGHT_WIDGET.REFRESHED" | "GDC.DASH/EVT.RICH_TEXT_WIDGET.CONTENT_CHANGED" | "GDC.DASH/EVT.VISUALIZATION_SWITCHER_WIDGET.VISUALIZATION_ADDED" | "GDC.DASH/EVT.VISUALIZATION_SWITCHER_WIDGET.VISUALIZATIONS_UPDATED" | "GDC.DASH/EVT.WIDGET.EXECUTION_STARTED" | "GDC.DASH/EVT.WIDGET.EXECUTION_FAILED" | "GDC.DASH/EVT.WIDGET.EXECUTION_SUCCEEDED" | "GDC.DASH/EVT.ALERT.CREATED" | "GDC.DASH/EVT.ALERT.SAVED" | "GDC.DASH/EVT.SCHEDULED_EMAIL.CREATED" | "GDC.DASH/EVT.SCHEDULED_EMAIL.SAVED" | "GDC.DASH/EVT.DRILL.REQUESTED" | "GDC.DASH/EVT.DRILL.RESOLVED" | "GDC.DASH/EVT.DRILL.DRILL_DOWN.REQUESTED" | "GDC.DASH/EVT.DRILL.DRILL_DOWN.RESOLVED" | "GDC.DASH/EVT.DRILL.DRILL_TO_INSIGHT.REQUESTED" | "GDC.DASH/EVT.DRILL.DRILL_TO_INSIGHT.RESOLVED" | "GDC.DASH/EVT.DRILL.DRILL_TO_DASHBOARD.REQUESTED" | "GDC.DASH/EVT.DRILL.DRILL_TO_DASHBOARD.RESOLVED" | "GDC.DASH/EVT.DRILL.DRILL_TO_ATTRIBUTE_URL.REQUESTED" | "GDC.DASH/EVT.DRILL.DRILL_TO_ATTRIBUTE_URL.RESOLVED" | "GDC.DASH/EVT.DRILL.DRILL_TO_CUSTOM_URL.REQUESTED" | "GDC.DASH/EVT.DRILL.DRILL_TO_CUSTOM_URL.RESOLVED" | "GDC.DASH/EVT.DRILL.DRILL_TO_LEGACY_DASHBOARD.REQUESTED" | "GDC.DASH/EVT.DRILL.DRILL_TO_LEGACY_DASHBOARD.RESOLVED" | "GDC.DASH/EVT.DRILL.DRILLABLE_ITEMS.CHANGED" | "GDC.DASH/EVT.DRILL.CROSS_FILTERING.REQUESTED" | "GDC.DASH/EVT.DRILL.CROSS_FILTERING.RESOLVED" | "GDC.DASH/EVT.DRILL_TARGETS.ADDED" | "GDC.DASH/EVT.RENDER.REQUESTED" | "GDC.DASH/EVT.RENDER.ASYNC.REQUESTED" | "GDC.DASH/EVT.RENDER.ASYNC.RESOLVED" | "GDC.DASH/EVT.RENDER.RESOLVED" | "GDC.DASH/EVT.SHARING.CHANGED" | "GDC.DASH/EVT.CREATE_INSIGHT_REQUESTED" | "GDC.DASH/EVT.CREATE_ATTRIBUTE_HIERARCHY_REQUESTED" | "GDC.DASH/EVT.DELETE_ATTRIBUTE_HIERARCHY_REQUESTED" | "GDC.DASH/EVT.ATTRIBUTE_HIERARCHY_MODIFIED" | "GDC.DASH/EVT.FILTER_CONTEXT.FILTER_VIEW.CREATE.SUCCESS" | "GDC.DASH/EVT.FILTER_CONTEXT.FILTER_VIEW.CREATE.FAILURE" | "GDC.DASH/EVT.FILTER_CONTEXT.FILTER_VIEW.DELETE.SUCCESS" | "GDC.DASH/EVT.FILTER_CONTEXT.FILTER_VIEW.DELETE.FAILURE" | "GDC.DASH/EVT.FILTER_CONTEXT.FILTER_VIEW.APPLY.SUCCESS" | "GDC.DASH/EVT.FILTER_CONTEXT.FILTER_VIEW.APPLY.FAILURE" | "GDC.DASH/EVT.FILTER_CONTEXT.FILTER_VIEW.CHANGE_DEFAULT_STATUS.SUCCESS" | "GDC.DASH/EVT.FILTER_CONTEXT.FILTER_VIEW.CHANGE_DEFAULT_STATUS.FAILURE" | "GDC.DASH/EVT.AUTOMATIONS.REFRESHED";
 
+/**
+ * @alpha
+ *
+ * Specifies the size of the slide where visualization will be fit and rendered.
+ */
+export declare interface DashboardExportSlideConfig {
+    /**
+     * Preferred width of slide in export mode.
+     */
+    width: number;
+    /**
+     * Preferred height of slide in export mode.
+     */
+    height: number;
+}
+
 /**
  * This event is emitted at the start of the 'dashboard export to PDF' command processing.
  *
@@ -4935,6 +4977,11 @@ export declare type DashboardLayoutDraggableListItem = BaseDraggableLayoutItem &
  */
 export declare type DashboardLayoutDraggingComponent = ComponentType<IDashboardLayoutDraggingComponentProps>;
 
+/**
+ * @public
+ */
+export declare type DashboardLayoutExportTransformFn = <TWidget>(layout: IDashboardLayout<TWidget>) => IDashboardLayout<TWidget> | undefined;
+
 /**
  * This event is emitted when a new dashboard layout section is added.
  *
@@ -5408,6 +5455,26 @@ export declare interface DashboardModelCustomizationFns {
      *    dashboard will be used as-is.
      */
     existingDashboardTransformFn?: DashboardTransformFn;
+    /**
+     * Provide a function that will be used during dashboard export initialization of an existing dashboard.
+     *
+     * @remarks
+     * This function will be called after the dashboard is loaded from backend transformed by another plugins
+     * and before is rendered to the export. This will be not stored in the state.
+     *
+     *  - If the function is not defined, results in an error or returns `undefined`, then the original
+     *  dashboard export transformation will be used as-is.
+     */
+    existingExportTransformFn?: DashboardLayoutExportTransformFn;
+}
+
+/**
+ * @internal
+ */
+export declare enum DashboardPartId {
+    MainContent = "mainContent",
+    FiltersBar = "filtersBar",
+    Sidebar = "sidebar"
 }
 
 /**
@@ -6413,7 +6480,7 @@ export declare const DefaultCancelEditDialog: React_2.FC<ICancelEditDialogProps>
  *
  * @alpha
  */
-export declare const DefaultDashboardAttributeFilter: (props: IDashboardAttributeFilterProps) => JSX.Element;
+export declare const DefaultDashboardAttributeFilter: (props: IDashboardAttributeFilterProps) => JSX.Element | null;
 
 /**
  * @internal
@@ -7367,6 +7434,13 @@ export declare interface ExportDashboardToPdf extends IDashboardCommand {
  */
 export declare function exportDashboardToPdf(correlationId?: string): ExportDashboardToPdf;
 
+/**
+ * Export element type.
+ *
+ * @alpha
+ */
+export declare type ExportElementType = "section" | "section-title" | "section-description" | "widget" | "widget-content" | "widget-title" | "widget-description";
+
 /**
  * @beta
  */
@@ -7402,6 +7476,11 @@ export declare interface ExportInsightWidgetPayload {
     readonly config: IExportConfig;
 }
 
+/**
+ * @alpha
+ */
+export declare type ExportLayoutCustomizationFn = <TWidget>(layout: IDashboardLayout, customizer: IExportLayoutCustomizer<TWidget>) => void;
+
 /**
  * Specialization of the IDashboardLayoutItem which also includes the extended dashboard widgets - KPI and
  * Insight placeholders.
@@ -7540,6 +7619,11 @@ export declare interface FilterContextState {
      * @beta
      */
     attributeFilterDisplayForms?: IAttributeDisplayFormMetadataObject[];
+    /**
+     * Attribute metadata objects with referenced objects for all attribute filters in the `filterContextDefinition`
+     * @beta
+     */
+    attributesWithReferences?: IAttributeWithReferences[];
 }
 
 /**
@@ -7782,6 +7866,16 @@ export declare function getDefaultInsightMenuItems(intl: IntlShape, config: {
  */
 export declare function getDrillDownTitle(drillDefinition: IDrillDownDefinition, drillEvent: IDrillEvent, drillDownIntersectionIgnoredAttributes?: IDrillDownIntersectionIgnoredAttributes[], drillTargetDisplayForm?: IAttributeDisplayFormMetadataObject): string | null;
 
+/**
+ * Data attributes for export mode to be added to the header.
+ *
+ * @alpha
+ */
+export declare type HeaderExportData = {
+    title?: CommonExportDataAttributes;
+    description?: CommonExportDataAttributes;
+};
+
 /**
  * @internal
  */
@@ -8357,6 +8451,10 @@ export declare interface IDashboardBaseProps {
      * logged-in user.
      */
     permissions?: IWorkspacePermissions;
+    /**
+     * Specify tab index and addressable id for the dashboard components used by keyboard navigation
+     */
+    keyboardNavigation?: KeyboardNavigationConfig;
 }
 
 /**
@@ -9516,6 +9614,10 @@ export declare interface IDashboardInsightProps {
      * @internal
      */
     pushData?: (data: IPushData) => void;
+    /**
+     * @alpha
+     */
+    exportData?: WidgetExportDataAttributes;
 }
 
 /**
@@ -9689,6 +9791,23 @@ export declare interface IDashboardLayoutCustomizer {
      * be called.
      */
     customizeFluidLayout(fun: FluidLayoutCustomizationFn): IDashboardLayoutCustomizer;
+    /**
+     * Register customization of the export layout that is used to render the dashboard.
+     *
+     * @remarks
+     * At this point, you can register a function which will be called after dashboard component loads
+     * the dashboard and before it starts rendering the layout itself. The function will be called
+     * with two arguments:
+     *
+     * -  The actual dashboard layout
+     * -  Customizer that allows the plugin to work with export definition
+     *
+     * Your customization function may introspect the original layout and then register its customizations.
+     *
+     * If the dashboard is not rendering export layout, then the registered function will not
+     * be called.
+     */
+    customizeExportLayout(fun: ExportLayoutCustomizationFn): IDashboardLayoutCustomizer;
     /**
      * Register a provider for React components to render layout.
      *
@@ -9950,6 +10069,12 @@ export declare interface IDashboardRichTextProps {
      * @alpha
      */
     clientWidth?: number;
+    /**
+     * Data for export in export mode.
+     *
+     * @alpha
+     */
+    exportData?: WidgetExportDataAttributes;
 }
 
 /**
@@ -10059,6 +10184,12 @@ export declare interface IDashboardVisualizationSwitcherProps {
      * @alpha
      */
     clientWidth?: number;
+    /**
+     * Data for export in export mode.
+     *
+     * @alpha
+     */
+    exportData?: WidgetExportData;
     onLoadingChanged?: OnLoadingChanged;
     onExportReady?: OnExportReady;
     onError?: OnError;
@@ -10233,6 +10364,12 @@ export declare interface IDashboardWidgetProps {
      * Once the flexible layout is the only one supported, it can be set as required.
      */
     rowIndex?: number;
+    /**
+     * Data attributes for export mode to be added to the widget.
+     *
+     * @alpha
+     */
+    exportData?: WidgetExportData;
 }
 
 /**
@@ -10417,6 +10554,15 @@ export declare interface IExecutionResultEnvelope {
  */
 export declare type IExportConfig = ICsvExportConfig | IXlsxExportConfig;
 
+/**
+ * Set of functions you can use to customize the export layout of the dashboard rendered.
+ *
+ * @alpha
+ */
+export declare interface IExportLayoutCustomizer<TWidget> {
+    addTransformer(fn: SectionSlidesTransformer<TWidget>): IExportLayoutCustomizer<TWidget>;
+}
+
 /**
  * Set of functions you can use to customize some aspects of the FilterBar.
  *
@@ -10889,6 +11035,30 @@ export declare interface IInsightMenuSubmenuComponentProps {
     enableTitleConfig?: boolean;
 }
 
+/**
+ * Configuration for keyboard navigation
+ *
+ * @internal
+ */
+export declare interface IKeyboardNavigationConfigItem {
+    /**
+     * id which will be set to the target element
+     */
+    targetElementId?: string;
+    /**
+     * tabIndex which will be set to the target element
+     */
+    tabIndex?: number;
+    /**
+     * aria-label which will be set to the target element
+     */
+    ariaLabel?: string;
+    /**
+     * onFocus callback which will be called when the target element is focused
+     */
+    onFocus?: () => void;
+}
+
 /**
  * @internal
  */
@@ -13745,6 +13915,14 @@ export declare interface IXlsxExportConfig {
     showFilters?: boolean;
 }
 
+/**
+ * Configurations for keyboard navigation for individual parts of the dashboard
+ * @internal
+ */
+export declare type KeyboardNavigationConfig = {
+    [key in DashboardPartId]?: IKeyboardNavigationConfigItem;
+};
+
 /**
  * @internal
  */
@@ -14959,6 +15137,26 @@ export declare interface PlaceholderWidget extends ICustomWidget {
     readonly isLoading?: boolean;
 }
 
+/**
+ * @internal
+ */
+export declare type PrivateDashboardContext = DashboardModelCustomizationFns & {
+    /**
+     * If specified, the dashboard initialization should use this dashboard definition instead of
+     * loading dashboard from backend.
+     */
+    preloadedDashboard?: IDashboard;
+    /**
+     * Provide a function that will be used during dashboard initialization and can add overlays with some info
+     * about modification or insertion by plugin
+     *
+     * @remarks
+     *
+     * -  If the function is not defined, then no overlays will be rendered
+     */
+    widgetsOverlayFn?: WidgetsOverlayFn;
+};
+
 /**
  * This is a specialization of toolkit's CaseReducerActions to correctly type the action creators.
  *
@@ -15991,7 +16189,7 @@ export declare interface RenameDashboardPayload {
 /**
  * @beta
  */
-export declare type RenderMode = "view" | "edit";
+export declare type RenderMode = "view" | "edit" | "export";
 
 /**
  * Actions to control renderMode state of the dashboard.
@@ -16004,6 +16202,7 @@ payload: RenderMode_2;
 type: string;
 }) => void | RenderModeState_2 | WritableDraft<RenderModeState_2>;
 setEditRenderMode: (state: WritableDraft<RenderModeState_2>, action: AnyAction) => void | RenderModeState_2 | WritableDraft<RenderModeState_2>;
+setExportRenderMode: (state: WritableDraft<RenderModeState_2>, action: AnyAction) => void | RenderModeState_2 | WritableDraft<RenderModeState_2>;
 setViewRenderMode: (state: WritableDraft<RenderModeState_2>, action: AnyAction) => void | RenderModeState_2 | WritableDraft<RenderModeState_2>;
 }, "renderModeSlice">;
 
@@ -16021,7 +16220,17 @@ export declare function renderModeAware<T extends ComponentType<any>>(components
 /**
  * @internal
  */
-export declare const RenderModeAwareTitle: ComponentType<ITitleProps_2 | (ITitleProps_2 & RefAttributes<Component<ITitleProps_2, any, any>>)>;
+export declare const RenderModeAwareFilterBar: React_2.ComponentType<IFilterBarProps_2>;
+
+/**
+ * @internal
+ */
+export declare const RenderModeAwareTitle: React_2.ComponentType<ITitleProps_2 | (ITitleProps_2 & React_2.RefAttributes<React_2.Component<ITitleProps_2, any, any>>)>;
+
+/**
+ * @internal
+ */
+export declare const RenderModeAwareTopBar: React_2.ComponentType<ITopBarProps_2>;
 
 /**
  * @beta
@@ -16484,7 +16693,7 @@ export declare interface ResolveAsyncRenderPayload {
  *
  * @public
  */
-export declare type ResolvedDashboardConfig = Omit<Required<DashboardConfig>, "mapboxToken" | "exportId" | "focusObject"> & DashboardConfig;
+export declare type ResolvedDashboardConfig = Omit<Required<DashboardConfig>, "mapboxToken" | "exportId" | "focusObject" | "slideConfig" | "references"> & DashboardConfig;
 
 /**
  * @alpha
@@ -16843,6 +17052,101 @@ export declare interface ScreenSizeChangedPayload {
     readonly screenSize: ScreenSize;
 }
 
+/**
+ * Data attributes for export mode to be added to the layout section header and its components.
+ *
+ * @alpha
+ */
+export declare type SectionExportData = HeaderExportData & {
+    section?: CommonExportDataAttributes;
+};
+
+/**
+ * @alpha
+ */
+export declare type SectionSlidesTransformer<TWidget> = (section: IDashboardLayoutSection<TWidget>, fn: SectionSlidesTransformerFunction<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined;
+
+/**
+ * @alpha
+ */
+export declare interface SectionSlidesTransformerFunction<TWidget> {
+    /**
+     * Default transformer for the section. This is used as default transformation method for the section in
+     * case that no plugin override it. Can be used to provide default transformation for the section in custom
+     * plugin.
+     *
+     * @param section - Section to transform
+     */
+    defaultSection: (section: IDashboardLayoutSection<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined;
+    /**
+     * Default transformer for the items. This is used as default transformation method for the items in
+     * section in case that no plugin override it. Can be used to provide default transformation for the items in
+     * custom plugin.
+     *
+     * @param section - Section to transform
+     */
+    defaultItems: (section: IDashboardLayoutSection<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined;
+    /**
+     * This transformer ís used to extract break up slide from current section. Break up slide is created
+     * from section title and description. This transformer only create slide when section has title or description.
+     *
+     * @param section - Section to transform
+     */
+    breakUpSlide: (section: IDashboardLayoutSection<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined;
+    /**
+     * This transformer is used to extract widget slide from current section and provided item. Widget slide is created from
+     * provided item. Widget slide always contains only one item that mean there will be one item on created slide.
+     *
+     * @param item - Layout item (widget, kpi, ...) to transform
+     */
+    widgetSlide: (item: IDashboardLayoutItem<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined;
+    /**
+     * This transformer is used to create multiple slides from switcher widget. Each slide contains one visualization
+     * that is part of the switcher.
+     *
+     * @param item - Layout item specifically visualization switcher to transform
+     */
+    switcherSlide: (item: IDashboardLayoutItem<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined;
+    /**
+     * This is more complex transformer that is used to transform container item in the layout to a slide. Container item is
+     * transformed as a structured slide, but if it contains a visualization switcher, it is transformed to a flat list of visualizations
+     * that are part of container item.
+     *
+     * @param item - Layout item specifically  container to transform
+     * @param transform - function to transform each section in the layout
+     */
+    containerSlide: (item: IDashboardLayoutItem<TWidget>, transform: (section: IDashboardLayoutSection<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined) => IDashboardLayoutSection<TWidget>[] | undefined;
+    /**
+     * This is more complex transformer that is used to transform container item in the layout to a slide. Container item is
+     * transformed as a structured slide, but if it contains a visualization switcher, switcher is spread into multiple slides
+     * where each slide contains one visualization from each switcher.
+     *
+     * @remarks
+     * If there are 2 switchers in the container, one with 3 visualizations and the other with 2 visualizations, then
+     * this transformer will create 3 slides. First slide will contain first visualizations from both switchers, second slide
+     * will contain second visualizations from both switchers and last slide will contain third visualization from the first
+     * switcher and empty item from the second switcher.
+     *
+     * @param item - Layout item specifically  container to transform
+     * @param transform - function to transform each section in the layout
+     */
+    containerSwitcherSlide: (item: IDashboardLayoutItem<TWidget>, transform: (section: IDashboardLayoutSection<TWidget>) => IDashboardLayoutSection<TWidget>[] | undefined) => IDashboardLayoutSection<TWidget>[] | undefined;
+    /**
+     * This is helper function that is used to iterate all items in the section. On every item
+     * it calls provided transform function. This function is used to transform all items in the section.
+     *
+     * @param section - Section to transform
+     * @param transform - function to transform each item in the layout
+     */
+    itemsSlide: (section: IDashboardLayoutSection<TWidget>, transform: (item: IDashboardLayoutItem<TWidget>) => IDashboardLayoutSection<TWidget>[]) => IDashboardLayoutSection<TWidget>[] | undefined;
+    /**
+     * This function is used to determine if the section contains visualization switcher.
+     *
+     * @param section - Section to check
+     */
+    containsVisualisationSwitcher: (section: IDashboardLayoutSection<TWidget>) => boolean;
+}
+
 /**
  * Select all accessible dashboard in project.
  *
@@ -18139,6 +18443,11 @@ export declare const selectEnableRichTextDescriptions: DashboardSelector<boolean
  */
 export declare const selectEnableScheduling: DashboardSelector<boolean>;
 
+/**
+ * @internal
+ */
+export declare const selectEnableSlideshowExports: DashboardSelector<boolean>;
+
 /**
  * Returns whether the unrelated data datasets are shown.
  *
@@ -18374,6 +18683,11 @@ export declare const selectHasCatalogFacts: DashboardSelector<boolean>;
  */
 export declare const selectHasCatalogMeasures: DashboardSelector<boolean>;
 
+/**
+ * @alpha
+ */
+export declare const selectHasSomeExecutionResult: DashboardSelector<boolean>;
+
 /**
  * Returns whether Kpi drills in embedded mode are disabled.
  *
@@ -18692,6 +19006,13 @@ export declare const selectIsFilterViewsDialogOpen: DashboardSelector<boolean>;
  */
 export declare const selectIsInEditMode: DashboardSelector<boolean>;
 
+/**
+ * Returns whether the current Dashboard is on export mode.
+ *
+ * @internal
+ */
+export declare const selectIsInExportMode: DashboardSelector<boolean>;
+
 /**
  * @internal
  */
@@ -19038,6 +19359,13 @@ export declare const selectPersistedDashboard: DashboardSelector<IDashboard | un
  */
 export declare const selectPlatformEdition: DashboardSelector<PlatformEdition>;
 
+/**
+ * Select preloaded attribute metadata objects with references for attribute filters.
+ *
+ * @internal
+ */
+export declare const selectPreloadedAttributesWithReferences: DashboardSelector<IAttributeWithReferences[] | undefined>;
+
 /**
  * @internal
  */
@@ -21436,6 +21764,11 @@ export declare function useSaveAsNewButtonProps(): ISaveAsNewButtonProps;
  */
 export declare function useSaveButtonProps(): ISaveButtonProps;
 
+/**
+ * @alpha
+ */
+export declare const useSectionExportData: (firstLevel: boolean) => SectionExportData | undefined;
+
 /**
  * @internal
  */
@@ -21446,6 +21779,11 @@ export declare function useShareButtonProps(): IShareButtonProps;
  */
 export declare const useTopBarProps: () => ITopBarProps;
 
+/**
+ * @alpha
+ */
+export declare const useVisualizationExportData: (widget: WidgetExportDataAttributes | undefined, loading: boolean, error: boolean) => Partial<WidgetExportDataAttributes> | undefined;
+
 /**
  * @internal
  */
@@ -21462,6 +21800,11 @@ export declare function useWidgetExecutionsHandler(widgetRef: ObjRef): {
     onPushData: (data: IPushData) => void;
 };
 
+/**
+ * @alpha
+ */
+export declare const useWidgetExportData: (widget: ExtendedDashboardWidget) => WidgetExportData | undefined;
+
 /**
  * Hook for obtaining the effective filters for a widget.
  *
@@ -21576,6 +21919,43 @@ export declare interface WidgetDescription {
     description?: string;
 }
 
+/**
+ * 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.
+ *
+ * @example
+ * ```tsx
+ * const DashboardWidgetComponent: CustomDashboardWidgetComponent = ({ widget, exportData }) => {
+ *   return (
+ *       <div {...exportData?.widget}>
+ *           <div>My custom dashboard widget - {widget?.identifier}</div>
+ *           <div {...exportData?.title}>Widget title</div>
+ *           <div {...exportData?.description}>Widget description</div>
+ *       </div>
+ *   );
+ * };
+ * ```
+ *
+ * @alpha
+ */
+export declare type WidgetExportData = HeaderExportData & {
+    section?: CommonExportDataAttributes;
+    widget?: WidgetExportDataAttributes;
+};
+
+/**
+ * Data attributes for export mode to be added to the widget.
+ *
+ * @alpha
+ */
+export declare type WidgetExportDataAttributes = CommonExportDataAttributes & {
+    "data-export-widget-type"?: string;
+    "data-export-visualization-type"?: string;
+    "data-export-visualization-status"?: "loading" | "loaded" | "error";
+};
+
 /**
  * Widget's filter settings can be manipulated using multiple different granular operations. This is the union
  * type containing all the available operations.

package/esm/types.d.ts

@@ -160,7 +160,7 @@ export interface IMenuButtonItemsVisibility {
 /**
  * @beta
  */
-export type RenderMode = "view" | "edit";
+export type RenderMode = "view" | "edit" | "export";
 /**
  * @public
  */