Interface PropertyPanelAPI

The API for operations related to the Trimble Connect Property Panel web component.

Hierarchy

PropertyPanelAPI

Index

Methods

Methods

Optional changeMode

changeMode(mode: DetailsPanelViewMode): Promise<void>

Callback to inform host about the current Property panel mode. If mode is "edit", Property Panel has possibly unsaved changes.

Parameters
- mode: DetailsPanelViewMode
Returns Promise<void>

Optional close

close(): Promise<void>

Callback for Property Panel to request closing itself

Returns Promise<void>

getPropertyPanelData

getPropertyPanelData(): Promise<IPropertyPanelData>

Callback for Property Panel to request the entities to display the properties for

Returns Promise<IPropertyPanelData>

Optional openPropertySetManager

openPropertySetManager(): Promise<void>

Callback for Property Panel to request opening the Property Set Manager

Returns Promise<void>