@gooddata/sdk-ui-dashboard 10.22.0-alpha.47 → 10.22.0-alpha.49

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

@@ -882,6 +882,29 @@ export declare function applyAttributeFilter(filterLocalId: string, filter: IAtt
  */
 export declare function applyDateFilter(filter: IDateFilter, correlationId?: string): ChangeDateFilterSelection;
 
+/**
+ * Command for applying all working filters staged for application.
+ * Usually used with setting dashboardApplyFiltersMode: ALL_AT_ONCE
+ *
+ * @remarks
+ * See {@link applyFilterContextWorkingSelection} for a factory function that will help you create this command.
+ *
+ * @alpha
+ */
+export declare interface ApplyFilterContextWorkingSelection extends IDashboardCommand {
+    readonly type: "GDC.DASH/CMD.FILTER_CONTEXT.APPLY_WORKING_SELECTION";
+}
+
+/**
+ * Creates the {@link ApplyFilterContextWorkingSelection} command.
+ *
+ * @param correlationId - specify correlation id. It will be included in all events that will be emitted during the command processing.
+ * @returns apply all filters command
+ *
+ * @alpha
+ */
+export declare function applyFilterContextWorkingSelection(correlationId?: string): ApplyFilterContextWorkingSelection;
+
 /**
  * Command for application of a saved filter view.
  *
@@ -1191,7 +1214,7 @@ export declare interface ChangeAttributeFilterSelection extends IDashboardComman
 }
 
 /**
- * Creates the ChangeAttributeFilterSelection command.
+ * Creates the ChangeAttributeFilterSelection command for applied filters.
  *
  * @remarks
  * Dispatching this command will result in application of element selection for the dashboard attribute filter
@@ -1200,6 +1223,9 @@ export declare interface ChangeAttributeFilterSelection extends IDashboardComman
  * The attribute elements can be provided either using their URI (primary key) or value. Together with the
  * elements you must indicate the selection type - either 'IN' or 'NOT_IN'.
  *
+ * If you want to change working filters use {@link changeWorkingAttributeFilterSelection}.
+ * See {@link ChangeAttributeFilterSelectionPayload.isWorkingSelectionChange} for details.
+ *
  * @remarks see {@link resetAttributeFilterSelection} for convenience function to select all attribute elements of
  *  particular filter.
  *
@@ -1241,6 +1267,11 @@ export declare interface ChangeAttributeFilterSelectionPayload {
      * Selection type. Either 'IN' for positive selection or 'NOT_IN' for negative selection (All except selected items).
      */
     readonly selectionType: AttributeFilterSelectionType;
+    /**
+     * Determines if this command should change working (staged for application) filters or applied filters (used to compute data).
+     * Default is false - command changes applied filters.
+     */
+    readonly isWorkingSelectionChange?: boolean;
 }
 
 /**
@@ -1275,7 +1306,7 @@ export declare interface ChangeDateFilterSelection extends IDashboardCommand {
  *
  * @public
  */
-export declare function changeDateFilterSelection(type: DateFilterType, granularity: DateFilterGranularity, from?: DateString | number, to?: DateString | number, dateFilterOptionLocalId?: string, correlationId?: string, dataSet?: ObjRef): ChangeDateFilterSelection;
+export declare function changeDateFilterSelection(type: DateFilterType, granularity: DateFilterGranularity, from?: DateString | number, to?: DateString | number, dateFilterOptionLocalId?: string, correlationId?: string, dataSet?: ObjRef, isWorkingSelectionChange?: boolean): ChangeDateFilterSelection;
 
 /**
  * @alpha
@@ -2056,6 +2087,42 @@ export declare interface ChangeSharingPayload {
     readonly newSharingProperties: ISharingApplyPayload_2;
 }
 
+/**
+ * Creates the ChangeAttributeFilterSelection command for working filter.
+ *
+ * @remarks
+ * Dispatching this command will result in changing working element selection for the dashboard attribute filter
+ * with the provided id, or error in case of invalid update (e.g. non-existing filterLocalId).
+ *
+ * The attribute elements can be provided either using their URI (primary key) or value. Together with the
+ * elements you must indicate the selection type - either 'IN' or 'NOT_IN'.
+ *
+ * If you want to change applied filters use {@link changeAttributeFilterSelection}.
+ * See {@link ChangeAttributeFilterSelectionPayload.isWorkingSelectionChange} for details.
+ *
+ * @remarks see {@link resetAttributeFilterSelection} for convenience function to select all attribute elements of
+ *  particular filter.
+ *
+ * See also {@link applyAttributeFilter} for convenient function when you have an {@link @gooddata/sdk-model#IAttributeFilter} instance.
+ *
+ *  @example
+ * ```
+ * const selectionType = isPositiveAttributeFilter ? "IN" : "NOT_IN";
+ * ```
+ *
+ * To create this command without a need to calculate the payload values from a {@link @gooddata/sdk-model#IFilter} object,
+ * we recommend to use {@link applyAttributeFilter} command creator instead.
+ *
+ * @param filterLocalId - dashboard attribute filter's local id
+ * @param elements - elements
+ * @param selectionType - selection type. either 'IN' or 'NOT_IN'
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @public
+ */
+export declare function changeWorkingAttributeFilterSelection(filterLocalId: string, elements: IAttributeElements, selectionType: AttributeFilterSelectionType, correlationId?: string): ChangeAttributeFilterSelection;
+
 /**
  * This convenience function will create ChangeDateFilterSelection configured so that the date filter will be
  * unbounded - showing data for 'All Time'.
@@ -2065,7 +2132,7 @@ export declare interface ChangeSharingPayload {
  *
  * @public
  */
