WidgetMetadata interface
ダッシュボード ウィジェットを記述する投稿ベースの情報。
プロパティ
| allowed |
ウィジェットでサポートされるサイズ。 |
| analytics |
ウィジェットで Analytics サービスが機能する必要があるかどうかを示すオプトイン ブール値。 分析サービスが使用できない場合、分析サービスを必要とするウィジェットはカタログに表示されません。 |
| catalog |
ウィジェット カタログ内のアイコンのリソース。 |
| catalog |
ウィジェット情報を指すオプトイン URL 文字列。 省略した場合、拡張機能マーケットプレースの URL が既定値になります |
| configuration |
提供された Widget カスタム構成 UI を定義する基になるコントリビューションの ID。 カスタム構成 UI が使用できない場合は Null。 |
| configuration |
提供された Widget カスタム構成 UI を定義する基になるコントリビューションの相対 ID。 カスタム構成 UI が使用できない場合は Null。 |
| configuration |
ウィジェットがダッシュボードに追加される前に構成が必要かどうかを示します。 |
| content |
読み込まれるウィジェット コンテンツの URI。 |
| contribution |
提供されたウィジェットを定義する基になるコントリビューションの ID。 |
| default |
ウィジェット設定にコピーする省略可能な既定の設定。 |
| description | ウィジェットを説明する概要情報。 |
| is |
ウィジェットは、アプリ ストアで無効にすることができます。 永続化 (許可) - 要求 (無効としてタグ付けし、コンテキストを提供) を適切に処理する必要があります。 |
| is |
ウィジェットがウィジェット名/タイトル構成をサポートしているかどうかを示すオプトアウト ブール値。 名前を無視するウィジェットは、マニフェストで false に設定する必要があります。 |
| is |
ウィジェットがカタログから非表示になっているかどうかを示すオプトアウト ブール値。 通常、これは開発者が非推奨のウィジェットの作成を無効にするために使用されます。 カタログから表示するには、ウィジェットが機能的な既定の状態であるか、構成エクスペリエンスを備えている必要があります。 |
| keywords | このウィジェットに関連付けられているキーワード(フィルター不可および非表示) |
| lightbox |
"ライトボックス" ダイアログでウィジェットのプレゼンテーションをカスタマイズするためのオプトイン プロパティ。 |
| loading |
ダッシュボードにプレースホルダー画像を読み込むためのリソース |
| name | ウィジェットの種類のユーザー向けの名前。 各ウィジェットでは、一意の値を使用する必要があります。 |
| publisher |
この種類のウィジェットの発行元名。 |
| supported |
ウィジェットが機能し、そのコンテナーで動作するために必要なデータ コントラクト。 |
| tags | このウィジェットに関連付けられたタグ。各ウィジェットに表示され、フィルター可能です。 |
| targets | コントリビューション ターゲット ID |
| type |
非推奨: この種のウィジェットのローカルで一意の開発者向け ID。 ContributionId は、ウィジェットの種類に対してグローバルに一意の識別子を提供します。 |
プロパティの詳細
allowedSizes
analyticsServiceRequired
ウィジェットで Analytics サービスが機能する必要があるかどうかを示すオプトイン ブール値。 分析サービスが使用できない場合、分析サービスを必要とするウィジェットはカタログに表示されません。
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
提供されたウィジェットを定義する基になるコントリビューションの 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
tags
このウィジェットに関連付けられたタグ。各ウィジェットに表示され、フィルター可能です。
tags: string[]プロパティ値
string[]
targets
コントリビューション ターゲット ID
targets: string[]プロパティ値
string[]
typeId
非推奨: この種のウィジェットのローカルで一意の開発者向け ID。 ContributionId は、ウィジェットの種類に対してグローバルに一意の識別子を提供します。
typeId: stringプロパティ値
string