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

@microsoft/sp-property-pane package

  • Ссылка

SharePoint Framework области свойств.

Интерфейсы

IDynamicDataSharedPropertyConfiguration

Конфигурация, связанная с общим свойством.
IDynamicDataSharedPropertyFilters

Динамические фильтры свойств данных области свойств.
IDynamicDataSharedSourceConfiguration

Конфигурация, связанная с общим источником.
IDynamicDataSharedSourceFilters

Динамические фильтры источников данных области свойств.
IGuidSet

Набор идентификаторов GUID, представляющих элемент списка.
IPopupWindowProps

Всплывающие окна реквизиты.
IPropertyPaneButtonProps

Свойства кнопки PropertyPane.
IPropertyPaneCheckboxProps

Свойства компонента CheckBox в PropertyPane.
IPropertyPaneChoiceGroupOption

Свойства параметра ChoiceGroup в PropertyPane.
IPropertyPaneChoiceGroupOptionIconProps

Значок PropertyPane ChoiceGroup реквизиты.
IPropertyPaneChoiceGroupProps

Реквизиты ChoiceGroup PropertyPane.
IPropertyPaneConditionalGroup

Условная группа области свойств.
IPropertyPaneConfiguration

Параметры конфигурации веб-части
IPropertyPaneCustomFieldProps

Свойства объекта CustomPropertyField в PropertyPane.
IPropertyPaneDebounceProperty

Определение свойства Области свойств, в котором должно быть onPropertyPaneFieldChanged отключено событие.
IPropertyPaneDropdownCalloutProps

Свойства выноски из раскрывающегося списка PropertyPane.
IPropertyPaneDropdownOption

Пункты раскрывающегося меню PropertyPane.
IPropertyPaneDropdownProps

Свойства компонента раскрывающегося меню PropertyPane.
IPropertyPaneDynamicFieldProps

Реквизиты PropertyPaneDynamicField.
IPropertyPaneDynamicFieldSetProps

Реквизиты PropertyPane DynamicFieldSet.
IPropertyPaneDynamicTextFieldProps

PropertyPaneDynamicData реквизит компонента.
IPropertyPaneField

Поле PropertyPane.
IPropertyPaneGroup

Группа PropertyPane. Группа — это часть PropertyPanePage.
IPropertyPaneIconPickerProps

Компоненты PropertyPaneIconPicker
IPropertyPaneLabelProps

Свойства компонента PropertyPaneLabel.
IPropertyPaneLinkProps

Свойства компонента PropertyPaneLink.
IPropertyPanePage

Интерфейс PropertyPanePage.
IPropertyPanePageHeader

Заголовок PropertyPane. Этот заголовок остается неизменным для всех страниц.
IPropertyPaneSliderProps

Свойства компонента PropertyPaneSliderProps.
IPropertyPaneTextFieldProps

Свойства компонента PropertyPaneTextField.
IPropertyPaneThumbnailPickerProps

Компоненты PropertyPaneThumbnailPicker
IPropertyPaneToggleProps

Реквизиты компонента PropertyPaneToggle.
IThumbnailFabricReactIcon

Параметры, связанные с эскизом значка структуры.
IThumbnailIconSizeImage

Параметры, связанные с эскизом изображения размером со значком.
IThumbnailImage

Параметры, связанные с эскизом изображения.

Псевдонимы типа

ImageFit

Возможные методы, которые можно использовать для размещения изображения.
IPropertyPaneDynamicFieldFilters

Динамические фильтры полей области свойств, которые являются пересечением исходных фильтров и фильтров свойств.
IThumbnail

Тип настраиваемого эскиза.
ThumbnailType

Поддерживаемые типы эскизов изображений.

Перечисления

DynamicDataSharedDepth

Перечисление возможных значений общей глубины динамической ссылки на данные.
PopupWindowPosition

Положение всплывающего окна.
PropertyPaneButtonType

Перечисление для всех поддерживаемых типов кнопки.
PropertyPaneDropdownOptionType

Указывает тип параметра в раскрывающемся меню, отображаемом свойством PropertyPaneDropdown().
PropertyPaneFieldType

Перечисление для всех поддерживаемых типов полей PropertyPane.

Имена должны соответствовать именам в office-ui-fabric-react, проверьте регистр букв.

Функции

PropertyPaneButton(targetProperty, properties)

Вспомогательный метод для создания кнопки в PropertyPane.
PropertyPaneCheckbox(targetProperty, properties)

