Interface WidgetMetadata

Contribution based information describing Dashboard Widgets.

interface WidgetMetadata {
    allowedSizes?: WidgetSize[];
    analyticsServiceRequired?: boolean;
    catalogIconUrl?: string;
    catalogInfoUrl?: string;
    configurationContributionId?: string;
    configurationContributionRelativeId?: string;
    configurationRequired?: boolean;
    contentUri?: string;
    contributionId?: string;
    defaultSettings?: string;
    description?: string;
    isEnabled?: boolean;
    isNameConfigurable?: boolean;
    isVisibleFromCatalog?: boolean;
    keywords?: string[];
    lightboxOptions?: LightboxOptions;
    loadingImageUrl?: string;
    name?: string;
    publisherName?: string;
    supportedScopes?: WidgetScope[];
    tags?: string[];
    targets?: string[];
    typeId?: string;
}

Properties

allowedSizes? analyticsServiceRequired? catalogIconUrl? catalogInfoUrl? configurationContributionId? configurationContributionRelativeId? configurationRequired? contentUri? contributionId? defaultSettings? description? isEnabled? isNameConfigurable? isVisibleFromCatalog? keywords? lightboxOptions? loadingImageUrl? name? publisherName? supportedScopes? tags? targets? typeId?

Properties

OptionalallowedSizes

allowedSizes?: WidgetSize[]

Sizes supported by the Widget.

OptionalanalyticsServiceRequired

analyticsServiceRequired?: boolean

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.

OptionalcatalogIconUrl

catalogIconUrl?: string

Resource for an icon in the widget catalog.

OptionalcatalogInfoUrl

catalogInfoUrl?: string

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

OptionalconfigurationContributionId

configurationContributionId?: string

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

OptionalconfigurationContributionRelativeId

configurationContributionRelativeId?: string

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

OptionalconfigurationRequired

configurationRequired?: boolean

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

OptionalcontentUri

contentUri?: string

Uri for the widget content to be loaded from .

OptionalcontributionId

contributionId?: string

The id of the underlying contribution defining the supplied Widget.

OptionaldefaultSettings

defaultSettings?: string

Optional default settings to be copied into widget settings.

Optionaldescription

description?: string

Summary information describing the widget.

OptionalisEnabled

isEnabled?: boolean

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

OptionalisNameConfigurable

isNameConfigurable?: boolean

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.

OptionalisVisibleFromCatalog

isVisibleFromCatalog?: boolean

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.

Optionalkeywords

keywords?: string[]

Keywords associated with this widget, non-filterable and invisible

OptionallightboxOptions

lightboxOptions?: LightboxOptions

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

OptionalloadingImageUrl

loadingImageUrl?: string

Resource for a loading placeholder image on dashboard

Optionalname

name?: string

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

OptionalpublisherName

publisherName?: string

Publisher Name of this kind of widget.

OptionalsupportedScopes

supportedScopes?: WidgetScope[]

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

Optionaltags

tags?: string[]

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

Optionaltargets

targets?: string[]

Contribution target IDs

OptionaltypeId

typeId?: string

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

Settings

Member Visibility

On This Page

Properties