BaseWebPart class

Ссылка

Пакет:: @microsoft/sp-webpart-base

Этот абстрактный класс реализует не зависящие от пользовательского интерфейса базовые функции для клиентской веб-части. Цель заключается в том, чтобы разрешить общее ядро между двумя и mr webParts.

Extends: BaseComponent

Конструкторы

(constructor)()

Конструктор класса BaseWebPart .

Свойства

accessibleTitle	Это свойство указывает на доступный заголовок веб-части, с которой могут работать средства чтения с экрана. Базовая реализация возвращает этот используемый по умолчанию заголовок из манифеста. Веб-части, для которых требуется отображение более описательного заголовка (содержащего контекстную информацию), должны переопределять этот API. Виртуальной
context	Используйте объект контекста для доступа к общим службам и состоянию, связанным с компонентом.
dataVersion	Значение этого свойства хранится в сериализованных данных веб-части, что позволяет разработчикам управлять ее версиями. Версия по умолчанию: 1.0.
description	Описание веб-части.
disableReactivePropertyChanges	Это свойство используется для изменения взаимодействия области свойств веб-части с Reactive на NonReactive. Виртуальной
displayMode	Это свойство означает текущий режим отображения веб-части.
previewImageUrl	Это свойство указывает на изображение предварительного просмотра для веб-части. В базовой реализации возвращается неопределенное значение. Веб-части, предоставляющие допустимый URL-адрес изображения для предварительного просмотра, должны перезаписывать этот API. Используя URL-адрес изображения предварительного просмотра, можно обеспечить предварительный просмотр веб-части или страницы, на которой находится веб-часть. Виртуальной
properties	Это свойство указывает на пользовательский контейнер свойств веб-части.
propertiesMetadata	Это свойство определяет метаданные для контейнера свойств веб-части. С помощью метаданных SharePoint точнее определяет содержимое свойств и обрабатывает данные соответствующим образом. Виртуальной
title	Заголовок веб-части.

Методы

getPropertyPaneConfiguration()	Используйте этот API, чтобы получить конфигурацию для создания области свойств веб-части. Если веб-часть должна использовать для настройки PropertyPane, этот API необходимо переопределить, и веб-часть должна возвращать конфигурацию для PropertyPane. Этот API не вызывается до тех пор, пока не будет разрешено обещание loadPropertyPaneResources. Дополнительные сведения см. в статье IPropertyPane и другая вики-документация по интеграции с PropertyPane. Виртуальной
getTopActionsConfiguration()	Возвращает конфигурацию для основных действий этой веб-части или не определено, если веб-часть не поддерживает основные действия.
loadPropertyPaneResources()	Этот API включает асинхронную загрузку ресурсов веб-части, связанных с областью свойств.
onAfterDeserialize(deserializedObject, dataVersion)	Этот API вызывается после десериализации веб-части в объект, прямо перед заполнением контейнера свойств. Виртуальной
onAfterPropertyPaneChangesApplied()	Этот API вызывается после применения изменений, внесенных в PropertyPane, когда PropertyPane используется в режиме Non-Reactive. Этот API не вызывается, когда PropertyPane используется в режиме Reactive. Виртуальной
onBeforeSerialize()	Этот метод события вызывается перед сериализацией веб-части. Виртуальной
onDisplayModeChanged(oldDisplayMode)	Этот метод события вызывается при изменении режима отображения веб-части. Виртуальной
onDispose()	Этот API следует использовать для обновления содержимого PropertyPane. Виртуальной
onInit()	Этот метод события вызывается при инициализации веб-части. Виртуальной
onPropertyPaneConfigurationComplete()	Этот API вызывается после завершения настройки PropertyPane. Виртуальной
onPropertyPaneConfigurationStart()	Этот метод события вызывается при запуске конфигурации в PropertyPane. Виртуальной
onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)	Этот API вызывается после обновления нового значения свойства в контейнере свойств, когда PropertyPane используется в режиме Reactive. Виртуальной
onPropertyPaneRendered()	Этот API вызывается при отрисовке PropertyPane. Виртуальной

