WebPartContext class

参考

包:: @microsoft/sp-webpart-base

Web 部件上下文对象。此对象包含可用于 Web 部件的上下文服务。例如 http 客户端的上下文实例。

扩展: BaseWebPartContext

注解

此类的构造函数标记为内部。第三方代码不应直接调用构造函数或创建扩展类的 WebPartContext 子类。

属性

domElement	对托管此客户端组件的 DOM 元素的引用。
microsoftTeams	有关当前Microsoft Teams 选项卡的上下文信息。仅当组件托管在 Microsoft Teams 中时，才会定义此对象。
sdks	SPFx 提供的条件 SDK 集依赖于环境。
statusRenderer	Web 部件状态呈现程序。
widthCacheKey	此函数返回由 Web 部件显示模式、布局索引和节因子生成的键。如果 sectionFactor 或显示模式未定义，它将返回未定义，否则返回缓存键。

属性详细信息

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

SPFx 提供的条件 SDK 集依赖于环境。

get sdks(): ISDKs;

属性值

ISDKs

statusRenderer

Web 部件状态呈现程序。

get statusRenderer(): IClientSideWebPartStatusRenderer;

属性值

IClientSideWebPartStatusRenderer

widthCacheKey

此函数返回由 Web 部件显示模式、布局索引和节因子生成的键。如果 sectionFactor 或显示模式未定义，它将返回未定义，否则返回缓存键。

get widthCacheKey(): string | undefined;

属性值

string | undefined

通过