Widget interface
Widget data
Properties
| allowed |
Refers to the allowed sizes for the widget. This gets populated when user wants to configure the widget |
| are |
Read-Only Property from Dashboard Service. Indicates if settings are blocked for the current user. |
| artifact |
Refers to unique identifier of a feature artifact. Used for pinning+unpinning a specific artifact. |
| configuration |
|
| configuration |
|
| content |
|
| contribution |
The id of the underlying contribution defining the supplied Widget Configuration. |
| dashboard | Optional partial dashboard content, to support exchanging dashboard-level version ETag for widget-level APIs |
| e |
|
| id | |
| is |
|
| is |
|
| lightbox |
|
| loading |
|
| name | |
| position | |
| settings | |
| settings |
|
| size | |
| type |
|
| url |
Property Details
allowedSizes
Refers to the allowed sizes for the widget. This gets populated when user wants to configure the widget
allowedSizes: WidgetSize[]Property Value
areSettingsBlockedForUser
Read-Only Property from Dashboard Service. Indicates if settings are blocked for the current user.
areSettingsBlockedForUser: booleanProperty Value
boolean
artifactId
Refers to unique identifier of a feature artifact. Used for pinning+unpinning a specific artifact.
artifactId: stringProperty Value
string
configurationContributionId
configurationContributionId: stringProperty Value
string
configurationContributionRelativeId
configurationContributionRelativeId: stringProperty Value
string
contentUri
contentUri: stringProperty Value
string
contributionId
The id of the underlying contribution defining the supplied Widget Configuration.
contributionId: stringProperty Value
string
dashboard
Optional partial dashboard content, to support exchanging dashboard-level version ETag for widget-level APIs
dashboard: DashboardProperty Value
eTag
eTag: stringProperty Value
string
id
id: stringProperty Value
string
isEnabled
isEnabled: booleanProperty Value
boolean
isNameConfigurable
isNameConfigurable: booleanProperty Value
boolean
lightboxOptions
loadingImageUrl
loadingImageUrl: stringProperty Value
string
name
name: stringProperty Value
string
position
settings
settings: stringProperty Value
string
settingsVersion
size
typeId
typeId: stringProperty Value
string
url
url: stringProperty Value
string