WidgetMetadata interface

Package:

azure-devops-extension-api

Contribution based information describing Dashboard Widgets.

Properties

allowedSizes	Sizes supported by the Widget.
analyticsServiceRequired	Opt-in boolean that indicates if the widget requires the Analytics Service to function. Widgets requiring the analytics service are hidden from the catalog if the Analytics Service is not available.
catalogIconUrl	Resource for an icon in the widget catalog.
catalogInfoUrl	Opt-in URL string pointing at widget information. Defaults to extension marketplace URL if omitted
configurationContributionId	The id of the underlying contribution defining the supplied Widget custom configuration UI. Null if custom configuration UI is not available.
configurationContributionRelativeId	The relative id of the underlying contribution defining the supplied Widget custom configuration UI. Null if custom configuration UI is not available.
configurationRequired	Indicates if the widget requires configuration before being added to dashboard.
contentUri	Uri for the widget content to be loaded from .
contributionId	The id of the underlying contribution defining the supplied Widget.
defaultSettings	Optional default settings to be copied into widget settings.
description	Summary information describing the widget.
isEnabled	Widgets can be disabled by the app store. We'll need to gracefully handle for: - persistence (Allow) - Requests (Tag as disabled, and provide context)
isNameConfigurable	Opt-out boolean that indicates if the widget supports widget name/title configuration. Widgets ignoring the name should set it to false in the manifest.
isVisibleFromCatalog	Opt-out boolean indicating if the widget is hidden from the catalog. Commonly, this is used to allow developers to disable creation of a deprecated widget. A widget must have a functional default state, or have a configuration experience, in order to be visible from the catalog.
keywords	Keywords associated with this widget, non-filterable and invisible
lightboxOptions	Opt-in properties for customizing widget presentation in a "lightbox" dialog.
loadingImageUrl	Resource for a loading placeholder image on dashboard
name	User facing name of the widget type. Each widget must use a unique value here.
publisherName	Publisher Name of this kind of widget.
supportedScopes	Data contract required for the widget to function and to work in its container.
tags	Tags associated with this widget, visible on each widget and filterable.
targets	Contribution target IDs
typeId	Deprecated: locally unique developer-facing id of this kind of widget. ContributionId provides a globally unique identifier for widget types.

Property Details

allowedSizes

Sizes supported by the Widget.

allowedSizes: WidgetSize[]

Property Value

WidgetSize[]

analyticsServiceRequired

Opt-in boolean that indicates if the widget requires the Analytics Service to function. Widgets requiring the analytics service are hidden from the catalog if the Analytics Service is not available.

analyticsServiceRequired: boolean

Property Value

boolean

catalogIconUrl

Resource for an icon in the widget catalog.

catalogIconUrl: string

Property Value

string

catalogInfoUrl

Opt-in URL string pointing at widget information. Defaults to extension marketplace URL if omitted

catalogInfoUrl: string

Property Value

string

configurationContributionId

The id of the underlying contribution defining the supplied Widget custom configuration UI. Null if custom configuration UI is not available.

configurationContributionId: string

Property Value

string

configurationContributionRelativeId

The relative id of the underlying contribution defining the supplied Widget custom configuration UI. Null if custom configuration UI is not available.

configurationContributionRelativeId: string

Property Value

string

configurationRequired

Indicates if the widget requires configuration before being added to dashboard.

configurationRequired: boolean

Property Value

boolean

contentUri

Uri for the widget content to be loaded from .

contentUri: string

Property Value

string

contributionId

The id of the underlying contribution defining the supplied Widget.

contributionId: string

Property Value

string

defaultSettings

Optional default settings to be copied into widget settings.

defaultSettings: string

Property Value

string

description

Summary information describing the widget.

description: string

Property Value

string

isEnabled

Widgets can be disabled by the app store. We'll need to gracefully handle for: - persistence (Allow) - Requests (Tag as disabled, and provide context)

isEnabled: boolean

Property Value

boolean

isNameConfigurable

Opt-out boolean that indicates if the widget supports widget name/title configuration. Widgets ignoring the name should set it to false in the manifest.

isNameConfigurable: boolean

Property Value

boolean

isVisibleFromCatalog

Opt-out boolean indicating if the widget is hidden from the catalog. Commonly, this is used to allow developers to disable creation of a deprecated widget. A widget must have a functional default state, or have a configuration experience, in order to be visible from the catalog.

isVisibleFromCatalog: boolean

Property Value

boolean

keywords

Keywords associated with this widget, non-filterable and invisible

keywords: string[]

Property Value

string[]

lightboxOptions

Opt-in properties for customizing widget presentation in a "lightbox" dialog.

lightboxOptions: LightboxOptions

Property Value

LightboxOptions

loadingImageUrl

Resource for a loading placeholder image on dashboard

loadingImageUrl: string

Property Value

string

name

User facing name of the widget type. Each widget must use a unique value here.

name: string

Property Value

string

publisherName

Publisher Name of this kind of widget.

publisherName: string

Property Value

string

supportedScopes

Data contract required for the widget to function and to work in its container.

supportedScopes: WidgetScope[]

Property Value

WidgetScope[]

tags

Tags associated with this widget, visible on each widget and filterable.

tags: string[]

Property Value

string[]

targets

Contribution target IDs

targets: string[]

Property Value

string[]

typeId

Deprecated: locally unique developer-facing id of this kind of widget. ContributionId provides a globally unique identifier for widget types.

typeId: string

Property Value

string