Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UIAPI

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

Hierarchy

  • UIAPI

Index

Methods

Methods

addCustomFileAction

  • 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

  • Gets all the UI elements and their states.

    Returns Promise<ElementState[]>

    The awaitable task that returns the UI elements and their states.

getUITabIds

  • Get all enabled 3D viewer UI tab components in the current project. These tabs can be opened via the UIAPI.openUITab method.

    Returns Promise<TabPanelId[]>

openUITab

  • openUITab(tabId: TabPanelId, args?: any): Promise<void>

  • Opens the given UI tab component. Only components enabled in the project can be opened.

    Parameters

    • tabId: TabPanelId

      Id of an enabled UI tab component

    • Optional args: any

      Optional payload passed to the component. This argument is component-specific.

    Returns Promise<void>

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

  • Configures Trimble Connect web navigation menu from the Project extension.

    Parameters

    Returns Promise<ExtensionMainMenu>

    The awaitable task

setUI

  • Sets the state of the UI element.

    Parameters

    Returns Promise<void>

    The awaitable task