Interface UIAPI

The API for operations related to Trimble Connect Web and 3D Viewer UI.

Hierarchy

UIAPI

Index

Methods

Methods

addCustomFileAction

addCustomFileAction(fileActionConfig: IFileActionConfig[]): Promise<boolean>

Adds additional option along with the default Connect file view option. (this API currently available only for the built-in extensions in Timble Connect web)

Parameters
- fileActionConfig: IFileActionConfig[]
  
  The configuration object for the custom file action.
Returns Promise<boolean>
The awaitable task that returns the current Trimble Connect user.

getUI

getUI(): Promise<ElementState[]>

Gets all the UI elements and their states.

Returns Promise<ElementState[]>
The awaitable task that returns the UI elements and their states.

setActiveMenuItem

setActiveMenuItem(command: string): Promise<boolean>

Activate the Trimble Connect web navigation submenu based on the command value from the project extension.

Parameters
- command: string
  
  submenu command value.
Returns Promise<boolean>
The awaitable task

setMenu

setMenu(menu: ExtensionMainMenu): Promise<ExtensionMainMenu>

Configures Trimble Connect web navigation menu from the Project extension.

Parameters
- menu: ExtensionMainMenu
  
  Navigation menu object.
Returns Promise<ExtensionMainMenu>
The awaitable task

setUI

setUI(state: ElementState): Promise<void>

Sets the state of the UI element.

Parameters
- state: ElementState
  
  The UI element state to be set
Returns Promise<void>
The awaitable task