API Reference > ui-framework > Zone > ZoneDef

ZoneDef Class

A ZoneDef represents each zone within a Frontstage.

Extends

Methods

Name Description
constructor(): ZoneDef Constructor for ZoneDef.  

Inherited methods

Name Inherited from Description
addWidgetDef(widgetDef: WidgetDef): void WidgetHost Adds a WidgetDef to the list of Widgets.
findWidgetDef(id: string): WidgetDef | undefined WidgetHost Finds a WidgetDef with a given Id.
getSingleWidgetDef(): WidgetDef | undefined WidgetHost If there is only one Widget in the Panel, gets the single WidgetDef.

Properties

Name Type Description
allowsMerging boolean Indicates if other Zones may be merged with this Zone.  
applicationData undefined | any Any application data to attach to this Zone.  
initialWidth Accessor ReadOnly number | undefined Initial zone width.  
isStatusBar Accessor ReadOnly boolean Determines if this Zone is for the Status Bar.  
isToolSettings Accessor ReadOnly boolean Determines if this Zone is for Tool Settings.  
mergeWithZone undefined | ZoneLocation Indicates with which other zone to merge.  
shouldFillZone Accessor ReadOnly boolean Determines if the Zone should fill the available space.  
zoneState ZoneState Zone state.  

Inherited properties

Name Type Inherited from Description
widgetCount Accessor ReadOnly number WidgetHost Gets the number of Widgets.
widgetDefs Accessor ReadOnly WidgetDef[] WidgetHost Gets the list of Widgets.

Defined in

Last Updated: 08 January, 2020