WebPartContext class

  • Referencia
Paquete:
@microsoft/sp-webpart-base

Objeto de contexto de elemento web. Este objeto contiene los servicios contextuales disponibles para un elemento web. Por ejemplo, una instancia contextual para el cliente http.

Extends
BaseWebPartContext

Comentarios

El constructor de esta clase está marcado como interno. El código de terceros no debe llamar directamente al constructor ni crear subclases que extiendan la clase WebPartContext.

Propiedades

domElement

Referencia al elemento DOM que hospeda este componente del lado cliente.
microsoftTeams

Información contextual sobre la pestaña de Microsoft Teams actual. Este objeto solo se definirá si un componente se hospeda en Microsoft Teams.
sdks

Conjunto condicional de SDK proporcionados por SPFx que dependen del entorno.
statusRenderer

Representador de estado del elemento web.
widthCacheKey

Esta función devuelve una clave generada por el modo de visualización de elementos web, el índice de diseño y el factor de sección. Devolverá undefined si sectionFactor o el modo de presentación no están definidos; de lo contrario, devolverá la clave de caché.

Detalles de las propiedades

domElement

Referencia al elemento DOM que hospeda este componente del lado cliente.

get domElement(): HTMLElement;

Valor de propiedad

HTMLElement

microsoftTeams

Advertencia

Esta API ya está en desuso.

  • This function has been deprecated

Información contextual sobre la pestaña de Microsoft Teams actual. Este objeto solo se definirá si un componente se hospeda en Microsoft Teams.

get microsoftTeams(): typeof microsoftTeams | undefined;

Valor de propiedad

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

Comentarios

Para obtener más información, consulte: https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest

sdks

Conjunto condicional de SDK proporcionados por SPFx que dependen del entorno.

get sdks(): ISDKs;

Valor de propiedad

ISDKs

statusRenderer

Representador de estado del elemento web.

get statusRenderer(): IClientSideWebPartStatusRenderer;

Valor de propiedad

IClientSideWebPartStatusRenderer

widthCacheKey

Esta función devuelve una clave generada por el modo de visualización de elementos web, el índice de diseño y el factor de sección. Devolverá undefined si sectionFactor o el modo de presentación no están definidos; de lo contrario, devolverá la clave de caché.

get widthCacheKey(): string | undefined;

Valor de propiedad

string | undefined