Share via

WebPartContext class

  • Ссылка
Пакет:
@microsoft/sp-webpart-base

Объект контекста веб-части. Этот объект содержит контекстные службы, доступные веб-части. Например, контекстный экземпляр для http-клиента.

Extends
BaseWebPartContext

Комментарии

Конструктор для этого класса помечен как внутренний. Сторонний код не должен напрямую вызывать конструктор или создавать подклассы, расширяющие класс WebPartContext.

Свойства

domElement

Ссылка на элемент DOM, в котором размещается этот клиентский компонент.
microsoftTeams

Контекстные сведения о текущей вкладке Microsoft Teams. Этот объект будет определен только в том случае, если компонент размещается в Microsoft Teams.
sdks

Условный набор пакетов SDK, предоставляемых SPFx в зависимости от среды.
statusRenderer

Отрисовщик состояния веб-части.
widthCacheKey

Эта функция возвращает ключ, созданный режимом отображения веб-частей, индексом макета и коэффициентом раздела. Если параметр 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

Условный набор пакетов SDK, предоставляемых SPFx в зависимости от среды.

get sdks(): ISDKs;

Значение свойства

ISDKs

statusRenderer

Отрисовщик состояния веб-части.

get statusRenderer(): IClientSideWebPartStatusRenderer;

Значение свойства

IClientSideWebPartStatusRenderer

widthCacheKey

Эта функция возвращает ключ, созданный режимом отображения веб-частей, индексом макета и коэффициентом раздела. Если параметр sectionFactor или режим отображения не определен, возвращается значение undefined, в противном случае возвращается ключ кэша.

get widthCacheKey(): string | undefined;

Значение свойства

string | undefined