-export declare function clearDateFilterSelection(correlationId?: string, dataSet?: ObjRef): ChangeDateFilterSelection;
+export declare function clearDateFilterSelection(correlationId?: string, dataSet?: ObjRef, isWorkingSelectionChange?: boolean): ChangeDateFilterSelection;
 
 /**
  * Creates a {@link DashboardEventHandler} instance that will be invoked for a DashboardCommandFailed of a particular command.
@@ -2968,7 +3035,7 @@ export declare interface DashboardCommandRejected extends IDashboardEvent {
  *
  * @public
  */
-export declare type DashboardCommands = InitializeDashboard | SaveDashboardAs | RequestAsyncRender | ResolveAsyncRender | ChangeFilterContextSelection | ChangeDateFilterSelection | ChangeAttributeFilterSelection | ChangeRenderMode | SaveDashboard | RenameDashboard | ResetDashboard | ExportDashboardToPdf | ExportDashboardToExcel | ExportDashboardToPdfPresentation | ExportDashboardToPptPresentation | DeleteDashboard | TriggerEvent | UpsertExecutionResult | AddAttributeFilter | RemoveAttributeFilters | MoveAttributeFilter | SetAttributeFilterParents | SetAttributeFilterDependentDateFilters | AddLayoutSection | MoveLayoutSection | RemoveLayoutSection | ChangeLayoutSectionHeader | ResizeHeight | ResizeWidth | AddSectionItems | ReplaceSectionItem | MoveSectionItem | MoveSectionItemToNewSection | RemoveSectionItem | RemoveSectionItemByWidgetRef | UndoLayoutChanges | ChangeKpiWidgetHeader | ChangeKpiWidgetDescription | ChangeKpiWidgetConfiguration | ChangeKpiWidgetMeasure | ChangeKpiWidgetFilterSettings | ChangeKpiWidgetComparison | RefreshKpiWidget | SetDrillForKpiWidget | RemoveDrillForKpiWidget | ChangeInsightWidgetHeader | ChangeInsightWidgetDescription | ChangeInsightWidgetIgnoreCrossFiltering | ChangeInsightWidgetFilterSettings | ChangeInsightWidgetVisProperties | ChangeInsightWidgetVisConfiguration | ChangeInsightWidgetInsight | ModifyDrillsForInsightWidget | RemoveDrillsForInsightWidget | RefreshInsightWidget | ExportInsightWidget | CreateAlert | SaveAlert | CreateScheduledEmail | SaveScheduledEmail | ChangeSharing | SetAttributeFilterDisplayForm | SetAttributeFilterTitle | SetAttributeFilterSelectionMode | ChangeRichTextWidgetContent | AddVisualizationToVisualizationSwitcherWidgetContent | UpdateVisualizationsFromVisualizationSwitcherWidgetContent | Drill | DrillDown | DrillToAttributeUrl | DrillToCustomUrl | DrillToDashboard | DrillToInsight | DrillToLegacyDashboard | ChangeDrillableItems | AddDrillTargets | SetDashboardDateFilterConfigMode | SetDashboardAttributeFilterConfigMode | SetDashboardAttributeFilterConfigDisplayAsLabel | RemoveDrillDownForInsightWidget | AddDrillDownForInsightWidget | ModifyDrillDownForInsightWidget | CrossFiltering | AttributeHierarchyModified | AddDateFilter | RemoveDateFilters | MoveDateFilter | SetDashboardDateFilterWithDimensionConfigMode | SetDateFilterConfigTitle | InitializeAutomations | RefreshAutomations | SetAttributeFilterLimitingItems | SaveFilterView | DeleteFilterView | ApplyFilterView | SetFilterViewAsDefault | ReloadFilterViews | ToggleLayoutSectionHeaders | SetScreenSize | LoadAllWorkspaceUsers | ExportRawInsightWidget | ExportSlidesInsightWidget;
+export declare type DashboardCommands = InitializeDashboard | SaveDashboardAs | RequestAsyncRender | ResolveAsyncRender | ChangeFilterContextSelection | ChangeDateFilterSelection | ChangeAttributeFilterSelection | ChangeRenderMode | SaveDashboard | RenameDashboard | ResetDashboard | ExportDashboardToPdf | ExportDashboardToExcel | ExportDashboardToPdfPresentation | ExportDashboardToPptPresentation | DeleteDashboard | TriggerEvent | UpsertExecutionResult | AddAttributeFilter | RemoveAttributeFilters | MoveAttributeFilter | SetAttributeFilterParents | SetAttributeFilterDependentDateFilters | AddLayoutSection | MoveLayoutSection | RemoveLayoutSection | ChangeLayoutSectionHeader | ResizeHeight | ResizeWidth | AddSectionItems | ReplaceSectionItem | MoveSectionItem | MoveSectionItemToNewSection | RemoveSectionItem | RemoveSectionItemByWidgetRef | UndoLayoutChanges | ChangeKpiWidgetHeader | ChangeKpiWidgetDescription | ChangeKpiWidgetConfiguration | ChangeKpiWidgetMeasure | ChangeKpiWidgetFilterSettings | ChangeKpiWidgetComparison | RefreshKpiWidget | SetDrillForKpiWidget | RemoveDrillForKpiWidget | ChangeInsightWidgetHeader | ChangeInsightWidgetDescription | ChangeInsightWidgetIgnoreCrossFiltering | ChangeInsightWidgetFilterSettings | ChangeInsightWidgetVisProperties | ChangeInsightWidgetVisConfiguration | ChangeInsightWidgetInsight | ModifyDrillsForInsightWidget | RemoveDrillsForInsightWidget | RefreshInsightWidget | ExportInsightWidget | CreateAlert | SaveAlert | CreateScheduledEmail | SaveScheduledEmail | ChangeSharing | SetAttributeFilterDisplayForm | SetAttributeFilterTitle | SetAttributeFilterSelectionMode | ChangeRichTextWidgetContent | AddVisualizationToVisualizationSwitcherWidgetContent | UpdateVisualizationsFromVisualizationSwitcherWidgetContent | Drill | DrillDown | DrillToAttributeUrl | DrillToCustomUrl | DrillToDashboard | DrillToInsight | DrillToLegacyDashboard | ChangeDrillableItems | AddDrillTargets | SetDashboardDateFilterConfigMode | SetDashboardAttributeFilterConfigMode | SetDashboardAttributeFilterConfigDisplayAsLabel | RemoveDrillDownForInsightWidget | AddDrillDownForInsightWidget | ModifyDrillDownForInsightWidget | CrossFiltering | AttributeHierarchyModified | AddDateFilter | RemoveDateFilters | MoveDateFilter | SetDashboardDateFilterWithDimensionConfigMode | SetDateFilterConfigTitle | InitializeAutomations | RefreshAutomations | SetAttributeFilterLimitingItems | SaveFilterView | DeleteFilterView | ApplyFilterView | SetFilterViewAsDefault | ReloadFilterViews | ToggleLayoutSectionHeaders | ApplyFilterContextWorkingSelection | SetScreenSize | LoadAllWorkspaceUsers | ExportRawInsightWidget | ExportSlidesInsightWidget;
 
 /**
  * This event is emitted when a particular command processing starts.
@@ -3002,7 +3069,7 @@ export declare interface DashboardCommandStartedPayload<TCommand extends IDashbo
  *
  * @public
  */
