Example
dashboard.getFeature('DashboardPreferences')Methods
getPreference(name) → {string|boolean|number|null|undefined}
Returns an attribute that was set in the preferences.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | Name of the preference |
Returns:
Value of the preference; null means the property will be removed when saved.
- Type
- string | boolean | number | null | undefined
savePreferences() → {Promise}
Saves the preferences.
Returns:
Promise is rejected if the save did not complete successfully.
- Type
- Promise
setPreference(name, value)
Sets the preference.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | Name of the preference |
value |
string | boolean | number | null | Value of the preference to set; exception is thrown when it is not one of these types. |