Сведения о конструкторе

(constructor)()

Конструктор класса BaseWebPart .

constructor();

Настоятельно рекомендуется использовать API OnInit для инициализации веб-части. Большинство функций веб-частей, таких как this.context и this.properties, недоступны для использования до части onInit жизненного цикла загрузки веб-части.

Сведения о свойстве

accessibleTitle

Это свойство указывает на доступный заголовок веб-части, с которой могут работать средства чтения с экрана. Базовая реализация возвращает этот используемый по умолчанию заголовок из манифеста. Веб-части, для которых требуется отображение более описательного заголовка (содержащего контекстную информацию), должны переопределять этот API. Виртуальной

protected get accessibleTitle(): string;

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

string

context

Используйте объект контекста для доступа к общим службам и состоянию, связанным с компонентом.

readonly context: BaseWebPartContext;

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

BaseWebPartContext

Ожидается, что дочерние классы переопределяют это поле, повторно объявив его специализированным типом. Он должен быть свойством только для чтения; Тип не может быть объявлен как доступный только для чтения в базовом классе (так как он инициализирован за пределами конструктора), но дочерние классы должны повторно объявить его как только для чтения.

dataVersion

Значение этого свойства хранится в сериализованных данных веб-части, что позволяет разработчикам управлять ее версиями. Версия по умолчанию: 1.0.

protected get dataVersion(): Version;

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

Version

description

Описание веб-части.

protected get description(): string;

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

string

disableReactivePropertyChanges

Это свойство используется для изменения взаимодействия области свойств веб-части с Reactive на NonReactive. Виртуальной

protected get disableReactivePropertyChanges(): boolean;

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

boolean

Реактивная подразумевает, что изменения, внесенные в PropertyPane, передаются в веб-часть мгновенно, и пользователь может видеть мгновенные обновления. Это помогает создателю страницы мгновенно получить отзыв и решить, оставлять ли новые изменения конфигурации.

NonReactive подразумевает, что изменения конфигурации передаются в веб-часть только после нажатия кнопки "Применить" PropertyPane.

displayMode

Это свойство означает текущий режим отображения веб-части.

get displayMode(): DisplayMode;

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

DisplayMode

previewImageUrl

Это свойство указывает на изображение предварительного просмотра для веб-части. В базовой реализации возвращается неопределенное значение. Веб-части, предоставляющие допустимый URL-адрес изображения для предварительного просмотра, должны перезаписывать этот API. Используя URL-адрес изображения предварительного просмотра, можно обеспечить предварительный просмотр веб-части или страницы, на которой находится веб-часть. Виртуальной

get previewImageUrl(): string | undefined;

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

string | undefined

properties

Это свойство указывает на пользовательский контейнер свойств веб-части.

protected get properties(): TProperties;

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

TProperties

propertiesMetadata

Это свойство определяет метаданные для контейнера свойств веб-части. С помощью метаданных SharePoint точнее определяет содержимое свойств и обрабатывает данные соответствующим образом. Виртуальной

protected get propertiesMetadata(): IWebPartPropertiesMetadata | undefined;

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

IWebPartPropertiesMetadata | undefined

title

Заголовок веб-части.

protected get title(): string;

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

string

Сведения о методе

getPropertyPaneConfiguration()

Используйте этот API, чтобы получить конфигурацию для создания области свойств веб-части. Если веб-часть должна использовать для настройки PropertyPane, этот API необходимо переопределить, и веб-часть должна возвращать конфигурацию для PropertyPane.

Этот API не вызывается до тех пор, пока не будет разрешено обещание loadPropertyPaneResources.

Дополнительные сведения см. в статье IPropertyPane и другая вики-документация по интеграции с PropertyPane. Виртуальной

protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration;

Возвращаемое значение

IPropertyPaneConfiguration

getTopActionsConfiguration()

Возвращает конфигурацию для основных действий этой веб-части или не определено, если веб-часть не поддерживает основные действия.

getTopActionsConfiguration(): ITopActions | undefined;

Возвращаемое значение

ITopActions | undefined

