Custom Widgets API Reference
Use the following reference to build custom widgets for your dashboards.
Dashboard API
Use the dashboard API to communicate with the widget wrapper and the dashboard. All of these methods are asynchronous and return Promise objects. These methods are applied to the dashboardApi object.
setTitle(label: string, ?labelUrl: string): void | ||
|---|---|---|
Description | Sets the text that is displayed in the widget header. If a value is specified for the | |
Parameters | label | The text string that is shown as the widget title. |
labelURL | The address of the target page that opens when a user clicks the widget title. If this optional parameter is not specified, the widget title is set as text only. | |
setLoadingAnimationEnabled(enabled: boolean): void | ||
|---|---|---|
Description | Toggles the image rotation animation for the widget reload icon. Call this method when the widget populates data from a remote server to indicate that a process is running in the background. | |
Parameters | enabled | Determines whether the widget reload icon rotates or not. |
alert(message: string, type: "error"|"message"|"success"|"warning", delay: number): void | ||
|---|---|---|
Description | Displays a system alert at the top of the page. | |
Parameters | message | Sets the text that is displayed as the system alert. |
type | Determines which notification style is applied to the alert. | |
delay | The amount of time the alert is shown on the page, in seconds. | |
enterConfigMode(): void | |
|---|---|
Description | Invokes configuration mode. When in configuration mode, the visual presentation of the widget changes to indicate that its settings can be updated. The refresh icon is also hidden. |
exitConfigMode(): void | |
|---|---|
Description | Exits configuration mode. |
storeCache(cache: Object): Object | ||
|---|---|---|
Description | Stores any object in the client-side cache. Use this method to store populated data locally and display it immediately on the dashboard, then refresh it from server. Returns a configuration object. | |
Parameters | cache | Specifies the object to be stored in the cache. |
readCache(): Object | |
|---|---|
Description | Reads and returns the object that was previously stored in the cache. |
storeConfig(config: Object): void | ||
|---|---|---|
Description | Stores any object as a widget configuration. Exits configuration mode if configuration mode is active. | |
Parameters | config | Specifies the object to be stored as a widget configuration. |
readConfig(): Object | |
|---|---|
Description | Reads and returns the object that was previously stored as a configuration object. |
fetch(serviceID: string, url: string, fetchConfig: Object): Object | ||
|---|---|---|
Description | Makes an authorized request to the specified service. The service must be specified in the widget manifest. | |
Parameters | serviceID | Specifies the ID of the service. |
url | Sets the URL to the service API endpoint. This is the path to the resource that you want to fetch. The URL is relative to the server home URL. | |
fetchConfig | Defines an optional options object. This object contains any custom settings that you want to apply to the request. | |
fetchHub(url: string, fetchConfig: Object): Object | ||
|---|---|---|
Description | Makes an authorized request to the built-in Hub service. | |
Parameters | url | Sets the URL to the Hub service API endpoint. This is the path to the resource that you want to fetch. The URL is relative to the server home URL. |
fetchConfig | Defines an optional options object. This object contains any custom settings that you want to apply to the request. | |
Widget API
Use the widget API to manipulate the visibility of controls on your custom widget. These methods are also asynchronous and return Promise objects. These methods are applied to the widgetApi object.
onRefresh(): void | |
|---|---|
Description | Calls an action when the refresh icon is clicked in the widget header. If not set, the refresh icon is not shown in the header. |
onConfigure(): void | |
|---|---|
Description | Calls an action when the Edit option is selected from the widget menu. If not set, the Edit option is not shown. |