WebPartContext class

  • Referência
Pacote:
@microsoft/sp-webpart-base

Objeto de contexto de peça Web. Este objeto contém os serviços contextuais disponíveis para uma peça Web. Por exemplo, uma instância contextual para o cliente http.

Extends
BaseWebPartContext

Comentários

O construtor desta classe é marcado como interno. O código de terceiros não deve chamar diretamente o construtor ou criar subclasses que ampliem a classe WebPartContext.

Propriedades

domElement

Referência ao elemento DOM que aloja este componente do lado do cliente.
microsoftTeams

Informações contextuais sobre o separador atual do Microsoft Teams. Este objeto só será definido se um componente estiver a ser alojado no Microsoft Teams.
sdks

Conjunto condicional de SDKs fornecidos pelo SPFx dependentes do ambiente.
statusRenderer

Processador de status da Web Part.
widthCacheKey

Estas funções devolvem uma chave gerada pelo modo de apresentação de peças Web, índice de esquema e fator de secção. Irá devolver indefinido se sectionFactor ou o modo de apresentação não estiver definido. Caso contrário, devolve a chave de cache.

Detalhes da propriedade

domElement

Referência ao elemento DOM que aloja este componente do lado do cliente.

get domElement(): HTMLElement;

Valor da propriedade

HTMLElement

microsoftTeams

Aviso

Essa API foi preterida.

  • This function has been deprecated

Informações contextuais sobre o separador atual do Microsoft Teams. Este objeto só será definido se um componente estiver a ser alojado no Microsoft Teams.

get microsoftTeams(): typeof microsoftTeams | undefined;

Valor da propriedade

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

Comentários

Para obter mais informações, consulte: https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest

sdks

Conjunto condicional de SDKs fornecidos pelo SPFx dependentes do ambiente.

get sdks(): ISDKs;

Valor da propriedade

ISDKs

statusRenderer

Processador de status da Web Part.

get statusRenderer(): IClientSideWebPartStatusRenderer;

Valor da propriedade

IClientSideWebPartStatusRenderer

widthCacheKey

Estas funções devolvem uma chave gerada pelo modo de apresentação de peças Web, índice de esquema e fator de secção. Irá devolver indefinido se sectionFactor ou o modo de apresentação não estiver definido. Caso contrário, devolve a chave de cache.

get widthCacheKey(): string | undefined;

Valor da propriedade

string | undefined