WidgetMetadata interface

描述仪表板小组件的基于贡献的信息。

属性

allowedSizes

控件支持的大小。

analyticsServiceRequired

选择加入布尔值,指示小组件是否需要 Analytics Service 才能运行。 如果 Analytics Service 不可用,则需要 Analytics Service 的小组件将从目录中隐藏。

catalogIconUrl

小组件目录中图标的资源。

catalogInfoUrl

指向小组件信息的选择加入 URL 字符串。 如果省略,则默认为扩展市场 URL

configurationContributionId

定义提供的 Widget 自定义配置 UI 的基础贡献的 ID。 如果自定义配置 UI 不可用,则为 Null。

configurationContributionRelativeId

定义提供的 Widget 自定义配置 UI 的基础贡献的相对 ID。 如果自定义配置 UI 不可用,则为 Null。

configurationRequired

指示小组件在添加到仪表板之前是否需要配置。

contentUri

要从 加载的小部件内容的 URI。

contributionId

定义提供的 Widget 的基础贡献的 ID。

defaultSettings

要复制到小部件设置中的可选默认设置。

description

描述小组件的摘要信息。

isEnabled

小部件可以通过应用商店禁用。 我们需要优雅地处理: - 持久性(允许) - 请求(标记为禁用,并提供上下文)

isNameConfigurable

选择退出布尔值,指示小组件是否支持小组件名称/标题配置。 忽略该名称的小部件应在清单中将其设置为 false。

isVisibleFromCatalog

选择退出布尔值,指示窗口小部件是否在目录中隐藏。 通常,这用于允许开发人员禁用已弃用小部件的创建。 小组件必须具有功能缺省状态或配置体验,才能从目录中可见。

keywords

与此小部件关联的关键字,不可过滤且不可见

lightboxOptions

用于在“灯箱”对话框中自定义小部件演示的选择加入属性。

loadingImageUrl

仪表板上加载占位符图像的资源

name

小组件类型的面向用户的名称。 每个小部件必须在此处使用唯一的值。

publisherName

发布者 此类小组件的名称。

supportedScopes

小部件在其容器中运行和工作所需的数据协定。

tags

与此小部件关联的标签,在每个小部件上可见且可过滤。

targets

贡献目标 ID

typeId

已弃用:此类小部件的本地唯一面向开发人员的 ID。 ContributionId 为小部件类型提供全局唯一标识符。

属性详细信息

allowedSizes

控件支持的大小。

allowedSizes: WidgetSize[]

属性值

analyticsServiceRequired

选择加入布尔值,指示小组件是否需要 Analytics Service 才能运行。 如果 Analytics Service 不可用,则需要 Analytics Service 的小组件将从目录中隐藏。

analyticsServiceRequired: boolean

属性值

boolean

catalogIconUrl

小组件目录中图标的资源。

catalogIconUrl: string

属性值

string

catalogInfoUrl

指向小组件信息的选择加入 URL 字符串。 如果省略,则默认为扩展市场 URL

catalogInfoUrl: string

属性值

string

configurationContributionId

定义提供的 Widget 自定义配置 UI 的基础贡献的 ID。 如果自定义配置 UI 不可用,则为 Null。

configurationContributionId: string

属性值

string

configurationContributionRelativeId

定义提供的 Widget 自定义配置 UI 的基础贡献的相对 ID。 如果自定义配置 UI 不可用,则为 Null。

configurationContributionRelativeId: string

属性值

string

configurationRequired

指示小组件在添加到仪表板之前是否需要配置。

configurationRequired: boolean

属性值

boolean

contentUri

要从 加载的小部件内容的 URI。

contentUri: string

属性值

string

contributionId

定义提供的 Widget 的基础贡献的 ID。

contributionId: string

属性值

string

defaultSettings

要复制到小部件设置中的可选默认设置。

defaultSettings: string

属性值

string

description

描述小组件的摘要信息。

description: string

属性值

string

isEnabled

小部件可以通过应用商店禁用。 我们需要优雅地处理: - 持久性(允许) - 请求(标记为禁用,并提供上下文)

isEnabled: boolean

属性值

boolean

isNameConfigurable

选择退出布尔值,指示小组件是否支持小组件名称/标题配置。 忽略该名称的小部件应在清单中将其设置为 false。

isNameConfigurable: boolean

属性值

boolean

isVisibleFromCatalog

选择退出布尔值,指示窗口小部件是否在目录中隐藏。 通常,这用于允许开发人员禁用已弃用小部件的创建。 小组件必须具有功能缺省状态或配置体验,才能从目录中可见。

isVisibleFromCatalog: boolean

属性值

boolean

keywords

与此小部件关联的关键字,不可过滤且不可见

keywords: string[]

属性值

string[]

lightboxOptions

用于在“灯箱”对话框中自定义小部件演示的选择加入属性。

lightboxOptions: LightboxOptions

属性值

loadingImageUrl

仪表板上加载占位符图像的资源

loadingImageUrl: string

属性值

string

name

小组件类型的面向用户的名称。 每个小部件必须在此处使用唯一的值。

name: string

属性值

string

publisherName

发布者 此类小组件的名称。

publisherName: string

属性值

string

supportedScopes

小部件在其容器中运行和工作所需的数据协定。

supportedScopes: WidgetScope[]

属性值

tags

与此小部件关联的标签,在每个小部件上可见且可过滤。

tags: string[]

属性值

string[]

targets

贡献目标 ID

targets: string[]

属性值

string[]

typeId

已弃用:此类小部件的本地唯一面向开发人员的 ID。 ContributionId 为小部件类型提供全局唯一标识符。

typeId: string

属性值

string