@microsoft/sp-property-pane package
プロパティ ウィンドウSharePoint Framework。
インターフェイス
IDynamicDataSharedPropertyConfiguration |
共有プロパティに関連する構成。 |
IDynamicDataSharedPropertyFilters |
プロパティ ウィンドウの動的データ プロパティ フィルター。 |
IDynamicDataSharedSourceConfiguration |
共有ソースに関連する構成。 |
IDynamicDataSharedSourceFilters |
プロパティ ウィンドウの動的データ ソース フィルター。 |
IGuidSet |
リスト アイテムを表す GUID のセット。 |
IPopupWindowProps |
ポップアップ ウィンドウの小道具。 |
IPropertyPaneButtonProps |
PropertyPane ボタンのプロパティ。 |
IPropertyPaneCheckboxProps |
PropertyPane CheckBox コンポーネントのプロパティ。 |
IPropertyPaneChoiceGroupOption |
PropertyPane ChoiceGroup オプションのプロパティ。 |
IPropertyPaneChoiceGroupOptionIconProps |
PropertyPane ChoiceGroup アイコン の小道具。 |
IPropertyPaneChoiceGroupProps |
PropertyPane ChoiceGroup のプロパティ。 |
IPropertyPaneConditionalGroup |
プロパティ ウィンドウの条件付きグループ。 |
IPropertyPaneConfiguration |
Web パーツの構成設定 |
IPropertyPaneCustomFieldProps |
PropertyPane CustomPropertyField のプロパティ。 |
IPropertyPaneDebounceProperty |
イベントをデバウンスする必要があるプロパティ ウィンドウ プロパティの |
IPropertyPaneDropdownCalloutProps |
PropertyPane ドロップダウン吹き出しプロパティ。 |
IPropertyPaneDropdownOption |
PropertyPane ドロップ ダウンのオプション。 |
IPropertyPaneDropdownProps |
PropertyPane ドロップ ダウン コンポーネントのプロパティ。 |
IPropertyPaneDynamicFieldProps |
PropertyPaneDynamicField props。 |
IPropertyPaneDynamicFieldSetProps |
PropertyPane DynamicFieldSet のプロップ。 |
IPropertyPaneDynamicTextFieldProps |
|
IPropertyPaneField |
PropertyPane のフィールド。 |
IPropertyPaneGroup |
PropertyPane のグループ。 グループは PropertyPanePage の一部分です。 |
IPropertyPaneIconPickerProps |
PropertyPaneIconPicker コンポーネント の props |
IPropertyPaneLabelProps |
PropertyPaneLabel コンポーネントのプロパティ。 |
IPropertyPaneLinkProps |
PropertyPaneLink コンポーネントのプロパティ。 |
IPropertyPanePage |
PropertyPanePage インターフェイス。 |
IPropertyPanePageHeader |
PropertyPane のヘッダー。 このヘッダーは、すべてのページに対して同じ状態を維持します。 |
IPropertyPaneSliderProps |
PropertyPaneSliderProps コンポーネントのプロパティ。 |
IPropertyPaneTextFieldProps |
PropertyPaneTextField コンポーネントのプロパティ。 |
IPropertyPaneThumbnailPickerProps |
PropertyPaneThumbnailPicker コンポーネント の props |
IPropertyPaneToggleProps |
PropertyPaneToggle コンポーネントのプロパティ。 |
IThumbnailFabricReactIcon |
ファブリック アイコンのサムネイルに関連するオプション。 |
IThumbnailIconSizeImage |
アイコン サイズの画像サムネイルに関連するオプション。 |
IThumbnailImage |
画像サムネイルに関連するオプション。 |
型エイリアス
ImageFit |
画像に合わせて使用できるメソッド。 |
IPropertyPaneDynamicFieldFilters |
ソース フィルターとプロパティ フィルターの両方の積集合であるプロパティ ウィンドウの動的フィールド フィルター。 |
IThumbnail |
構成されているサムネイル 画像の種類。 |
ThumbnailType |
サポートされているサムネイル画像の種類。 |
列挙型
DynamicDataSharedDepth |
動的データ参照の共有深度の可能な値の列挙型。 |
PopupWindowPosition |
ポップアップ ウィンドウの位置。 |
PropertyPaneButtonType |
サポートされるすべてのボタンの種類についての列挙。 |
PropertyPaneDropdownOptionType |
PropertyPaneDropdown()によってレンダリングされるドロップダウン メニューのオプションの種類を指定します。 |
PropertyPaneFieldType |
サポートされるすべての PropertyPane フィールドの種類についての列挙。 名前は office-ui-fabric-react での名前と一致している必要があります (大文字と小文字の違いに注意してください)。 |
機能
関数の詳細
PropertyPaneButton(targetProperty, properties)
PropertyPane にボタンを作成するヘルパー メソッド。
export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField<IPropertyPaneButtonProps>;
パラメーター
- targetProperty
-
string
ボタンが関連付けられているターゲット プロパティ。
- properties
- IPropertyPaneButtonProps
厳密に型指定されたボタンのプロパティ。
戻り値
PropertyPaneCheckbox(targetProperty, properties)
PropertyPane にチェックボックスを作成するヘルパー メソッド。
export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField<IPropertyPaneCheckboxProps>;
パラメーター
- targetProperty
-
string
チェックボックスが関連付けられているターゲット プロパティ。
- properties
- IPropertyPaneCheckboxProps
厳密に型指定されたチェックボックスのプロパティ。
戻り値
PropertyPaneChoiceGroup(targetProperty, properties)
PropertyPane に選択肢グループを作成するヘルパー メソッド。
export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField<IPropertyPaneChoiceGroupProps>;
パラメーター
- targetProperty
-
string
選択肢グループが関連付けられているターゲット プロパティ。
- properties
- IPropertyPaneChoiceGroupProps
厳密に型指定された選択肢グループのプロパティ。
戻り値
PropertyPaneCustomField(properties)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
PropertyPane でユーザー設定フィールドを作成するためのヘルパー メソッド。
export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField<IPropertyPaneCustomFieldProps>;
パラメーター
- properties
- IPropertyPaneCustomFieldProps
厳密に型指定されたユーザー設定フィールド プロパティ。
戻り値
注釈
ユーザー設定フィールドの目的は、Web パーツ開発者が PropertyPane にカスタム コントロールを追加できるようにするためです。 PropertyPane では、組み込みのフィールド型のホストがサポートされています。 この一覧は、ほとんどの Web パーツの要求を満たしますが、Web パーツに特別なニーズがあり、特別な制御が必要な場合は例外的なケースがあります。 ユーザー設定フィールドは、そのギャップを埋めるのに役立ちます。
PropertyPaneDropdown(targetProperty, properties)
PropertyPane にドロップダウンを作成するヘルパー メソッド。
export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField<IPropertyPaneDropdownProps>;
パラメーター
- targetProperty
-
string
ドロップダウンが関連付けられているターゲット プロパティ。
- properties
- IPropertyPaneDropdownProps
厳密に型指定されたドロップダウンのプロパティ。
戻り値
PropertyPaneDynamicField(targetProperty, properties)
動的フィールドの PropertyPane に動的データ ウィジェットを作成するヘルパー メソッド。
export declare function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): IPropertyPaneField<IPropertyPaneDynamicFieldProps>;
パラメーター
- targetProperty
-
string
動的データ ウィジェットが関連付けられているターゲット プロパティ。
- properties
- IPropertyPaneDynamicFieldProps
戻り値
PropertyPaneDynamicFieldSet(properties)
共通データ ソースを持つ一連の動的フィールドの動的データ ウィジェットをプロパティ ウィンドウに作成するヘルパー メソッド。
これらのフィールドは、関連付けられているフィルターに基づいて同じプロパティを共有できる場合があります。
export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>;
パラメーター
- properties
- IPropertyPaneDynamicFieldSetProps
エントリとオプションが含まれます。次のように説明します。 エントリ - ウィジェットによって構成されるエントリのセット。 各エントリには、ターゲット プロパティと、必要に応じて表示するラベルが含まれます。 options - 指定された動的フィールドのセットに対して、コールバック、フィルターなどのカスタマイズされた値を有効にするオプション。
戻り値
PropertyPaneDynamicTextField(targetProperty, properties)
警告
この API は非推奨になりました。
- This has been replaced by PropertyPaneDynamicField
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
PropertyPane で動的 TextField を作成するためのヘルパー メソッド。
export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>;
パラメーター
- targetProperty
-
string
動的テキスト フィールドが関連付けられているターゲット プロパティ。
- properties
- IPropertyPaneDynamicTextFieldProps
PropertyPaneDynamicTextField のプロパティ。
戻り値
PropertyPaneHorizontalRule()
PropertyPane に水平線を作成するヘルパー メソッド。
export declare function PropertyPaneHorizontalRule(): IPropertyPaneField<void>;
戻り値
IPropertyPaneField<void>
PropertyPaneIconPicker(targetProperty, properties)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
PropertyPane で IconPicker を作成するためのヘルパー メソッド。
export declare function PropertyPaneIconPicker(targetProperty: string, properties: IPropertyPaneIconPickerProps): IPropertyPaneField<IPropertyPaneIconPickerProps>;
パラメーター
- targetProperty
-
string
アイコン ピッカーが関連付けられているターゲット プロパティ。
- properties
- IPropertyPaneIconPickerProps
厳密に型指定された IconPicker プロパティ。
戻り値
PropertyPaneLabel(targetProperty, properties)
PropertyPane にラベルを作成するヘルパー メソッド。
export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField<IPropertyPaneLabelProps>;
パラメーター
- targetProperty
-
string
ラベルが関連付けられているターゲット プロパティ。
- properties
- IPropertyPaneLabelProps
厳密に型指定されたラベルのプロパティ。
戻り値
PropertyPaneLink(targetProperty, properties)
PropertyPane にリンクを作成するヘルパー メソッド。
export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField<IPropertyPaneLinkProps>;
パラメーター
- targetProperty
-
string
リンクが関連付けられているターゲット プロパティ。
- properties
- IPropertyPaneLinkProps
厳密に型指定されたプロパティのリンク。
戻り値
PropertyPaneSlider(targetProperty, properties)
PropertyPane にスライダーを作成するヘルパー メソッド。
export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField<IPropertyPaneSliderProps>;
パラメーター
- targetProperty
-
string
スライダーが関連付けられているターゲット プロパティ。
- properties
- IPropertyPaneSliderProps
厳密に型指定されたスライダーのプロパティ。
戻り値
PropertyPaneTextField(targetProperty, properties)
PropertyPane に TextField を作成するヘルパー メソッド。
export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField<IPropertyPaneTextFieldProps>;
パラメーター
- targetProperty
-
string
テキストフィールドが関連付けられているターゲット プロパティ。
- properties
- IPropertyPaneTextFieldProps
厳密に型指定されたテキストフィールドのプロパティ。
戻り値
PropertyPaneThumbnailPicker(targetProperty, properties)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
PropertyPane で ThumbnailPicker を作成するためのヘルパー メソッド。
export declare function PropertyPaneThumbnailPicker(targetProperty: string, properties: IPropertyPaneThumbnailPickerProps): IPropertyPaneField<IPropertyPaneThumbnailPickerProps>;
パラメーター
- targetProperty
-
string
サムネイル ピッカーが関連付けられているターゲット プロパティ。
- properties
- IPropertyPaneThumbnailPickerProps
厳密に型指定された ThumbnailPicker プロパティ。
戻り値
PropertyPaneToggle(targetProperty, properties)
PropertyPane にトグルを作成するヘルパー メソッド。
export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField<IPropertyPaneToggleProps>;
パラメーター
- targetProperty
-
string
トグルが関連付けられているターゲット プロパティ。
- properties
- IPropertyPaneToggleProps
厳密に型指定されたトグルのプロパティ。