connectIModelConnectionAndViewState Function

Beta  

Function that will connect a component to the IModelConnection data in the Redux store

connectIModelConnectionAndViewState(mapStateToProps?: any, mapDispatchToProps?: any): InferableComponentEnhancerWithProps<any, any>

example
// connect component for both getting and setting ImodelConnection data from Redux store. import { connectIModelConnection, sessionStateMapDispatchToProps, SessionStateActionsProps } from "@itwin/appui-react";

export interface ComponentProps extends SessionStateActionsProps { myData: string; }

export const ConnectControl = connectIModelConnection(null, sessionStateMapDispatchToProps)(ComponentClass); // eslint-disable-line @typescript-eslint/naming-convention

// this then allows connected control to update the store using a call like shown below. this.props.setNumItemsSelected(30);

Returns - InferableComponentEnhancerWithProps<any, any>

Defined in

• ui/appui-react/src/appui-react/redux/connectIModel.ts Line 100

Last Updated: 30 November, 2023