Widget interface

Package:

azure-devops-extension-api

Widget data

Properties

allowedSizes	Refers to the allowed sizes for the widget. This gets populated when user wants to configure the widget
areSettingsBlockedForUser	Read-Only Property from Dashboard Service. Indicates if settings are blocked for the current user.
artifactId	Refers to unique identifier of a feature artifact. Used for pinning+unpinning a specific artifact.
configurationContributionId
configurationContributionRelativeId
contentUri
contributionId	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
eTag
id
isEnabled
isNameConfigurable
lightboxOptions
loadingImageUrl
name
position
settings
settingsVersion
size
typeId
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

WidgetSize[]

areSettingsBlockedForUser

Read-Only Property from Dashboard Service. Indicates if settings are blocked for the current user.

areSettingsBlockedForUser: boolean

Property Value

boolean

artifactId

Refers to unique identifier of a feature artifact. Used for pinning+unpinning a specific artifact.

artifactId: string

Property Value

string

configurationContributionId

configurationContributionId: string

Property Value

string

configurationContributionRelativeId

configurationContributionRelativeId: string

Property Value

string

contentUri

contentUri: string

Property Value

string

contributionId

The id of the underlying contribution defining the supplied Widget Configuration.

contributionId: string

Property Value

string

dashboard

Optional partial dashboard content, to support exchanging dashboard-level version ETag for widget-level APIs

dashboard: Dashboard

Property Value

Dashboard

eTag

eTag: string

Property Value

string

id

id: string

Property Value

string

isEnabled

isEnabled: boolean

Property Value

boolean

isNameConfigurable

isNameConfigurable: boolean

Property Value

boolean

lightboxOptions

lightboxOptions: LightboxOptions

Property Value

LightboxOptions

loadingImageUrl

loadingImageUrl: string

Property Value

string

name

name: string

Property Value

string

position

position: WidgetPosition

Property Value

WidgetPosition

settings

settings: string

Property Value

string

settingsVersion

settingsVersion: SemanticVersion

Property Value

SemanticVersion

size

size: WidgetSize

Property Value

WidgetSize

typeId

typeId: string

Property Value

string

url

url: string

Property Value

string