loadPropertyPaneResources()

Этот API включает асинхронную загрузку ресурсов веб-части, связанных с областью свойств.

/** @virtual */
protected loadPropertyPaneResources(): Promise<void>;

Возвращаемое значение

Promise<void>

Этот метод вызывается перед вызовом API области свойств. Другие API области свойств нельзя вызывать до тех пор, пока это обещание не будет разрешено. Другие события, связанные с областью свойств, не вызываются, кроме PropertyPaneConfigurationComplete.

Событие PropertyPaneConfigurationComplete можно вызвать для очистки всех ожидающих ресурсов, включая обещание loadPropertyPaneResources.

onAfterDeserialize(deserializedObject, dataVersion)

Этот API вызывается после десериализации веб-части в объект, прямо перед заполнением контейнера свойств. Виртуальной

protected onAfterDeserialize(deserializedObject: any, dataVersion: Version): TProperties;

Параметры

deserializedObject: any

Объект, десериализованный из сохраненных данных. Обратите внимание, что схема этого объекта не обязательно соответствует текущему контейнеру свойств, так как сериализация могла быть выполнена старой версией веб-части.

dataVersion: Version

Версия сохраненных данных, которые десериализируются. С помощью этого значения можно определить, сериализованы ли данные старой веб-частью. Веб-части могут определять версию данных, переопределяя свойство dataVersion.

Возвращаемое значение

TProperties

Контейнер свойств веб-части

Версия по умолчанию: no-op. Разработчик веб-части может переопределить этот API, если десериализованный объект не отражает полностью начальное состояние контейнера свойств. Это позволяет разработчику веб-части заполнить контейнер свойств сразу после десериализации данных в объект.

Важно правильно использовать десериализацию при обновлении. Обновленная веб-часть может загружать данные, сериализованные более старой версией веб-части, которая поддерживала другую схему контейнера свойств, в результате чего десериализованный объект не соответствует текущей схеме контейнера свойств. Разработчик может использовать onAfterDeserialize для проверка dataVersion и исправления контейнера свойств.

onAfterPropertyPaneChangesApplied()

Этот API вызывается после применения изменений, внесенных в PropertyPane, когда PropertyPane используется в режиме Non-Reactive. Этот API не вызывается, когда PropertyPane используется в режиме Reactive. Виртуальной

protected onAfterPropertyPaneChangesApplied(): void;

Возвращаемое значение

void

onBeforeSerialize()

Этот метод события вызывается перед сериализацией веб-части. Виртуальной

protected onBeforeSerialize(): void;

Возвращаемое значение

void

Версия по умолчанию: no-op. Процесс сериализации сериализует контейнер свойств веб-части, т. е. this.properties. Этот API позволяет веб-части обновить контейнер свойств до сериализации. Некоторые веб-части могут сохранять состояние других объектов или даже в DOM. Если веб-части необходимо сохранить часть этого состояния, ей необходимо переопределить этот API и обновить контейнер свойств веб-части до последнего состояния. Если веб-часть обновит контейнер свойств недопустимыми значениями свойств, они будут сохраняться. Поэтому этого следует избегать. Контейнер свойств веб-части всегда должен содержать допустимые значения свойств.

onDisplayModeChanged(oldDisplayMode)

Этот метод события вызывается при изменении режима отображения веб-части. Виртуальной

protected onDisplayModeChanged(oldDisplayMode: DisplayMode): void;

Параметры

oldDisplayMode: DisplayMode

Старый режим отображения.

Возвращаемое значение

void

Версия этого API по умолчанию вызывает метод render, чтобы обновить веб-часть. Если разработчик веб-части не хочет, чтобы после изменения режима отображения происходило полное обновление, он может переопределить этот API и выполнить обновления модели DOM веб-части, чтобы изменить режим отображения.

Если веб-часть инициализируется или повторно инициализирована при переключении в другой режим отображения, этот метод жизненного цикла не вызывается. Пример: страница сайта SharePoint.

onDispose()

Этот API следует использовать для обновления содержимого PropertyPane. Виртуальной

protected onDispose(): void;

