WebPartContext class
Web パーツ コンテキスト オブジェクト。 このオブジェクトには、Web パーツで使用できるコンテキスト サービスが含まれています。 たとえば、http クライアントへのコンテキスト インスタンス。
- Extends
注釈
このクラスのコンストラクターは、内部にマークされています。 サードパーティのコードは、コンストラクターを直接呼び出したり、WebPartContext
クラスを展開するサブクラスを作成したりすることはできません。
プロパティ
dom |
このクライアント側コンポーネントをホストする DOM 要素への参照。 |
microsoft |
現在の [Microsoft Teams] タブに関するコンテキスト情報。このオブジェクトは、コンポーネントがMicrosoft Teamsでホストされている場合にのみ定義されます。 |
sdks | 環境に依存する SPFx によって提供される SDK の条件付きセット。 |
status |
Web パーツの状態レンダラー。 |
width |
この関数は、Web パーツの表示モード、レイアウト インデックス、セクション要素によって生成されたキーを返します。 sectionFactor または表示モードが未定義の場合は undefined が返され、それ以外の場合はキャッシュ キーが返されます。 |
プロパティの詳細
domElement
このクライアント側コンポーネントをホストする DOM 要素への参照。
get domElement(): HTMLElement;
プロパティ値
HTMLElement
microsoftTeams
警告
この API は非推奨になりました。
- This function has been deprecated
現在の [Microsoft Teams] タブに関するコンテキスト情報。このオブジェクトは、コンポーネントがMicrosoft Teamsでホストされている場合にのみ定義されます。
get microsoftTeams(): typeof microsoftTeams | undefined;
プロパティ値
typeof @microsoft/sp-webpart-base!~microsoftTeams | undefined
注釈
詳細については、以下を参照してください。 https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest
sdks
statusRenderer
Web パーツの状態レンダラー。
get statusRenderer(): IClientSideWebPartStatusRenderer;
プロパティ値
widthCacheKey
この関数は、Web パーツの表示モード、レイアウト インデックス、セクション要素によって生成されたキーを返します。 sectionFactor または表示モードが未定義の場合は undefined が返され、それ以外の場合はキャッシュ キーが返されます。
get widthCacheKey(): string | undefined;
プロパティ値
string | undefined