Вспомогательный метод для создания флажка в PropertyPane.
PropertyPaneChoiceGroup(targetProperty, properties)

Вспомогательный метод для создания группы выбора в PropertyPane.
PropertyPaneCustomField(properties)

Вспомогательный метод для создания настраиваемого поля в PropertyPane.
PropertyPaneDropdown(targetProperty, properties)

Вспомогательный метод для создания раскрывающегося меню в PropertyPane.
PropertyPaneDynamicField(targetProperty, properties)

Вспомогательный метод для создания мини-приложения динамических данных в PropertyPane для динамического поля.
PropertyPaneDynamicFieldSet(properties)

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

Эти поля могут совместно использовать одно и то же свойство на основе связанных фильтров.
PropertyPaneDynamicTextField(targetProperty, properties)

Вспомогательный метод для создания динамического текстового поля в PropertyPane.
PropertyPaneHorizontalRule()

Вспомогательный метод для создания горизонтальной линейки в PropertyPane.
PropertyPaneIconPicker(targetProperty, properties)

Вспомогательный метод для создания IconPicker в PropertyPane.
PropertyPaneLabel(targetProperty, properties)

Вспомогательный метод для создания подписи в PropertyPane.
PropertyPaneLink(targetProperty, properties)

Вспомогательный метод для создания ссылки в PropertyPane.
PropertyPaneSlider(targetProperty, properties)

Вспомогательный метод для создания ползунка в PropertyPane.
PropertyPaneTextField(targetProperty, properties)

Вспомогательный метод для создания текстового поля в PropertyPane.
PropertyPaneThumbnailPicker(targetProperty, properties)

Вспомогательный метод для создания ThumbnailPicker в PropertyPane.
PropertyPaneToggle(targetProperty, properties)

Вспомогательный метод для создания переключателя в PropertyPane.

Сведения о функции

PropertyPaneButton(targetProperty, properties)

Вспомогательный метод для создания кнопки в PropertyPane.

export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField<IPropertyPaneButtonProps>;

Параметры

targetProperty

string

Целевое свойство, с которым связана кнопка.

properties
IPropertyPaneButtonProps

Строго типизированные свойства кнопки.

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

IPropertyPaneField<IPropertyPaneButtonProps>

PropertyPaneCheckbox(targetProperty, properties)

Вспомогательный метод для создания флажка в PropertyPane.

export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField<IPropertyPaneCheckboxProps>;

Параметры

targetProperty

string

Целевое свойство, с которым связан флажок.

properties
IPropertyPaneCheckboxProps

Строго типизированные свойства флажка.

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

IPropertyPaneField<IPropertyPaneCheckboxProps>

PropertyPaneChoiceGroup(targetProperty, properties)

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

export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField<IPropertyPaneChoiceGroupProps>;

Параметры

targetProperty

string

Целевое свойство, с которым связана группа выбора.

properties
IPropertyPaneChoiceGroupProps

Строго типизированные свойства группы выбора.

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

IPropertyPaneField<IPropertyPaneChoiceGroupProps>

PropertyPaneCustomField(properties)

Примечание

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

Вспомогательный метод для создания настраиваемого поля в PropertyPane.

export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField<IPropertyPaneCustomFieldProps>;

Параметры

properties
IPropertyPaneCustomFieldProps

Строго типизированные свойства настраиваемого поля.

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

IPropertyPaneField<IPropertyPaneCustomFieldProps>

Комментарии

Назначение настраиваемого поля — помочь разработчику веб-части добавить пользовательский элемент управления в PropertyPane. PropertyPane поддерживает множество встроенных типов полей. Хотя этот список соответствует требованиям большинства веб-частей, но бывают исключительные случаи, когда веб-части имеют особые потребности и требуют особого контроля. Настраиваемое поле помогает заполнить этот пробел.

PropertyPaneDropdown(targetProperty, properties)

Вспомогательный метод для создания раскрывающегося меню в PropertyPane.

export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField<IPropertyPaneDropdownProps>;

Параметры

targetProperty

string

Целевое свойство, с которым связано раскрывающееся меню.

properties
IPropertyPaneDropdownProps

Строго типизированные свойства раскрывающегося меню.

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

IPropertyPaneField<IPropertyPaneDropdownProps>

PropertyPaneDynamicField(targetProperty, properties)

Вспомогательный метод для создания мини-приложения динамических данных в PropertyPane для динамического поля.

export declare function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): IPropertyPaneField<IPropertyPaneDynamicFieldProps>;

