FrameworkReducer Function

Framework reducer that combines the ConfigurableUiReducer and SessionStateReducer.

FrameworkReducer(state: CombinedReducerState<{ configurableUiState: (state: ConfigurableUiState = initialState, action: ConfigurableUiActionsUnion) => ConfigurableUiState, sessionState: (state: SessionState = initialState, action: SessionStateActionsUnion) => DeepReadonly<SessionState> }>, action: DeepReadonlyObject<ActionWithPayload<SetSnapMode, number>> | DeepReadonlyObject<ActionWithPayload<SetTheme, string>> | DeepReadonlyObject<ActionWithPayload<SetToolPrompt, string>> | DeepReadonlyObject<ActionWithPayload<SetWidgetOpacity, number>> | DeepReadonlyObject<ActionWithPayload<SetDragInteraction, boolean>> | DeepReadonlyObject<ActionWithPayload<SetShowWidgetIcon, boolean>> | DeepReadonlyObject<ActionWithPayload<AutoCollapseUnpinnedPanels, boolean>> | DeepReadonlyObject<ActionWithPayload<SetViewOverlayDisplay, boolean>> | DeepReadonlyObject<ActionWithPayload<AnimateToolSettings, boolean>> | DeepReadonlyObject<ActionWithPayload<UseToolAsToolSettingsLabel, boolean>> | DeepReadonlyObject<ActionWithPayload<SetToolbarOpacity, number>> | DeepReadonlyObject<ActionWithPayload<SetActiveIModelId, string>> | DeepReadonlyObject<ActionWithPayload<SetAvailableSelectionScopes, DeepReadonlyArray<PresentationSelectionScope>>> | DeepReadonlyObject<ActionWithPayload<SetDefaultIModelViewportControlId, string>> | DeepReadonlyObject<ActionWithPayload<SetDefaultViewId, string>> | DeepReadonlyObject<ActionWithPayload<SetDefaultViewState, any>> | DeepReadonlyObject<ActionWithPayload<SetNumItemsSelected, number>> | DeepReadonlyObject<ActionWithPayload<SetIModelConnection, any>> | DeepReadonlyObject<ActionWithPayload<SetSelectionScope, string>> | DeepReadonlyObject<ActionWithPayload<UpdateCursorMenu, DeepReadonlyObject<CursorMenuData> | DeepReadonlyObject<CursorMenuPayload>>>): CombinedReducerState<{ configurableUiState: (state: ConfigurableUiState = initialState, action: ConfigurableUiActionsUnion) => ConfigurableUiState, sessionState: (state: SessionState = initialState, action: SessionStateActionsUnion) => DeepReadonly<SessionState> }>

Parameter Type Description
state CombinedReducerState<{ configurableUiState: (state: ConfigurableUiState = initialState, action: ConfigurableUiActionsUnion) => ConfigurableUiState, sessionState: (state: SessionState = initialState, action: SessionStateActionsUnion) => DeepReadonly<SessionState> }>  
action DeepReadonlyObject<ActionWithPayload<SetSnapMode, number>> | DeepReadonlyObject<ActionWithPayload<SetTheme, string>> | DeepReadonlyObject<ActionWithPayload<SetToolPrompt, string>> | DeepReadonlyObject<ActionWithPayload<SetWidgetOpacity, number>> | DeepReadonlyObject<ActionWithPayload<SetDragInteraction, boolean>> | DeepReadonlyObject<ActionWithPayload<SetShowWidgetIcon, boolean>> | DeepReadonlyObject<ActionWithPayload<AutoCollapseUnpinnedPanels, boolean>> | DeepReadonlyObject<ActionWithPayload<SetViewOverlayDisplay, boolean>> | DeepReadonlyObject<ActionWithPayload<AnimateToolSettings, boolean>> | DeepReadonlyObject<ActionWithPayload<UseToolAsToolSettingsLabel, boolean>> | DeepReadonlyObject<ActionWithPayload<SetToolbarOpacity, number>> | DeepReadonlyObject<ActionWithPayload<SetActiveIModelId, string>> | DeepReadonlyObject<ActionWithPayload<SetAvailableSelectionScopes, DeepReadonlyArray<PresentationSelectionScope>>> | DeepReadonlyObject<ActionWithPayload<SetDefaultIModelViewportControlId, string>> | DeepReadonlyObject<ActionWithPayload<SetDefaultViewId, string>> | DeepReadonlyObject<ActionWithPayload<SetDefaultViewState, any>> | DeepReadonlyObject<ActionWithPayload<SetNumItemsSelected, number>> | DeepReadonlyObject<ActionWithPayload<SetIModelConnection, any>> | DeepReadonlyObject<ActionWithPayload<SetSelectionScope, string>> | DeepReadonlyObject<ActionWithPayload<UpdateCursorMenu, DeepReadonlyObject<CursorMenuData> | DeepReadonlyObject<CursorMenuPayload>>>  

Returns - CombinedReducerState<{ configurableUiState: (state: ConfigurableUiState = initialState, action: ConfigurableUiActionsUnion) => ConfigurableUiState, sessionState: (state: SessionState = initialState, action: SessionStateActionsUnion) => DeepReadonly<SessionState> }>

Defined in

Last Updated: 05 April, 2024