DynamicDataSourceManager class

パッケージ:

@microsoft/sp-component-base

動的データ ソース マネージャーは、次の役割を担います。 - 動的データ ソースの構築 - コンポーネントによる動的データ ソースの初期化を許可する - データ ソースがメタデータを更新し、データが更新されたときに通知できるようにします。

プロパティ

isDisposed	DynamicDataSourceManager が破棄された場合は true を返します。
sourceId	現在の DataSource の ID を返します。 コンポーネントが動的データ ソースとして初期化されなかった場合は、空の文字列が返されます。

メソッド

dispose()	動的データ ソースによって保持されているリソースを破棄します。
initializeSource(callableFunctions)	コンポーネントの動的データ ソースを初期化します。
notifyPropertyChanged(propertyId)	このソースが特定のプロパティを更新したことを通知します。 呼び出されると、このソースからこの通知に登録したすべてのコンシューマーに通知をブロードキャストできます。
notifySourceChanged()	このソースがプロパティを更新したことを通知します。 呼び出されると、このソースからこの通知に登録したすべてのコンシューマーに通知をブロードキャストできます。
updateMetadata(metadata)	動的データ ソースのメタデータをUpdatesします。 タイトルや説明などのフィールドを更新できます。 エイリアス、componentId、instanceId などの自動生成されたフィールドは更新できません。

プロパティの詳細

isDisposed

DynamicDataSourceManager が破棄された場合は true を返します。

get isDisposed(): boolean;

プロパティ値

boolean

sourceId

現在の DataSource の ID を返します。 コンポーネントが動的データ ソースとして初期化されなかった場合は、空の文字列が返されます。

get sourceId(): string;

プロパティ値

string

メソッドの詳細

dispose()

動的データ ソースによって保持されているリソースを破棄します。

dispose(): void;

戻り値

void

initializeSource(callableFunctions)

コンポーネントの動的データ ソースを初期化します。

initializeSource(callableFunctions: IDynamicDataCallables): void;

パラメーター

callableFunctions

IDynamicDataCallables

動的データ ソースを介して公開される一連のメソッド

戻り値

void

notifyPropertyChanged(propertyId)

このソースが特定のプロパティを更新したことを通知します。

呼び出されると、このソースからこの通知に登録したすべてのコンシューマーに通知をブロードキャストできます。

notifyPropertyChanged(propertyId: string): void;

パラメーター

propertyId

string

ソース内の更新されたプロパティの ID。

戻り値

void

notifySourceChanged()

このソースがプロパティを更新したことを通知します。

呼び出されると、このソースからこの通知に登録したすべてのコンシューマーに通知をブロードキャストできます。

notifySourceChanged(): void;

戻り値

void

updateMetadata(metadata)

動的データ ソースのメタデータをUpdatesします。 タイトルや説明などのフィールドを更新できます。 エイリアス、componentId、instanceId などの自動生成されたフィールドは更新できません。

updateMetadata(metadata: Partial<IDynamicDataSourceMetadata>): void;

パラメーター

metadata

Partial<IDynamicDataSourceMetadata>

メタデータの一部。

戻り値

void