Freigeben über

WebPartContext class

  • Referenz
Paket:
@microsoft/sp-webpart-base

Webpartkontextobjekt. Dieses Objekt enthält die kontextbezogenen Dienste, die für ein Webpart verfügbar sind. z. B. eine kontextbezogene instance zum HTTP-Client.

Extends
BaseWebPartContext

Hinweise

Der Konstruktor für diese Klasse ist als intern gekennzeichnet. Drittanbietercode sollte den Konstruktor nicht direkt aufrufen oder Unterklassen erstellen, die die Klasse WebPartContext erweitern.

Eigenschaften

domElement

Verweis auf das DOM-Element, das diese clientseitige Komponente hostet.
microsoftTeams

Kontextinformationen zur aktuellen Microsoft Teams-Registerkarte. Dieses Objekt wird nur definiert, wenn eine Komponente in Microsoft Teams gehostet wird.
sdks

Bedingter Satz von SDKs, die von SPFx abhängig von der Umgebung bereitgestellt werden.
statusRenderer

Statuswiedergabe des Webparts.
widthCacheKey

Diese Funktion gibt einen Schlüssel zurück, der durch den Anzeigemodus, den Layoutindex und den Abschnittsfaktor von Webparts generiert wird. Es wird undefined zurückgegeben, wenn sectionFactor oder der Anzeigemodus nicht definiert ist, andernfalls wird der Cacheschlüssel zurückgegeben.

Details zur Eigenschaft

domElement

Verweis auf das DOM-Element, das diese clientseitige Komponente hostet.

get domElement(): HTMLElement;

Eigenschaftswert

HTMLElement

microsoftTeams

Warnung

Diese API ist nun veraltet.

  • This function has been deprecated

Kontextinformationen zur aktuellen Microsoft Teams-Registerkarte. Dieses Objekt wird nur definiert, wenn eine Komponente in Microsoft Teams gehostet wird.

get microsoftTeams(): typeof microsoftTeams | undefined;

Eigenschaftswert

typeof @microsoft/sp-webpart-base!~microsoftTeams | undefined

Hinweise

Weitere Informationen finden Sie unter: https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest

sdks

Bedingter Satz von SDKs, die von SPFx abhängig von der Umgebung bereitgestellt werden.

get sdks(): ISDKs;

Eigenschaftswert

ISDKs

statusRenderer

Statuswiedergabe des Webparts.

get statusRenderer(): IClientSideWebPartStatusRenderer;

Eigenschaftswert

IClientSideWebPartStatusRenderer

widthCacheKey

Diese Funktion gibt einen Schlüssel zurück, der durch den Anzeigemodus, den Layoutindex und den Abschnittsfaktor von Webparts generiert wird. Es wird undefined zurückgegeben, wenn sectionFactor oder der Anzeigemodus nicht definiert ist, andernfalls wird der Cacheschlüssel zurückgegeben.

get widthCacheKey(): string | undefined;

Eigenschaftswert

string | undefined