Dashboard Widgets Object
Available via dashboard.widgets. Represents the Dashboard's widgets, and provides methods to access & modify them.
Properties
| Name | Type | Description |
|---|---|---|
length | integer | How many widgets exist in the dashboard |
$$widgets | Widget | A read-only array of widgets |
Methods
get
Fetch a Widget from the Dashboard by index or unique ID
Get Widget by index
widgets.get(index)
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
index | integer | Yes | Index of Widget to fetch |
Returns
Example
console.log(dashboard.widgets.get(0));
Get Widget by unique ID
widgets.get(id)
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Unique ID to fetch Widget by |
Returns
Example
console.log(dashboard.widgets.get('5f195f4cbf342a002d120e50'));