@microsoft/sp-webpart-base package

web パーツの構築SharePoint Frameworkサポート。

クラス

BaseClientSideWebPart

この抽象クラスは、クライアント側 Web パーツの基本機能を実装します。 すべてのクライアント側 Web パーツは、このクラスから継承する必要があります。

BaseWebPart

この抽象クラスは、クライアント側 Web パーツの UI に依存しない基本機能を実装します。 目的は、2D と MR WebParts の間で共通のコアを許可するためです。

BaseWebPartContext

Web パーツ コンテキスト オブジェクト。 このオブジェクトには、Web パーツで使用できるコンテキスト サービスが含まれています。 たとえば、http クライアントへのコンテキスト インスタンス。

このベースは、UI 固有の WebPart のベースによって拡張されます。

WebPartContext

Web パーツ コンテキスト オブジェクト。 このオブジェクトには、Web パーツで使用できるコンテキスト サービスが含まれています。 たとえば、http クライアントへのコンテキスト インスタンス。

インターフェイス

IClientSideWebPartStatusRenderer

Web パーツの読み込みインジケーターとエラー メッセージを表示するコンポーネントによって実装されるインターフェイス。

IDynamicDataSharedPropertyConfiguration

共有プロパティに関連する構成。

IDynamicDataSharedPropertyFilters

プロパティ ウィンドウの動的データ プロパティ フィルター。

IDynamicDataSharedSourceConfiguration

共有ソースに関連する構成。

IDynamicDataSharedSourceFilters

プロパティ ウィンドウの動的データ ソース フィルター。

IMicrosoftTeams

Teams SDK と Teams コンテキストへのアクセスを提供します。 Web パーツが Teams に読み込まれている場合にのみ指定されます。

IPropertyPaneAccessor

Web パーツ コンテキスト プロパティ ウィンドウ アクセサー インターフェイス。 プロパティ ウィンドウとコンテンツ パネルにアクセスするために最もよく使用される操作をいくつか提供します。

IPropertyPaneButtonProps

PropertyPane ボタンのプロパティ。

IPropertyPaneCheckboxProps

PropertyPane CheckBox コンポーネントのプロパティ。

IPropertyPaneChoiceGroupOption

PropertyPane ChoiceGroup オプションのプロパティ。

IPropertyPaneChoiceGroupOptionIconProps

PropertyPane ChoiceGroup アイコン の小道具。

IPropertyPaneChoiceGroupProps

PropertyPane ChoiceGroup のプロパティ。

IPropertyPaneConditionalGroup

プロパティ ウィンドウの条件付きグループ。

IPropertyPaneConfiguration

Web パーツの構成設定

IPropertyPaneCustomFieldProps

PropertyPane CustomPropertyField のプロパティ。

IPropertyPaneDropdownCalloutProps

PropertyPane ドロップダウン吹き出しプロパティ。

IPropertyPaneDropdownOption

PropertyPane ドロップ ダウンのオプション。

IPropertyPaneDropdownProps

PropertyPane ドロップ ダウン コンポーネントのプロパティ。

IPropertyPaneDynamicFieldFilters

ソース フィルターとプロパティ フィルターの両方の積集合であるプロパティ ウィンドウの動的フィールド フィルター。

IPropertyPaneDynamicFieldProps

PropertyPaneDynamicField props。

IPropertyPaneDynamicFieldSetProps

PropertyPane DynamicFieldSet のプロップ。

IPropertyPaneDynamicTextFieldProps

PropertyPaneDynamicData コンポーネントの props。

IPropertyPaneField

PropertyPane のフィールド。

IPropertyPaneGroup

PropertyPane のグループ。 グループは PropertyPanePage の一部分です。

IPropertyPaneLabelProps

PropertyPaneLabel コンポーネントのプロパティ。

IPropertyPaneLinkProps

PropertyPaneLink コンポーネントのプロパティ。

IPropertyPanePage

PropertyPanePage インターフェイス。

IPropertyPanePageHeader