Параметры

targetProperty

string

Целевое свойство, с чем связано мини-приложение динамических данных.

properties
IPropertyPaneDynamicFieldProps

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

IPropertyPaneField<IPropertyPaneDynamicFieldProps>

PropertyPaneDynamicFieldSet(properties)

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

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

export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>;

Параметры

properties
IPropertyPaneDynamicFieldSetProps

Содержит записи и параметры, описанные ниже: entries — набор записей для настройки мини-приложения. Каждая запись включает целевое свойство и, при необходимости, метку для отображения. options — параметры, включающие настраиваемые значения для обратного вызова, фильтров и т. д. для заданного набора динамических полей.

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

IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>

PropertyPaneDynamicTextField(targetProperty, properties)

Предупреждение

Теперь этот API является нерекомендуемым.

  • This has been replaced by PropertyPaneDynamicField

Примечание

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

Вспомогательный метод для создания динамического текстового поля в PropertyPane.

export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>;

Параметры

targetProperty

string

Целевое свойство, с которое связано динамическое текстовое поле.

properties
IPropertyPaneDynamicTextFieldProps

Свойства PropertyPaneDynamicTextField.

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

IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>

PropertyPaneHorizontalRule()

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

export declare function PropertyPaneHorizontalRule(): IPropertyPaneField<void>;

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

IPropertyPaneField<void>

PropertyPaneIconPicker(targetProperty, properties)

Примечание

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

Вспомогательный метод для создания IconPicker в PropertyPane.

export declare function PropertyPaneIconPicker(targetProperty: string, properties: IPropertyPaneIconPickerProps): IPropertyPaneField<IPropertyPaneIconPickerProps>;

Параметры

targetProperty

string

Целевое свойство, с которое связано средство выбора значков.

properties
IPropertyPaneIconPickerProps

Строго типизированные свойства IconPicker.

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

IPropertyPaneField<IPropertyPaneIconPickerProps>

PropertyPaneLabel(targetProperty, properties)

Вспомогательный метод для создания подписи в PropertyPane.

export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField<IPropertyPaneLabelProps>;

Параметры

targetProperty

string

Целевое свойство, с которым связана подпись.

properties
IPropertyPaneLabelProps

Строго типизированные свойства подписи.

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

IPropertyPaneField<IPropertyPaneLabelProps>

Вспомогательный метод для создания ссылки в PropertyPane.

export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField<IPropertyPaneLinkProps>;

Параметры

targetProperty

string

Целевое свойство, с которым связана ссылка.

properties
IPropertyPaneLinkProps

Строго типизированные свойства ссылки.

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

IPropertyPaneField<IPropertyPaneLinkProps>

PropertyPaneSlider(targetProperty, properties)

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

export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField<IPropertyPaneSliderProps>;

Параметры

targetProperty

string

Целевое свойство, с которым связан ползунок.

properties
IPropertyPaneSliderProps

Строго типизированные свойства ползунка.

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

IPropertyPaneField<IPropertyPaneSliderProps>

PropertyPaneTextField(targetProperty, properties)

Вспомогательный метод для создания текстового поля в PropertyPane.

export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField<IPropertyPaneTextFieldProps>;

Параметры

targetProperty

string

Целевое свойство, с которым связано текстовое поле.

properties
IPropertyPaneTextFieldProps

Строго типизированные свойства текстового поля.

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

IPropertyPaneField<IPropertyPaneTextFieldProps>

PropertyPaneThumbnailPicker(targetProperty, properties)

Примечание

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

Вспомогательный метод для создания ThumbnailPicker в PropertyPane.

export declare function PropertyPaneThumbnailPicker(targetProperty: string, properties: IPropertyPaneThumbnailPickerProps): IPropertyPaneField<IPropertyPaneThumbnailPickerProps>;

Параметры

targetProperty

string

Целевое свойство, с которое связано средство выбора эскизов.

properties
IPropertyPaneThumbnailPickerProps

Строго типизированные свойства ThumbnailPicker.

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

IPropertyPaneField<IPropertyPaneThumbnailPickerProps>

PropertyPaneToggle(targetProperty, properties)

Вспомогательный метод для создания переключателя в PropertyPane.

export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField<IPropertyPaneToggleProps>;

Параметры

targetProperty

string

Целевое свойство, с которым связан переключатель.

properties
IPropertyPaneToggleProps

Строго типизированные свойства переключателя.

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

IPropertyPaneField<IPropertyPaneToggleProps>