Frontstage

Classes for working with a Frontstage

Classes

Name Description  
Frontstage Frontstage React component.  
FrontstageActivatedEvent Frontstage Activated Event class.  
FrontstageComposer FrontstageComposer React component.  
FrontstageDeactivatedEvent Frontstage Deactivated Event class.  
FrontstageDef FrontstageDef class provides an API for a Frontstage.  
FrontstageManager Frontstage Manager class.  
FrontstageProvider Provides a Frontstage as a React based definition  
FrontstageReadyEvent Frontstage Ready Event class.  
ModalFrontstage ModalFrontstage React component  
ModalFrontstageChangedEvent Modal Frontstage Stack Changed Event class.  
ModalFrontstageClosedEvent Modal Frontstage Closed Event class.  
NestedFrontstage Nested Frontstage related classes and commands  
PanelStateChangedEvent Widget State Changed Event class. Beta
StagePanel Frontstage Panel React component. Beta
StagePanelDef A StagePanelDef represents each Stage Panel within a Frontstage. Beta
ToolActivatedEvent Tool Activated Event class.  
ToolIconChangedEvent Tool Icon Changed Event class.  

Enumerations

Name Description  
SelectionScope Selection Scope enum.  
StagePanelState Enum for StagePanel state. Beta

Global Functions

Name Description  
useActiveFrontstageId Hook that returns active frontstage id. Beta

Interfaces

Name Description  
FrontstageActivatedEventArgs Frontstage Activated Event Args interface.  
FrontstageDeactivatedEventArgs Frontstage Deactivated Event Args interface.  
FrontstageProps Properties for a Frontstage component.  
FrontstageReadyEventArgs Frontstage Ready Event Args interface.  
ModalFrontstageChangedEventArgs Modal Frontstage Changed Event Args interface.  
ModalFrontstageClosedEventArgs Modal Frontstage Closed Event Args interface.  
ModalFrontstageInfo Modal Frontstage information interface.  
ModalFrontstageProps Properties for the ModalFrontstage React component  
NineZoneChangeHandler Interface defining callbacks for nine zone changes  
PanelStateChangedEventArgs Panel State Changed Event Args interface. Beta
StagePanelChangeHandler Interface defining callbacks for stage panel changes  
StagePanelProps Properties of a StagePanel component Beta
StagePanelZoneProps Properties of a Stage Panel Zone Beta
StagePanelZonesProps Properties of the Stage Panel Zones Beta
TargetChangeHandler Interface defining callbacks for ZoneDropTarget changes  
ToolActivatedEventArgs Tool Activated Event Args interface.  
ToolIconChangedEventArgs Tool Icon Changed Event Args interface.  
WidgetChangeHandler Interface defining callbacks for widget changes  
ZoneDefProvider Interface defining a provider for Zone definitions  

Type Aliases

Name Description  
StagePanelDefaultProps Default properties of StagePanel component. Beta
StagePanelMaxSizeSpec Available units of panel maximum size. Beta

Last Updated: 15 October, 2020