Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ViewAPI

The API for operations related to the Trimble Connect 3D Viewer views.

Hierarchy

  • ViewAPI

Index

Methods

Methods

createView

  • Creates a new Connect view object asynchronously.

    Parameters

    • view: ViewInfo

      The information of the new view

    Returns Promise<ViewSpec>

    The awaitable task that returns the newly created view data

deleteView

  • deleteView(viewId: string): Promise<boolean>

  • Deletes an existing Connect view object asynchronously.

    Parameters

    • viewId: string

      The view identifier

    Returns Promise<boolean>

    The awaitable task

getCurrentView

  • Gets the Connect view loaded in the viewer space.

    remarks

    Use the ViewAPI.getView to get a specific view.

    Returns Promise<ViewSpec>

    The awaitable task that returns the view.

getView

  • getView(viewId: string): Promise<ViewSpec>

  • Gets the Connect view object asynchronously.

    remarks

    Use the ViewAPI.getViews to get all the views.

    Parameters

    • viewId: string

      The view identifier

    Returns Promise<ViewSpec>

    The awaitable task that returns the view with the specified identifier

getViews

  • Gets the Connect view objects asynchronously.

    Returns Promise<ViewSpec[]>

    The awaitable task that returns the views.

selectView

  • selectView(viewId: string, loadWithOriginalModelVersion?: boolean): Promise<void>

  • Selects the Connect view object and apply to the workspace viewer asynchronously.

    remarks

    Uses latest model versions by default. Use the ViewAPI.getViews to get all the views.

    Parameters

    • viewId: string

      The view identifier

    • Optional loadWithOriginalModelVersion: boolean

      Optional parameter to use original model versions. Default is false.

    Returns Promise<void>

    The awaitable task

setView

  • Sets the workspace view specification asynchronously.

    Parameters

    Returns Promise<void>

    The awaitable task

updateView

  • Asynchronously updates a Connect view object. If the view argument only contains the id property, the host application will update the given view with the data currently visible in the viewer.

    Parameters

    Returns Promise<ViewSpec>

    The awaitable task that returns the updated view detail.