-export declare type DashboardCommandType = "GDC.DASH/CMD.INITIALIZE" | "GDC.DASH/CMD.SAVE" | "GDC.DASH/CMD.SAVEAS" | "GDC.DASH/CMD.RESET" | "GDC.DASH/CMD.RENAME" | "GDC.DASH/CMD.DELETE" | "GDC.DASH/CMD.CHANGE_RENDER_MODE" | "GDC.DASH/CMD.SHARING.CHANGE" | "GDC.DASH/CMD.EXPORT.PDF" | "GDC.DASH/CMD.EXPORT.EXCEL" | "GDC.DASH/CMD.EXPORT.PDF_PRESENTATION" | "GDC.DASH/CMD.EXPORT.PPT_PRESENTATION" | "GDC.DASH/CMD.EVENT.TRIGGER" | "GDC.DASH/CMD.EXECUTION_RESULT.UPSERT" | "GDC.DASH/CMD.FILTER_CONTEXT.CHANGE_SELECTION" | "GDC.DASH/CMD.FILTER_CONTEXT.DATE_FILTER.CHANGE_SELECTION" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.ADD" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.REMOVE" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.MOVE" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.CHANGE_SELECTION" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.SET_PARENTS" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.SET_DISPLAY_FORM" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.SET_TITLE" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.SET_SELECTION_MODE" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.SET_DEPENDENT_DATE_FILTERS" | "GDC.DASH/CMD.FILTER_CONTEXT.DATE_FILTER.ADD" | "GDC.DASH/CMD.FILTER_CONTEXT.DATE_FILTER.REMOVE" | "GDC.DASH/CMD.FILTER_CONTEXT.DATE_FILTER.MOVE" | "GDC.DASH/CMD.ATTRIBUTE_FILTER_CONFIG.SET_MODE" | "GDC.DASH/CMD.ATTRIBUTE_FILTER_CONFIG.SET_LIMITING_ITEMS" | "GDC.DASH/CMD.ATTRIBUTE_FILTER_CONFIG.SET_DISPLAY_AS_LABEL" | "GDC.DASH/CMD.DATE_FILTER_CONFIG.SET_MODE" | "GDC.DASH/CMD.DATE_FILTER_WITH_DIMENSION_CONFIG.SET_MODE" | "GDC.DASH/CMD.DATE_FILTER_CONFIG.SET_TITLE" | "GDC.DASH/CMD.FLUID_LAYOUT.ADD_SECTION" | "GDC.DASH/CMD.FLUID_LAYOUT.MOVE_SECTION" | "GDC.DASH/CMD.FLUID_LAYOUT.MOVE_ITEM_TO_NEW_SECTION" | "GDC.DASH/CMD.FLUID_LAYOUT.REMOVE_SECTION" | "GDC.DASH/CMD.FLUID_LAYOUT.CHANGE_SECTION_HEADER" | "GDC.DASH/CMD.FLUID_LAYOUT.ADD_ITEMS" | "GDC.DASH/CMD.FLUID_LAYOUT.REPLACE_ITEM" | "GDC.DASH/CMD.FLUID_LAYOUT.MOVE_ITEM" | "GDC.DASH/CMD.FLUID_LAYOUT.REMOVE_ITEM" | "GDC.DASH/CMD.FLUID_LAYOUT.REMOVE_ITEM_BY_WIDGET_REF" | "GDC.DASH/CMD.FLUID_LAYOUT.UNDO" | "GDC.DASH/CMD.FLUID_LAYOUT.RESIZE_HEIGHT" | "GDC.DASH/CMD.FLUID_LAYOUT.RESIZE_WIDTH" | "GDC.DASH/CMD.FLUID_LAYOUT.SET_SCREEN_SIZE" | "GDC.DASH/CMD.FLEXIBLE_LAYOUT.TOGGLE_LAYOUT_SECTION_HEADERS" | "GDC.DASH/CMD.KPI_WIDGET.CHANGE_HEADER" | "GDC.DASH/CMD.KPI_WIDGET.CHANGE_MEASURE" | "GDC.DASH/CMD.KPI_WIDGET.CHANGE_FILTER_SETTINGS" | "GDC.DASH/CMD.KPI_WIDGET.CHANGE_COMPARISON" | "GDC.DASH/CMD.KPI_WIDGET.REFRESH" | "GDC.DASH/CMD.KPI_WIDGET.SET_DRILL" | "GDC.DASH/CMD.KPI_WIDGET.REMOVE_DRILL" | "GDC.DASH/CMD.KPI_WIDGET.CHANGE_DESCRIPTION" | "GDC.DASH/CMD.KPI_WIDGET.CHANGE_CONFIGURATION" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_HEADER" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_DESCRIPTION" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_FILTER_SETTINGS" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_PROPERTIES" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_CONFIGURATION" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_INSIGHT" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_IGNORE_CROSS_FILTERING" | "GDC.DASH/CMD.INSIGHT_WIDGET.EXPORT" | "GDC.DASH/CMD.INSIGHT_WIDGET.MODIFY_DRILLS" | "GDC.DASH/CMD.INSIGHT_WIDGET.REMOVE_DRILLS" | "GDC.DASH/CMD.INSIGHT_WIDGET.REMOVE_DRILL_DOWN" | "GDC.DASH/CMD.INSIGHT_WIDGET.ADD_DRILL_DOWN" | "GDC.DASH/CMD.INSIGHT_WIDGET.MODIFY_DRILL_DOWN" | "GDC.DASH/CMD.INSIGHT_WIDGET.REFRESH" | "GDC.DASH/CMD.RICH_TEXT_WIDGET.CHANGE_CONTENT" | "GDC.DASH/CMD.VISUALIZATION_SWITCHER_WIDGET.ADD_VISUALIZATION" | "GDC.DASH/CMD.VISUALIZATION_SWITCHER_WIDGET.UPDATE_VISUALIZATIONS" | "GDC.DASH/CMD.ALERT.CREATE" | "GDC.DASH/CMD.ALERT.SAVE" | "GDC.DASH/CMD.SCHEDULED_EMAIL.CREATE" | "GDC.DASH/CMD.SCHEDULED_EMAIL.SAVE" | "GDC.DASH/CMD.DRILL" | "GDC.DASH/CMD.DRILL.DRILL_DOWN" | "GDC.DASH/CMD.DRILL.DRILL_TO_INSIGHT" | "GDC.DASH/CMD.DRILL.DRILL_TO_DASHBOARD" | "GDC.DASH/CMD.DRILL.DRILL_TO_ATTRIBUTE_URL" | "GDC.DASH/CMD.DRILL.DRILL_TO_CUSTOM_URL" | "GDC.DASH/CMD.DRILL.DRILL_TO_LEGACY_DASHBOARD" | "GDC.DASH/CMD.DRILL.DRILLABLE_ITEMS.CHANGE" | "GDC.DASH/CMD.DRILL.CROSS_FILTERING" | "GDC.DASH/CMD.DRILL_TARGETS.ADD" | "GDC.DASH/CMD.RENDER.ASYNC.REQUEST" | "GDC.DASH/CMD.RENDER.ASYNC.RESOLVE" | "GDC.DASH/CMD.ATTRIBUTE_HIERARCHY_MODIFIED" | "GDC.DASH/CMD.AUTOMATIONS.INITIALIZE" | "GDC.DASH/CMD.AUTOMATIONS.REFRESH" | "GDC.DASH/CMD.FILTER_CONTEXT.FILTER_VIEW.SAVE" | "GDC.DASH/CMD.FILTER_CONTEXT.FILTER_VIEW.DELETE" | "GDC.DASH/CMD.FILTER_CONTEXT.FILTER_VIEW.APPLY" | "GDC.DASH/CMD.FILTER_CONTEXT.FILTER_VIEW.CHANGE_DEFAULT_STATUS" | "GDC.DASH/CMD.FILTER_CONTEXT.FILTER_VIEW.RELOAD" | "GDC.DASH/CMD.USERS.LOAD_ALL" | "GDC.DASH/CMD.INSIGHT_WIDGET.EXPORT_RAW" | "GDC.DASH/CMD.INSIGHT_WIDGET.EXPORT_SLIDES";
+export declare type DashboardCommandType = "GDC.DASH/CMD.INITIALIZE" | "GDC.DASH/CMD.SAVE" | "GDC.DASH/CMD.SAVEAS" | "GDC.DASH/CMD.RESET" | "GDC.DASH/CMD.RENAME" | "GDC.DASH/CMD.DELETE" | "GDC.DASH/CMD.CHANGE_RENDER_MODE" | "GDC.DASH/CMD.SHARING.CHANGE" | "GDC.DASH/CMD.EXPORT.PDF" | "GDC.DASH/CMD.EXPORT.EXCEL" | "GDC.DASH/CMD.EXPORT.PDF_PRESENTATION" | "GDC.DASH/CMD.EXPORT.PPT_PRESENTATION" | "GDC.DASH/CMD.EVENT.TRIGGER" | "GDC.DASH/CMD.EXECUTION_RESULT.UPSERT" | "GDC.DASH/CMD.FILTER_CONTEXT.CHANGE_SELECTION" | "GDC.DASH/CMD.FILTER_CONTEXT.DATE_FILTER.CHANGE_SELECTION" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.ADD" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.REMOVE" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.MOVE" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.CHANGE_SELECTION" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.SET_PARENTS" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.SET_DISPLAY_FORM" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.SET_TITLE" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.SET_SELECTION_MODE" | "GDC.DASH/CMD.FILTER_CONTEXT.ATTRIBUTE_FILTER.SET_DEPENDENT_DATE_FILTERS" | "GDC.DASH/CMD.FILTER_CONTEXT.DATE_FILTER.ADD" | "GDC.DASH/CMD.FILTER_CONTEXT.DATE_FILTER.REMOVE" | "GDC.DASH/CMD.FILTER_CONTEXT.DATE_FILTER.MOVE" | "GDC.DASH/CMD.ATTRIBUTE_FILTER_CONFIG.SET_MODE" | "GDC.DASH/CMD.ATTRIBUTE_FILTER_CONFIG.SET_LIMITING_ITEMS" | "GDC.DASH/CMD.ATTRIBUTE_FILTER_CONFIG.SET_DISPLAY_AS_LABEL" | "GDC.DASH/CMD.DATE_FILTER_CONFIG.SET_MODE" | "GDC.DASH/CMD.DATE_FILTER_WITH_DIMENSION_CONFIG.SET_MODE" | "GDC.DASH/CMD.DATE_FILTER_CONFIG.SET_TITLE" | "GDC.DASH/CMD.FLUID_LAYOUT.ADD_SECTION" | "GDC.DASH/CMD.FLUID_LAYOUT.MOVE_SECTION" | "GDC.DASH/CMD.FLUID_LAYOUT.MOVE_ITEM_TO_NEW_SECTION" | "GDC.DASH/CMD.FLUID_LAYOUT.REMOVE_SECTION" | "GDC.DASH/CMD.FLUID_LAYOUT.CHANGE_SECTION_HEADER" | "GDC.DASH/CMD.FLUID_LAYOUT.ADD_ITEMS" | "GDC.DASH/CMD.FLUID_LAYOUT.REPLACE_ITEM" | "GDC.DASH/CMD.FLUID_LAYOUT.MOVE_ITEM" | "GDC.DASH/CMD.FLUID_LAYOUT.REMOVE_ITEM" | "GDC.DASH/CMD.FLUID_LAYOUT.REMOVE_ITEM_BY_WIDGET_REF" | "GDC.DASH/CMD.FLUID_LAYOUT.UNDO" | "GDC.DASH/CMD.FLUID_LAYOUT.RESIZE_HEIGHT" | "GDC.DASH/CMD.FLUID_LAYOUT.RESIZE_WIDTH" | "GDC.DASH/CMD.FLUID_LAYOUT.SET_SCREEN_SIZE" | "GDC.DASH/CMD.FLEXIBLE_LAYOUT.TOGGLE_LAYOUT_SECTION_HEADERS" | "GDC.DASH/CMD.KPI_WIDGET.CHANGE_HEADER" | "GDC.DASH/CMD.KPI_WIDGET.CHANGE_MEASURE" | "GDC.DASH/CMD.KPI_WIDGET.CHANGE_FILTER_SETTINGS" | "GDC.DASH/CMD.KPI_WIDGET.CHANGE_COMPARISON" | "GDC.DASH/CMD.KPI_WIDGET.REFRESH" | "GDC.DASH/CMD.KPI_WIDGET.SET_DRILL" | "GDC.DASH/CMD.KPI_WIDGET.REMOVE_DRILL" | "GDC.DASH/CMD.KPI_WIDGET.CHANGE_DESCRIPTION" | "GDC.DASH/CMD.KPI_WIDGET.CHANGE_CONFIGURATION" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_HEADER" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_DESCRIPTION" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_FILTER_SETTINGS" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_PROPERTIES" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_CONFIGURATION" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_INSIGHT" | "GDC.DASH/CMD.INSIGHT_WIDGET.CHANGE_IGNORE_CROSS_FILTERING" | "GDC.DASH/CMD.INSIGHT_WIDGET.EXPORT" | "GDC.DASH/CMD.INSIGHT_WIDGET.MODIFY_DRILLS" | "GDC.DASH/CMD.INSIGHT_WIDGET.REMOVE_DRILLS" | "GDC.DASH/CMD.INSIGHT_WIDGET.REMOVE_DRILL_DOWN" | "GDC.DASH/CMD.INSIGHT_WIDGET.ADD_DRILL_DOWN" | "GDC.DASH/CMD.INSIGHT_WIDGET.MODIFY_DRILL_DOWN" | "GDC.DASH/CMD.INSIGHT_WIDGET.REFRESH" | "GDC.DASH/CMD.RICH_TEXT_WIDGET.CHANGE_CONTENT" | "GDC.DASH/CMD.VISUALIZATION_SWITCHER_WIDGET.ADD_VISUALIZATION" | "GDC.DASH/CMD.VISUALIZATION_SWITCHER_WIDGET.UPDATE_VISUALIZATIONS" | "GDC.DASH/CMD.ALERT.CREATE" | "GDC.DASH/CMD.ALERT.SAVE" | "GDC.DASH/CMD.SCHEDULED_EMAIL.CREATE" | "GDC.DASH/CMD.SCHEDULED_EMAIL.SAVE" | "GDC.DASH/CMD.DRILL" | "GDC.DASH/CMD.DRILL.DRILL_DOWN" | "GDC.DASH/CMD.DRILL.DRILL_TO_INSIGHT" | "GDC.DASH/CMD.DRILL.DRILL_TO_DASHBOARD" | "GDC.DASH/CMD.DRILL.DRILL_TO_ATTRIBUTE_URL" | "GDC.DASH/CMD.DRILL.DRILL_TO_CUSTOM_URL" | "GDC.DASH/CMD.DRILL.DRILL_TO_LEGACY_DASHBOARD" | "GDC.DASH/CMD.DRILL.DRILLABLE_ITEMS.CHANGE" | "GDC.DASH/CMD.DRILL.CROSS_FILTERING" | "GDC.DASH/CMD.DRILL_TARGETS.ADD" | "GDC.DASH/CMD.RENDER.ASYNC.REQUEST" | "GDC.DASH/CMD.RENDER.ASYNC.RESOLVE" | "GDC.DASH/CMD.ATTRIBUTE_HIERARCHY_MODIFIED" | "GDC.DASH/CMD.AUTOMATIONS.INITIALIZE" | "GDC.DASH/CMD.AUTOMATIONS.REFRESH" | "GDC.DASH/CMD.FILTER_CONTEXT.FILTER_VIEW.SAVE" | "GDC.DASH/CMD.FILTER_CONTEXT.FILTER_VIEW.DELETE" | "GDC.DASH/CMD.FILTER_CONTEXT.FILTER_VIEW.APPLY" | "GDC.DASH/CMD.FILTER_CONTEXT.FILTER_VIEW.CHANGE_DEFAULT_STATUS" | "GDC.DASH/CMD.FILTER_CONTEXT.FILTER_VIEW.RELOAD" | "GDC.DASH/CMD.FILTER_CONTEXT.APPLY_WORKING_SELECTION" | "GDC.DASH/CMD.USERS.LOAD_ALL" | "GDC.DASH/CMD.INSIGHT_WIDGET.EXPORT_RAW" | "GDC.DASH/CMD.INSIGHT_WIDGET.EXPORT_SLIDES";
 
 /**
  * Dashboard configuration can influence the available features, look and feel and behavior of the dashboard.
@@ -6548,6 +6615,10 @@ export declare interface DateFilterSelection {
      * The localId of the DateFilterOption selected.
      */
     readonly dateFilterOptionLocalId?: string;
