IDashboardBase
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Dashboard common properties
export interface IDashboardBase
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| string | (ALPHA) Dashboard description | |
| string[] | (ALPHA) (Optional) Dashboard tags. | |
| string | (ALPHA) Dashboard title |
Property details
IDashboardBase.descriptionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Dashboard description
readonly description: string;
IDashboardBase.tagspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Dashboard tags.
readonly tags?: string[];
Remarks
This property is optional for backwards compatibility reasons, but for newly created dashboards, you can expect this to always be defined (an empty array in case there are no tags).
Since 8.6.0
IDashboardBase.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Dashboard title
readonly title: string;