Widget

Classes for working with a Widget

Classes

Name Description  
DefaultNavigationWidget Default Navigation Widget for zone 3. Beta
NavigationWidget Navigation Widget React component.  
NavigationWidgetDef Definition of a Navigation Widget normally displayed in the top right zone in the 9-Zone Layout system.  
ReviewToolWidget Default Tool Widget for standard "review" applications. Beta
ToolbarWidgetDefBase A Toolbar Widget normally displayed in the top left & top right zones in the 9-Zone Layout system.  
ToolWidget ToolWidget React component.  
ToolWidgetDef Definition of a Tool Widget normally displayed in the top left zone in the 9-Zone Layout system.  
VisibilityComponent VisibilityComponent React component. Beta
VisibilityWidget VisibilityWidget React component. Beta
Widget Widget React component.  
WidgetControl The base class for Widget controls.  
WidgetDef A Widget Definition in the 9-Zone Layout system.  
WidgetHost A WidgetHost represents a definition that hosts one or most Widgets in a Frontstage.  
WidgetManager Widget Manager class. Beta
WidgetStateChangedEvent Widget State Changed Event class.  

Constants

Name Description  
IModelConnectedNavigationWidget DefaultNavigationWidget that is connected to the IModelConnection property in the Redux store. Beta
IModelConnectedVisibilityComponent VisibilityComponent that is connected to the IModelConnection property in the Redux store. Beta

Enumerations

Name Description  
VisibilityComponentHierarchy Types of hierarchies displayed in the VisibilityComponent  
WidgetState Widget state enum.  
WidgetType Widget type enum.  

Global Functions

Name Description  
BackstageAppButton BackstageAppButton used to toggle display of Backstage. Beta
BasicNavigationWidget Basic Navigation Widget that provides standard tools to manipulate views containing element data. Beta
BasicToolWidget Default Tool Widget for standard "review" applications. Beta
NavigationAidHost NavigationAidHost is a component that hosts a NavigationAid that is specific to the active content control. Beta
NavigationWidgetComposer Component that Composes a NavigationWidget typically using toolbars generated via ToolbarComposer class. Beta
ToolWidgetComposer ToolWidget component that supports use of ToolbarComposer-based Toolbars. Beta

Interfaces

Name Description  
BackstageAppButtonProps Properties for the BackstageAppButton React component Beta
BasicNavigationWidgetProps Properties that can be used to append items to the default set of toolbar items of DefaultNavigationWidget. Beta
BasicToolWidgetProps Properties that can be used to append items to the default set of toolbar items of ReviewToolWidget. Beta
DefaultNavigationProps Properties that can be used to append items to the default set of toolbar items of DefaultNavigationWidget. Beta
NavigationAidHostProps Properties for the NavigationAidHost React component Beta
NavigationWidgetComposerProps Properties for the NavigationWidgetComposer React components Beta
NavigationWidgetProps Properties for a Navigation Widget.  
NavigationWidgetPropsEx Properties for the NavigationWidget React component.  
ReviewToolWidgetProps Properties that can be used to append items to the default set of toolbar items of ReviewToolWidget. Beta
ToolbarWidgetProps Properties for a Toolbar Widget.  
ToolWidgetComposerProps Properties for the ToolbarComposer React components Beta
ToolWidgetProps Properties for a Tool Widget.  
ToolWidgetPropsEx Properties for the ToolWidget React component.  
VisibilityComponentConfig Data structure that describes visibility component configuration Beta
VisibilityComponentProps Props for VisibilityComponent Beta
WidgetProps Properties for a Widget component.  
WidgetProvider Widget Provider interface. Beta
WidgetStateChangedEventArgs Widget State Changed Event Args interface.  

Type Aliases

Name Description  
AnyWidgetProps Union of all Widget properties.  
WidgetStateFunc Prototype for WidgetDef StateFunc  

Last Updated: 22 October, 2020