+    /**
+     * Determines if this command should change working (staged for application) filters or applied filters (used to compute data).
+     */
+    readonly isWorkingSelectionChange?: boolean;
 }
 
 /**
@@ -7865,10 +7936,27 @@ export declare function filterContextItemsToDashboardFiltersByWidget(filterConte
  */
 export declare interface FilterContextState {
     /**
-     * Filter context definition contains the actual filters to use. Filter context definition is present
+     * Filter context definition contains the actual filters to use. They are applied and used to compute insights data.
+     * Filter context definition is present.
      * @beta
      */
     filterContextDefinition?: IFilterContextDefinition;
+    /**
+     * Contains staged filters state which are not applied by the user yet.
+     * They are used to show selected values in filters and when user requests, they are applied to the filterContextDefinition (above).
+     *
+     * @remarks
+     * This working filter context contains only changed filters and their fields.
+     * before using this working, this state is merged with filterContextDefinition.
+     *
+     * This way we do not need to synchronize other fields, which makes it easier to maintain.
+     *
+     * This state is used when DashboardFiltersApplyMode is ALL_AT_ONCE.
+     * But can be used programatically when embedding the dashboard too.
+     *
+     * @alpha
+     */
+    workingFilterContextDefinition?: IWorkingFilterContextDefinition;
     /**
      * Filter context definition contains the original dashboard filters stored on the backend.
      * @beta
@@ -8669,8 +8757,9 @@ export declare interface IDashboardAttributeFilterProps {
      *
      * @param filter - new attribute filter value.
      * @param displayAsLabel - label used for presentation of attribute filter elements in UI
+     * @param isWorkingSelectionChange - if the change is to applied (application of filters) or unapplied filters (filters staged before application).
      */
-    onFilterChanged: (filter: IDashboardAttributeFilter, displayAsLabel?: ObjRef) => void;
+    onFilterChanged: (filter: IDashboardAttributeFilter, displayAsLabel?: ObjRef, isWorkingSelectionChange?: boolean) => void;
     /**
      * Callback to be called, when user closes filter dropdown
      */
@@ -9376,8 +9465,9 @@ export declare interface IDashboardDateFilterProps {
      *
      * @param filter - new date filter value
      * @param dateFilterOptionLocalId - localId of the {@link @gooddata/sdk-backend-spi#IDateFilterOption} selected
+     * @param isWorkingSelectionChange - determines if the change is in working filter state (staged for application but not applied yet)
      */
-    onFilterChanged: (filter: IDashboardDateFilter | undefined, dateFilterOptionLocalId?: string) => void;
+    onFilterChanged: (filter: IDashboardDateFilter | undefined, dateFilterOptionLocalId?: string, isWorkingSelectionChange?: boolean) => void;
     /**
      * Additional DateFilter configuration.
      */
@@ -14097,6 +14187,18 @@ export declare interface IVisualizationSwitcherToolbarProps {
     onClose: () => void;
 }
 
+/**
+ * Working filter context.
+ *
+ * @alpha
+ */
+export declare interface IWorkingFilterContextDefinition {
+    /**
+     * Partial attribute or date filters
+     */
+    readonly filters: WorkingFilterContextItem[];
+}
+
 /**
  * @internal
  */
@@ -18844,7 +18946,7 @@ export declare const selectFilterContextAttributeFilterByDisplayForm: (displayFo
 export declare const selectFilterContextAttributeFilterByLocalId: (localId: string) => DashboardSelector<IDashboardAttributeFilter | undefined>;
 
 /**
- * This selector returns dashboard's filter context attribute filters.
+ * This selector returns dashboard's applied filter context attribute filters.
  *
  * @remarks
  * It is expected that the selector is called only after the filter context state is correctly initialized.
@@ -18855,7 +18957,7 @@ export declare const selectFilterContextAttributeFilterByLocalId: (localId: stri
 export declare const selectFilterContextAttributeFilters: DashboardSelector<IDashboardAttributeFilter[]>;
 
 /**
- * This selector returns dashboard's filter context date filter.
+ * This selector returns dashboard's applied filter context date filter.
  *
  * @remarks
  * It is expected that the selector is called only after the filter context state is correctly initialized.
@@ -18876,7 +18978,7 @@ export declare const selectFilterContextDateFilter: DashboardSelector<IDashboard
 export declare const selectFilterContextDateFilterByDataSet: (dataSet: ObjRef) => (state: DashboardState) => IDashboardDateFilter | undefined;
 
 /**
- * This selector returns dashboard's filter context date filter with dimension specified.
+ * This selector returns dashboard's applied filter context date filter with dimension specified.
  *
  * @remarks
  * It is expected that the selector is called only after the filter context state is correctly initialized.
@@ -18887,7 +18989,7 @@ export declare const selectFilterContextDateFilterByDataSet: (dataSet: ObjRef) =
 export declare const selectFilterContextDateFiltersWithDimension: DashboardSelector<IDashboardDateFilter[]>;
 
 /**
- * This selector returns current dashboard's filter context definition.
+ * This selector returns current applied dashboard's filter context definition.
  *
  * @remarks
  * It is expected that the selector is called only after the filter context state is correctly initialized.
@@ -18900,7 +19002,7 @@ export declare const selectFilterContextDateFiltersWithDimension: DashboardSelec
 export declare const selectFilterContextDefinition: DashboardSelector<IFilterContextDefinition>;
 
 /**
- * This selector returns dashboard's filter context filters.
+ * This selector returns dashboard's applied filter context filters.
  *
  * @remarks
  * It is expected that the selector is called only after the filter context state is correctly initialized.
@@ -19473,6 +19575,20 @@ export declare const selectIsWidgetDeleteDialogOpen: DashboardSelector<boolean>;
  */
 export declare const selectIsWidgetLoadingAdditionalDataByWidgetRef: (refs: ObjRef) => DashboardSelector<boolean>;
 
+/**
+ * Returns true if working filters and applied filters are same.
+ *
+ * Attribute filters are considered equal if
+ *  - they have same localIdentifier
+ *  - they have same elements (order does not matter)
+ *  - all other fields are deep equal EXCEPT displayForm
+ * We exclude diplayForm becuase of primary display form migration code.
+ * Which changes display forms after update.
+ *
+ * @alpha
+ */
+export declare const selectIsWorkingFilterContextChanged: DashboardSelector<boolean | undefined>;
+
 /**
  * @internal
  *
@@ -20003,6 +20119,63 @@ export declare const selectWidgetsOverlay: DashboardSelector<Record<string, IDas
  */
 export declare const selectWidgetsOverlayState: (refs: (ObjRef | undefined)[]) => DashboardSelector<boolean>;
 
+/**
+ * This selector returns dashboard's working filter context attribute filters.
+ *
+ * @remarks
+ * It is expected that the selector is called only after the filter context state is correctly initialized.
+ * Invocations before initialization lead to invariant errors.
+ *
+ * @public
+ */
+export declare const selectWorkingFilterContextAttributeFilters: DashboardSelector<IDashboardAttributeFilter[]>;
+
+/**
+ * This selector returns dashboard's working filter context date filter.
+ *
+ * @remarks
+ * It is expected that the selector is called only after the filter context state is correctly initialized.
+ * Invocations before initialization lead to invariant errors.
+ *
+ * @public
+ */
+export declare const selectWorkingFilterContextDateFilter: DashboardSelector<IDashboardDateFilter | undefined>;
+
+/**
+ * This selector returns dashboard's working filter context date filter with dimension specified.
+ *
+ * @remarks
+ * It is expected that the selector is called only after the filter context state is correctly initialized.
+ * Invocations before initialization lead to invariant errors.
+ *
+ * @public
+ */
+export declare const selectWorkingFilterContextDateFiltersWithDimension: DashboardSelector<IDashboardDateFilter[]>;
+
+/**
+ * This selector returns current working dashboard's filter context definition.
+ *
+ * @remarks
+ * It is expected that the selector is called only after the wokring filter context state is correctly initialized.
+ * Invocations before initialization lead to invariant errors.
+ *
+ * @returns a {@link @gooddata/sdk-backend-spi#IFilterContextDefinition}
+ *
+ * @alpha
+ */
+export declare const selectWorkingFilterContextDefinition: DashboardSelector<IFilterContextDefinition>;
+
+/**
+ * This selector returns dashboard's working filter context filters.
+ *
+ * @remarks
+ * It is expected that the selector is called only after the filter context state is correctly initialized.
+ * Invocations before initialization lead to invariant errors.
+ *
+ * @public
+ */
+export declare const selectWorkingFilterContextFilters: DashboardSelector<FilterContextItem[]>;
+
 /**
  * @beta
  */
@@ -20057,9 +20230,10 @@ export declare interface SetAttributeFilterDisplayForm extends IDashboardCommand
  * @beta
  * @param filterLocalId - local identifier of the filter the display form is changed for
  * @param displayForm - newly selected display form
+ * @param isWorkingSelectionChange - determines if command updates working filter context or applied filter context. Applied filter context is default.
  * @returns change filter display form command
  */
-export declare function setAttributeFilterDisplayForm(filterLocalId: string, displayForm: ObjRef): SetAttributeFilterDisplayForm;
+export declare function setAttributeFilterDisplayForm(filterLocalId: string, displayForm: ObjRef, isWorkingSelectionChange?: boolean): SetAttributeFilterDisplayForm;
 
 /**
  * @beta
@@ -20067,6 +20241,7 @@ export declare function setAttributeFilterDisplayForm(filterLocalId: string, dis
 export declare interface SetAttributeFilterDisplayFormPayload {
     filterLocalId: string;
     displayForm: ObjRef;
+    isWorkingSelectionChange?: boolean;
 }
 
 /**
@@ -22399,4 +22574,20 @@ export declare interface WithDrillSelectProps {
     }) => JSX.Element;
 }
 
+/**
+ * Partial working attribute filter used in working filter context.
+ *
+ * @alpha
+ */
+export declare type WorkingDashboardAttributeFilter = {
+    attributeFilter: Partial<IDashboardAttributeFilter["attributeFilter"]>;
+};
+
+/**
+ * Partial working filter context item.
+ *
+ * @alpha
+ */
+export declare type WorkingFilterContextItem = WorkingDashboardAttributeFilter | IDashboardDateFilter;
+
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-ui-dashboard",
-  "version": "10.22.0-alpha.47",
+  "version": "10.22.0-alpha.49",
   "description": "GoodData SDK - Dashboard Component",
   "repository": {
     "type": "git",
@@ -57,17 +57,17 @@
     "ts-invariant": "^0.7.5",
     "tslib": "^2.5.0",
     "uuid": "^8.3.2",
-    "@gooddata/sdk-backend-base": "10.22.0-alpha.47",
-    "@gooddata/sdk-backend-spi": "10.22.0-alpha.47",
-    "@gooddata/sdk-model": "10.22.0-alpha.47",
-    "@gooddata/sdk-ui-ext": "10.22.0-alpha.47",
-    "@gooddata/sdk-ui": "10.22.0-alpha.47",
-    "@gooddata/sdk-ui-filters": "10.22.0-alpha.47",
-    "@gooddata/sdk-ui-geo": "10.22.0-alpha.47",
-    "@gooddata/sdk-ui-kit": "10.22.0-alpha.47",
-    "@gooddata/sdk-ui-vis-commons": "10.22.0-alpha.47",
-    "@gooddata/sdk-ui-theme-provider": "10.22.0-alpha.47",
-    "@gooddata/util": "10.22.0-alpha.47"
+    "@gooddata/sdk-backend-base": "10.22.0-alpha.49",
+    "@gooddata/sdk-backend-spi": "10.22.0-alpha.49",
+    "@gooddata/sdk-model": "10.22.0-alpha.49",
+    "@gooddata/sdk-ui": "10.22.0-alpha.49",
+    "@gooddata/sdk-ui-ext": "10.22.0-alpha.49",
+    "@gooddata/sdk-ui-filters": "10.22.0-alpha.49",
+    "@gooddata/sdk-ui-geo": "10.22.0-alpha.49",
+    "@gooddata/sdk-ui-kit": "10.22.0-alpha.49",
+    "@gooddata/sdk-ui-theme-provider": "10.22.0-alpha.49",
+    "@gooddata/sdk-ui-vis-commons": "10.22.0-alpha.49",
+    "@gooddata/util": "10.22.0-alpha.49"
   },
   "peerDependencies": {
     "react": "^16.10.0 || ^17.0.0 || ^18.0.0",
@@ -120,9 +120,9 @@
     "typescript": "5.3.3",
     "vitest": "1.0.4",
     "vitest-dom": "0.1.1",
-    "@gooddata/i18n-toolkit": "10.22.0-alpha.47",
-    "@gooddata/reference-workspace": "10.22.0-alpha.47",
-    "@gooddata/sdk-backend-mockingbird": "10.22.0-alpha.47"
+    "@gooddata/i18n-toolkit": "10.22.0-alpha.49",
+    "@gooddata/reference-workspace": "10.22.0-alpha.49",
+    "@gooddata/sdk-backend-mockingbird": "10.22.0-alpha.49"
   },
   "scripts": {
     "clean": "rm -rf ci dist esm coverage *.log styles/css tsconfig.tsbuildinfo",

package/styles/scss/filterBar.scss

@@ -1,4 +1,4 @@
-// (C) 2019-2024 GoodData Corporation
+// (C) 2019-2025 GoodData Corporation
 @use "sass:color";
 @use "variables";
 @use "zIndexes";