Skip to content

Function: setDashboardItemProperty() ​

ts
function setDashboardItemProperty(
   client, 
   parameters, 
   options?
): Promise<void>;

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

Sets the value of the property with a given key on the dashboard item identified by the id.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ body: Record<string, any>; dashboardId: string; itemId: string; propertyKey: string; }-
parameters.bodyRecord<string, any>-
parameters.dashboardId?stringThe dashboard id.
parameters.itemId?stringThe dashboard item on which the property will be set.
parameters.propertyKey?stringThe key of the dashboard item's property. The maximum length of the key is 255 bytes.
options?RequestOptions-

Returns ​

Promise<void>