PropertyPane のヘッダー。 このヘッダーは、すべてのページに対して同じ状態を維持します。

IPropertyPaneSliderProps

PropertyPaneSliderProps コンポーネントのプロパティ。

IPropertyPaneTextFieldProps

PropertyPaneTextField コンポーネントのプロパティ。

IPropertyPaneToggleProps

PropertyPaneToggle コンポーネントのプロパティ。

ISDKs

環境に依存する SPFx によって提供される SDK の条件付きセット。

ISerializedWebPartData

この構造体は、Web パーツによって制御される Web パーツのシリアル化された状態の部分を表します。 これは、シリアル化されたデータにフレームワークによって追加されたデータを含む IWebPartData によって拡張されます。

IWebPartContext

クライアント側 Web パーツの基本コンテキスト インターフェイス。

IWebPartData

この構造体は、シリアル化された状態の Web パーツを表します。

IWebPartPropertiesMetadata

この構造体は、Web パーツプロパティのメタデータを文字列のマップとして定義するために使用されます。 IWebPartPropertyMetadata

IWebPartPropertyMetadata

これは、 のマップ値に使用される構造体です。 IWebPartPropertiesMetadata

列挙型

DynamicDataSharedDepth

動的データ参照の共有深度の可能な値の列挙型。

PropertyPaneButtonType

サポートされるすべてのボタンの種類についての列挙。

PropertyPaneDropdownOptionType

PropertyPaneDropdown()によってレンダリングされるドロップダウン メニューのオプションの種類を指定します。

PropertyPaneFieldType

サポートされるすべての PropertyPane フィールドの種類についての列挙。

名前は office-ui-fabric-react での名前と一致している必要があります (大文字と小文字の違いに注意してください)。

WebPartFormFactor

Web パーツのフォーム ファクター。

機能

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 で動的 TextField を作成するためのヘルパー メソッド。

PropertyPaneHorizontalRule()

PropertyPane に水平線を作成するヘルパー メソッド。

PropertyPaneLabel(targetProperty, properties)

PropertyPane にラベルを作成するヘルパー メソッド。

PropertyPaneLink(targetProperty, properties)

PropertyPane にリンクを作成するヘルパー メソッド。

PropertyPaneSlider(targetProperty, properties)

PropertyPane にスライダーを作成するヘルパー メソッド。

PropertyPaneTextField(targetProperty, properties)

PropertyPane に TextField を作成するヘルパー メソッド。

PropertyPaneToggle(targetProperty, properties)

PropertyPane にトグルを作成するヘルパー メソッド。

関数の詳細

PropertyPaneButton(targetProperty, properties)

警告

この API は非推奨になりました。

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

PropertyPane にボタンを作成するヘルパー メソッド。

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

パラメーター

targetProperty

string

ボタンが関連付けられているターゲット プロパティ。

properties
IPropertyPaneButtonProps

厳密に型指定されたボタンのプロパティ。

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。

PropertyPaneCheckbox(targetProperty, properties)

警告

この API は非推奨になりました。

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

PropertyPane にチェックボックスを作成するヘルパー メソッド。

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

パラメーター

targetProperty

string

チェックボックスが関連付けられているターゲット プロパティ。

properties
IPropertyPaneCheckboxProps

厳密に型指定されたチェックボックスのプロパティ。

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。

PropertyPaneChoiceGroup(targetProperty, properties)

警告

この API は非推奨になりました。

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

PropertyPane に選択肢グループを作成するヘルパー メソッド。

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

パラメーター

targetProperty

string

選択肢グループが関連付けられているターゲット プロパティ。

properties
IPropertyPaneChoiceGroupProps

厳密に型指定された選択肢グループのプロパティ。

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。

PropertyPaneCustomField(properties)

警告

この API は非推奨になりました。

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

PropertyPane でユーザー設定フィールドを作成するためのヘルパー メソッド。

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

パラメーター

properties
IPropertyPaneCustomFieldProps

厳密に型指定されたユーザー設定フィールド プロパティ。

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。

