UiAdmin Class
Beta
The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the imodeljs-frontend package.
Methods
Name | Description | |
---|---|---|
createXAndY(x: number, y: number): XAndY | Create an XAndY object. | |
hideCalculator(): boolean | Hides the calculator. | |
hideHTMLElement(): boolean | Hides the HTML Element. | |
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, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean | Show a calculator at a particular location. | |
showContextMenu(_menuItemsProps: AbstractMenuItemProps[], _location: XAndY, _htmlElement?: HTMLElement): boolean | Show a context menu at a particular location. | |
showHTMLElement(_displayElement: HTMLElement, _location: XAndY, _offset: XAndY, _onCancel: OnCancelFunc, _relativePosition?: RelativePosition, _htmlElement?: HTMLElement): boolean | Show an HTML element 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. |
Properties
Name | Type | Description | |
---|---|---|---|
cursorPosition Accessor ReadOnly | XAndY | Get the cursor X and Y position. |
Defined in
Last Updated: 05 June, 2020