DashboardRestClient class

new DashboardRestClient(options: IVssRestClientOptions)

参数

static RESOURCE_AREA_ID: string

属性值

创建提供的仪表板。

function createDashboard(dashboard: Dashboard, teamContext: TeamContext): Promise<Dashboard>

参数

返回

在指定的仪表板上创建小组件。

function createWidget(widget: Widget, teamContext: TeamContext, dashboardId: string): Promise<Widget>

参数

返回

删除给定其 ID 的仪表板。 这还会删除与此仪表板关联的小组件。

function deleteDashboard(teamContext: TeamContext, dashboardId: string): Promise<void>

参数

返回

删除指定的小组件。

function deleteWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard>

参数

返回

按其 ID 获取仪表板。

function getDashboard(teamContext: TeamContext, dashboardId: string): Promise<Dashboard>

参数

返回

获取项目下的仪表板列表。

function getDashboardsByProject(teamContext: TeamContext): Promise<Dashboard[]>

参数

返回

获取指定小组件的当前状态。

function getWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>

参数

返回

获取满足指定贡献 ID 的小组件元数据。

function getWidgetMetadata(contributionId: string, project?: string): Promise<WidgetMetadataResponse>

参数

返回

按字母顺序获取所有可用的小组件元数据，包括标记为 isVisibleFromCatalog == false 的小组件。

function getWidgetTypes(scope: WidgetScope, project?: string): Promise<WidgetTypesResponse>

参数

返回

替换指定仪表板的配置。 仅当提供属性时，才会替换仪表板上的小组件列表。

function replaceDashboard(dashboard: Dashboard, teamContext: TeamContext, dashboardId: string): Promise<Dashboard>

参数

返回

更新提供的组中仪表板的名称和位置，并删除省略的仪表板。 不修改仪表板内容。

function replaceDashboards(group: DashboardGroup, teamContext: TeamContext): Promise<DashboardGroup>

参数

返回

重写指定小组件的状态。

function replaceWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>

参数

返回

执行指定小组件的部分更新。

function updateWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>

参数

返回