API Reference > ui-framework > Admin > FrameworkUiAdmin

FrameworkUiAdmin Class

Beta

The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the imodeljs-frontend package.

Extends

Methods

Name Description
hideCalculator(): boolean Hides the calculator.  
hideInputEditor(): boolean Hides the input editor.  
hideMenuButton(id: string): boolean Hides a menu button.  
hideToolbar(): boolean Hides the toolbar.  
showAngleEditor(initialValue: number, location: XAndY, onCommit: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean Show an input editor for an angle value at a particular location.  
showCalculator(initialValue: number, resultIcon: string, location: XAndY, onOk: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean Show a calculator at a particular location.  
showContextMenu(items: AbstractMenuItemProps[], location: XAndY, htmlElement?: HTMLElement): boolean Show a context menu at a particular location.  
showHeightEditor(initialValue: number, location: XAndY, onCommit: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean Show an input editor for a height value at a particular location.  
showLengthEditor(initialValue: number, location: XAndY, onCommit: OnNumberCommitFunc, onCancel: OnCancelFunc, htmlElement?: HTMLElement): boolean Show an input editor for a length value at a particular location.  
showMenuButton(id: string, menuItemsProps: AbstractMenuItemProps[], location: XAndY, htmlElement?: HTMLElement): boolean Show a menu button at a particular location.  
showToolbar(toolbarProps: AbstractToolbarProps, location: XAndY, offset: XAndY, onItemExecuted: OnItemExecutedFunc, onCancel: OnCancelFunc, relativePosition?: RelativePosition, htmlElement?: HTMLElement): boolean Show a Toolbar at a particular location.  

Inherited methods

Name Inherited from Description
createXAndY(x: number, y: number): XAndY UiAdmin Create an XAndY object.

Properties

Name Type Description
cursorPosition Accessor ReadOnly XAndY Gets the cursor X and Y position.  

Defined in

Last Updated: 08 January, 2020