Возвращаемое значение

void

Этот API вызывается в конце жизненного цикла веб-части на странице. Он должен использоваться для удаления любых локальных ресурсов (т. е. элементов DOM), которые веб-часть удерживает. Ожидается, что этот API будет вызываться в таких сценариях, как навигация по страницам, т. е. узел переходит с одной страницы на другую и удаляет перемещаемую страницу.

onInit()

Этот метод события вызывается при инициализации веб-части. Виртуальной

protected onInit(): Promise<void>;

Возвращаемое значение

Promise<void>

Этот API следует переопределять для выполнения длительных операций, например получения данных от удаленной службы перед начальной отрисовкой веб-части. Во время работы этого метода отображается индикатор загрузки. Этот API вызывается только один раз во время работы веб-части.

onPropertyPaneConfigurationComplete()

Этот API вызывается после завершения настройки PropertyPane. Виртуальной

protected onPropertyPaneConfigurationComplete(): void;

Возвращаемое значение

void

Когда CONFIGURATION_COMPLETE_TIMEOUT((в настоящее время значение составляет 5 секунд) истекает после последнего изменения.
Когда пользователь нажимает кнопку "X" (закрыть) до истечения CONFIGURATION_COMPLETE_TIMEOUT.
Когда пользователь нажимает кнопку "Применить" до истечения CONFIGURATION_COMPLETE_TIMEOUT.
Когда пользователь переключает веб-части, текущая веб-часть получает это событие.

onPropertyPaneConfigurationStart()

Этот метод события вызывается при запуске конфигурации в PropertyPane. Виртуальной

protected onPropertyPaneConfigurationStart(): void;

Возвращаемое значение

void

onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)

Этот API вызывается после обновления нового значения свойства в контейнере свойств, когда PropertyPane используется в режиме Reactive. Виртуальной

protected onPropertyPaneFieldChanged(propertyPath: string, oldValue: any, newValue: any): void;

Параметры

propertyPath: string

Путь JSON к свойству в контейнере свойств. В случае настраиваемого поля, если целевое свойство не указано, назначается настраиваемое значение, которое будет иметь вид __CustomField_<key provided when the custom field is created>.

oldValue: any

Старое значение свойства. Это значение может быть неопределенным или пустым в случае настраиваемого поля.

newValue: any

Новое значение свойства. Это значение может быть неопределенным или пустым в случае настраиваемого поля.

Возвращаемое значение

void

onPropertyPaneRendered()

Этот API вызывается при отрисовке PropertyPane. Виртуальной

protected onPropertyPaneRendered(): void;

Возвращаемое значение

void

Поделиться через

BaseWebPart class

Конструкторы

Свойства

Методы

Сведения о конструкторе

(constructor)()

Комментарии

Сведения о свойстве

accessibleTitle

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

context

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

Комментарии

dataVersion

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

description

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

disableReactivePropertyChanges

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

Комментарии

displayMode

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

previewImageUrl

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

properties

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

propertiesMetadata

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

Комментарии

title

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

Сведения о методе

getPropertyPaneConfiguration()

Возвращаемое значение

getTopActionsConfiguration()

Возвращаемое значение

loadPropertyPaneResources()

Возвращаемое значение

Комментарии

onAfterDeserialize(deserializedObject, dataVersion)

Параметры

Возвращаемое значение

Комментарии

onAfterPropertyPaneChangesApplied()

Возвращаемое значение

onBeforeSerialize()

Возвращаемое значение

Комментарии

onDisplayModeChanged(oldDisplayMode)

Параметры

Возвращаемое значение

Комментарии

onDispose()

Возвращаемое значение

Комментарии

onInit()

Возвращаемое значение

Комментарии

onPropertyPaneConfigurationComplete()

Возвращаемое значение

Комментарии

onPropertyPaneConfigurationStart()

Возвращаемое значение

Комментарии

onPropertyPaneFieldChanged(propertyPath, oldValue, newValue)

Параметры

Возвращаемое значение

onPropertyPaneRendered()

Возвращаемое значение

Дополнительные ресурсы