次の方法で共有

IPropertyPaneConfiguration interface

  • リファレンス
パッケージ:
@microsoft/sp-property-pane

Web パーツの構成設定

プロパティ

currentPage

PropertyPane に表示されるページ。
debounceProperties

onPropertyPaneFieldChanged イベントをデバウンスするプロパティの一覧。
disableAudiencePicker

この Web パーツを表示できる対象ユーザーの構成を許可する対象ユーザー選択ウィンドウを表示しないようにするかどうか。
disableFocusTrap

プロパティ ウィンドウ内のフォーカスのトラップを無効にするかどうかを指定します。
loadingIndicatorDelayTime

読み込みインジケーターがプロパティ ウィンドウに表示されるまでに遅延するミリ秒数。
pages

PropertyPane の合計ページ数。
pagesType

PropertyPane に表示するページの種類。 既定では、マルチページ プロパティ ウィンドウの 'Pages' として機能します。
showLoadingIndicator

プロパティ ウィンドウの上部に読み込みインジケーターを表示するかどうかを示します。

プロパティの詳細

currentPage

PropertyPane に表示されるページ。

currentPage?: number;

プロパティ値

number

debounceProperties

注意

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

onPropertyPaneFieldChanged イベントをデバウンスするプロパティの一覧。

debounceProperties?: IPropertyPaneDebounceProperty[];

プロパティ値

IPropertyPaneDebounceProperty[]

注釈

プロパティ ウィンドウがリアクティブな場合、 onPropertyPaneFieldChanged イベントが発生し、Web パーツのプロパティが変更されます。 これにより、一部のプロパティ ウィンドウ コントロールまたは Web パーツに対して jank が発生する可能性があります。 この構成プロパティを使用して、一覧表示されているプロパティの onPropertyPaneFieldChanged イベントをデバウンスできます。その他のプロパティは影響を受けません。

disableAudiencePicker

注意

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

この Web パーツを表示できる対象ユーザーの構成を許可する対象ユーザー選択ウィンドウを表示しないようにするかどうか。

disableAudiencePicker?: boolean;

プロパティ値

boolean

disableFocusTrap

注意

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

プロパティ ウィンドウ内のフォーカスのトラップを無効にするかどうかを指定します。

disableFocusTrap?: boolean;

プロパティ値

boolean

loadingIndicatorDelayTime

読み込みインジケーターがプロパティ ウィンドウに表示されるまでに遅延するミリ秒数。

loadingIndicatorDelayTime?: number;

プロパティ値

number

注釈

既定値は 500 です。

pages

PropertyPane の合計ページ数。

pages: IPropertyPanePage[];

プロパティ値

IPropertyPanePage[]

pagesType

注意

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

PropertyPane に表示するページの種類。 既定では、マルチページ プロパティ ウィンドウの 'Pages' として機能します。

pagesType?: PagesType;

プロパティ値

PagesType

showLoadingIndicator

プロパティ ウィンドウの上部に読み込みインジケーターを表示するかどうかを示します。

showLoadingIndicator?: boolean;

プロパティ値

boolean

注釈

この機能は、ユーザーが問題の解決を待機しているときに使用することを目的としています。 true に設定すると、オーバーレイの読み込みインジケーターが 500 ミリ秒後に表示されます (Web パーツの作成者は、overlayLoadingIndicator プロパティを使用して、この動作をオーバーライドできます)。

表示を遅らせる理由は、読み込みインジケーターが表示されないことを目指しているためです。 ただし、非同期のリクエストには時間がかかることがあり、エンド ユーザーに読み込みインジケーターを表示することが必要になります。