Skip to content

Function: getDashboardItemProperty() ​

ts
function getDashboardItemProperty(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  key?: string;
  value?: unknown;
}>;

Defined in: src/server/api/dashboards.ts:47

Returns the value of the property with a given key from the dashboard item identified by the id.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ dashboardId: string; itemId: string; propertyKey: string; }-
parameters.dashboardIdstringThe dashboard id.
parameters.itemId?stringThe dashboard item from which the property will be returned.
parameters.propertyKey?stringThe key of the property to return.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; key?: string; value?: unknown; }>