APITable Docs
DataBusResources

Dashboard

Fields

Except from common fields from IResource, Dashboard also defines fields specific for dashboards.

widgetMap

The map of all installed widgets in the dashboard.

Methods

setWidgetInstalled

setWidgetInstalled(widget: IWidget)

Notify the underlying resource data that a widget is installed.

addWidgets

addWidgets(widgetIds: string[], saveOptions: ISaveOptions): Promise<ICommandExecutionResult<void>>

Add a widget to this dashboard.

setWidgetDependencyDatasheet

setWidgetDependencyDatasheet(options: IWidgetDependencyDatasheetOptions, saveOptions: ISaveOptions): Promise<ICommandExecutionResult<void>>

Set the dependent datasheet of a widget installed in the dashboard.

deleteWidget

deleteWidget(widgetId: string, saveOptions: ISaveOptions): Promise<ICommandExecutionResult<void>>

Delete a widget from this dashboard.

On this page