次の方法で共有

DynamicDataProvider class

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

動的データ プロバイダーを使用すると、コンポーネントで動的データを使用できます。 これにより、コンポーネントは動的データ ソースを要求し、それらを登録/登録解除できます。

プロパティ

isDisposed

動的データ プロバイダーが破棄された場合は true を返します。

メソッド

dispose()

動的データ プロバイダーを破棄します。
getAvailableSources()

使用可能なすべての動的データ ソースを含むリストを返します。
registerAvailableSourcesChanged(callback)

使用可能な動的データ ソースの一覧が更新されたときに発生するイベントにコールバックを登録します。
registerPropertyChanged(sourceId, propertyId, callback)

動的データ ソースでプロパティが変更されたときに、更新プログラムのコールバックを登録します。
registerSourceChanged(sourceId, callback)

動的データ ソースが変更されたときに更新のコールバックを登録します。 これは、ソース内でプロパティが更新されたときに発生します。
tryGetSource(id)

動的データ ソースを ID で返します。ソースが存在しない場合は、undefined が返されます。
unregisterAvailableSourcesChanged(callback)

使用可能な動的データ ソースの一覧が更新されたときに発生するイベントへのコールバックの登録を解除します。
unregisterPropertyChanged(sourceId, propertyId, callback)

動的データ ソースでプロパティが変更されたときに、更新のコールバックの登録を解除します。
unregisterSourceChanged(sourceId, callback)

動的データ ソースが変更されたときに更新のコールバックの登録を解除します。

プロパティの詳細

isDisposed

動的データ プロバイダーが破棄された場合は true を返します。

get isDisposed(): boolean;

プロパティ値

boolean

メソッドの詳細

dispose()

動的データ プロバイダーを破棄します。

dispose(): void;

戻り値

void

getAvailableSources()

使用可能なすべての動的データ ソースを含むリストを返します。

getAvailableSources(): ReadonlyArray<IDynamicDataSource>;

戻り値

ReadonlyArray<IDynamicDataSource>

使用可能なすべてのソースを含む読み取り専用配列。

registerAvailableSourcesChanged(callback)

使用可能な動的データ ソースの一覧が更新されたときに発生するイベントにコールバックを登録します。

registerAvailableSourcesChanged(callback: () => void): void;

パラメーター

callback

() => void

ソースが更新されたときに実行する関数。

戻り値

void

registerPropertyChanged(sourceId, propertyId, callback)

動的データ ソースでプロパティが変更されたときに、更新プログラムのコールバックを登録します。

registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;

パラメーター

sourceId

string

動的データ ソースの ID。

propertyId

string

ソースのプロパティの ID。

callback

() => void

ソースがデータを更新するときに実行する関数。

戻り値

void

registerSourceChanged(sourceId, callback)

動的データ ソースが変更されたときに更新のコールバックを登録します。 これは、ソース内でプロパティが更新されたときに発生します。

registerSourceChanged(sourceId: string, callback: () => void): void;

パラメーター

sourceId

string

動的データ ソースの ID。

callback

() => void

ソースがデータを更新するときに実行する関数。

戻り値

void

tryGetSource(id)

動的データ ソースを ID で返します。ソースが存在しない場合は、undefined が返されます。

tryGetSource(id: string): IDynamicDataSource | undefined;

パラメーター

id

string

動的データ ソースの ID。

戻り値

IDynamicDataSource | undefined

unregisterAvailableSourcesChanged(callback)

使用可能な動的データ ソースの一覧が更新されたときに発生するイベントへのコールバックの登録を解除します。

unregisterAvailableSourcesChanged(callback: () => void): void;

パラメーター

callback

() => void

登録から削除する関数。 登録されているのと同じである必要があります。

戻り値

void

unregisterPropertyChanged(sourceId, propertyId, callback)

動的データ ソースでプロパティが変更されたときに、更新のコールバックの登録を解除します。

unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;

パラメーター

sourceId

string

動的データ ソースの ID。

propertyId

string

ソースのプロパティの ID。

callback

() => void

登録から削除する関数。 登録されているのと同じである必要があります。

戻り値

void

unregisterSourceChanged(sourceId, callback)

動的データ ソースが変更されたときに更新のコールバックの登録を解除します。

unregisterSourceChanged(sourceId: string, callback: () => void): void;

パラメーター

sourceId

string

動的データ ソースの ID。

callback

() => void

登録から削除する関数。 登録されているのと同じである必要があります。

戻り値

void