PropertyPaneDropdown(targetProperty, properties)

警告

この API は非推奨になりました。

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

PropertyPane にドロップダウンを作成するヘルパー メソッド。

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

パラメーター

targetProperty

string

ドロップダウンが関連付けられているターゲット プロパティ。

properties
IPropertyPaneDropdownProps

厳密に型指定されたドロップダウンのプロパティ。

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。

PropertyPaneDynamicField(targetProperty, properties)

警告

この API は非推奨になりました。

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

動的フィールドの PropertyPane に動的データ ウィジェットを作成するヘルパー メソッド。

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

パラメーター

targetProperty

string

動的データ ウィジェットが関連付けられているターゲット プロパティ。

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。

PropertyPaneDynamicFieldSet(properties)

警告

この API は非推奨になりました。

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

共通データ ソースを持つ一連の動的フィールドの動的データ ウィジェットをプロパティ ウィンドウに作成するヘルパー メソッド。

これらのフィールドは、関連付けられているフィルターに基づいて同じプロパティを共有できる場合があります。

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

パラメーター

properties
IPropertyPaneDynamicFieldSetProps

エントリとオプションが含まれます。次のように説明します。 エントリ - ウィジェットによって構成されるエントリのセット。 各エントリには、ターゲット プロパティと、必要に応じて表示するラベルが含まれます。 options - 指定された動的フィールドのセットに対して、コールバック、フィルターなどのカスタマイズされた値を有効にするオプション。

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。

PropertyPaneDynamicTextField(targetProperty, properties)

警告

この API は非推奨になりました。

This has been replaced by PropertyPaneDynamicField and moved to @microsoft/sp-property-pane. Please consume it from there.

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

PropertyPane で動的 TextField を作成するためのヘルパー メソッド。

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

パラメーター

targetProperty

string

動的テキスト フィールドが関連付けられているターゲット プロパティ。

properties
IPropertyPaneDynamicTextFieldProps

PropertyPaneDynamicTextField のプロパティ。

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。

PropertyPaneHorizontalRule()

警告

この API は非推奨になりました。

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

PropertyPane に水平線を作成するヘルパー メソッド。

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

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。

PropertyPaneLabel(targetProperty, properties)

警告

この API は非推奨になりました。

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

PropertyPane にラベルを作成するヘルパー メソッド。

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

パラメーター

targetProperty

string

ラベルが関連付けられているターゲット プロパティ。

properties
IPropertyPaneLabelProps

厳密に型指定されたラベルのプロパティ。

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。

警告

この API は非推奨になりました。

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

PropertyPane にリンクを作成するヘルパー メソッド。

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

パラメーター

targetProperty

string

リンクが関連付けられているターゲット プロパティ。

properties
IPropertyPaneLinkProps

厳密に型指定されたプロパティのリンク。

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。

PropertyPaneSlider(targetProperty, properties)

警告

この API は非推奨になりました。

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

PropertyPane にスライダーを作成するヘルパー メソッド。

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

パラメーター

targetProperty

string

スライダーが関連付けられているターゲット プロパティ。

properties
IPropertyPaneSliderProps

厳密に型指定されたスライダーのプロパティ。

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。

PropertyPaneTextField(targetProperty, properties)

警告

この API は非推奨になりました。

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

PropertyPane に TextField を作成するヘルパー メソッド。

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

パラメーター

targetProperty

string

テキストフィールドが関連付けられているターゲット プロパティ。

properties
IPropertyPaneTextFieldProps

厳密に型指定されたテキストフィールドのプロパティ。

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。

PropertyPaneToggle(targetProperty, properties)

警告

この API は非推奨になりました。

This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.

PropertyPane にトグルを作成するヘルパー メソッド。

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

パラメーター

targetProperty

string

トグルが関連付けられているターゲット プロパティ。

properties
IPropertyPaneToggleProps

厳密に型指定されたトグルのプロパティ。

戻り値

注釈

パブリック API コントラクトを破らないように、元の実装をここに残しました。