WidgetMetadata interface
Contribution based information describing Dashboard Widgets.
Properties
| allowed |
Sizes supported by the Widget. |
| analytics |
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. |
| catalog |
Resource for an icon in the widget catalog. |
| catalog |
Opt-in URL string pointing at widget information. Defaults to extension marketplace URL if omitted |
| configuration |
The id of the underlying contribution defining the supplied Widget custom configuration UI. Null if custom configuration UI is not available. |
| configuration |
The relative id of the underlying contribution defining the supplied Widget custom configuration UI. Null if custom configuration UI is not available. |
| configuration |
Indicates if the widget requires configuration before being added to dashboard. |
| content |
Uri for the widget content to be loaded from . |
| contribution |
The id of the underlying contribution defining the supplied Widget. |
| default |
Optional default settings to be copied into widget settings. |
| description | Summary information describing the widget. |
| is |
Widgets can be disabled by the app store. We'll need to gracefully handle for: - persistence (Allow) - Requests (Tag as disabled, and provide context) |
| is |
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. |
| is |
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 |
| lightbox |
Opt-in properties for customizing widget presentation in a "lightbox" dialog. |
| loading |
Resource for a loading placeholder image on dashboard |
| name | User facing name of the widget type. Each widget must use a unique value here. |
| publisher |
Publisher Name of this kind of widget. |
| supported |
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 |
| type |
Deprecated: locally unique developer-facing id of this kind of widget. ContributionId provides a globally unique identifier for widget types. |
Property Details
allowedSizes
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: booleanProperty Value
boolean
catalogIconUrl
Resource for an icon in the widget catalog.
catalogIconUrl: stringProperty Value
string
catalogInfoUrl
Opt-in URL string pointing at widget information. Defaults to extension marketplace URL if omitted
catalogInfoUrl: stringProperty 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: stringProperty 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: stringProperty Value
string
configurationRequired
Indicates if the widget requires configuration before being added to dashboard.
configurationRequired: booleanProperty Value
boolean
contentUri
Uri for the widget content to be loaded from .
contentUri: stringProperty Value
string
contributionId
The id of the underlying contribution defining the supplied Widget.
contributionId: stringProperty Value
string
defaultSettings
Optional default settings to be copied into widget settings.
defaultSettings: stringProperty Value
string
description
Summary information describing the widget.
description: stringProperty 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: booleanProperty 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: booleanProperty 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: booleanProperty 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: LightboxOptionsProperty Value
loadingImageUrl
Resource for a loading placeholder image on dashboard
loadingImageUrl: stringProperty Value
string
name
User facing name of the widget type. Each widget must use a unique value here.
name: stringProperty Value
string
publisherName
Publisher Name of this kind of widget.
publisherName: stringProperty Value
string
supportedScopes
Data contract required for the widget to function and to work in its container.
supportedScopes: WidgetScope[]Property Value
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: stringProperty Value
string
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for