次の方法で共有

IDynamicDataSource interface

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

動的データ ソースは、コンシューマーに動的データを提供します。 データを取得するためのデータ ソースと API を識別するためのメタデータが提供されます。

プロパティ

id

動的データ ソースの ID。
metadata

動的データ ソースのメタデータ。

メソッド

allowedEventsAsync()

動的データ ソースで許可されるイベントの一覧を返します。 この API が空でない結果を返す場合、source は 'sendData' api を定義する必要があります。

この API が定義されていないか、空のマップを返す場合、コンシューマーはこのソースと通信できません。
getAnnotatedPropertyValue(propertyId)

プロパティ ID を指定すると、注釈付き値が返されます。 ソースが注釈付き値を指定しない場合、サンプル値とメタデータは未定義であるため、'getPropertyValue' にフォールバックします。
getAnnotatedPropertyValueAsync(propertyId)

プロパティ ID を指定すると、注釈付き値が返されます。 ソースが注釈付き値を指定しない場合、サンプル値とメタデータは未定義であるため、'getPropertyValue' にフォールバックします。
getPropertyDefinitions()

動的データのすべてのプロパティ定義を返します。 これは、コンポーネントの実装によってオーバーライドされる必要があります。
getPropertyDefinitionsAsync()

動的データのすべてのプロパティ定義を返します。 これは、コンポーネントの実装によってオーバーライドされる必要があります。
getPropertyValue(propertyId)

プロパティ ID を指定すると、 プロパティの値が返されます。 これは、コンポーネントの実装によってオーバーライドされる必要があります。
getPropertyValueAsync(propertyId)

プロパティ ID を指定すると、 プロパティの値が返されます。 これは、コンポーネントの実装によってオーバーライドされる必要があります。
sendEvent(eventName, data)

定義されている場合、コンシューマーは関連付けられている動的データ ソースにデータを送信できます。 その後、ソースはそれに応じて動作できます。

この API を呼び出すと、'eventName' で渡されたがソースで許可されているイベントの 1 つでない場合にエラーがスローされます。

プロパティの詳細

id

動的データ ソースの ID。

id: string;

プロパティ値

string

metadata

動的データ ソースのメタデータ。

metadata: IDynamicDataSourceMetadata;

プロパティ値

IDynamicDataSourceMetadata

メソッドの詳細

allowedEventsAsync()

注意

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

動的データ ソースで許可されるイベントの一覧を返します。 この API が空でない結果を返す場合、source は 'sendData' api を定義する必要があります。

この API が定義されていないか、空のマップを返す場合、コンシューマーはこのソースと通信できません。

allowedEventsAsync?(): Promise<ReadonlyArray<IDynamicDataEventDefinition>>;

戻り値

Promise<ReadonlyArray<IDynamicDataEventDefinition>>

getAnnotatedPropertyValue(propertyId)

警告

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

  • This API is deprecated. Please use the asynchronous version getAsyncAnnotatedPropertyValue

プロパティ ID を指定すると、注釈付き値が返されます。 ソースが注釈付き値を指定しない場合、サンプル値とメタデータは未定義であるため、'getPropertyValue' にフォールバックします。

getAnnotatedPropertyValue(propertyId: string): IDynamicDataAnnotatedPropertyValue;

パラメーター

propertyId

string

動的データ ソースから公開されるプロパティ ID の 1 つ。

戻り値

IDynamicDataAnnotatedPropertyValue

getAnnotatedPropertyValueAsync(propertyId)

プロパティ ID を指定すると、注釈付き値が返されます。 ソースが注釈付き値を指定しない場合、サンプル値とメタデータは未定義であるため、'getPropertyValue' にフォールバックします。

getAnnotatedPropertyValueAsync(propertyId: string): Promise<IDynamicDataAnnotatedPropertyValue>;

パラメーター

propertyId

string

値が要求されるプロパティ ID。

戻り値

Promise<IDynamicDataAnnotatedPropertyValue>

getPropertyDefinitions()

警告

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

  • This API is deprecated. Please use the asynchronous version getPropertyDefinitionsAsync

動的データのすべてのプロパティ定義を返します。 これは、コンポーネントの実装によってオーバーライドされる必要があります。

getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;

戻り値

ReadonlyArray<IDynamicDataPropertyDefinition>

getPropertyDefinitionsAsync()

動的データのすべてのプロパティ定義を返します。 これは、コンポーネントの実装によってオーバーライドされる必要があります。

getPropertyDefinitionsAsync(): Promise<ReadonlyArray<IDynamicDataPropertyDefinition>>;

戻り値

Promise<ReadonlyArray<IDynamicDataPropertyDefinition>>

getPropertyValue(propertyId)

警告

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

  • This API is deprecated. Please use the asynchronous version getAsyncPropertyValue

プロパティ ID を指定すると、 プロパティの値が返されます。 これは、コンポーネントの実装によってオーバーライドされる必要があります。

getPropertyValue(propertyId: string): any;

パラメーター

propertyId

string

値が要求されるプロパティ ID。

戻り値

any

getPropertyValueAsync(propertyId)

プロパティ ID を指定すると、 プロパティの値が返されます。 これは、コンポーネントの実装によってオーバーライドされる必要があります。

getPropertyValueAsync(propertyId: string): Promise<any>;

パラメーター

propertyId

string

値が要求されるプロパティ ID。

戻り値

Promise<any>

sendEvent(eventName, data)

注意

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

定義されている場合、コンシューマーは関連付けられている動的データ ソースにデータを送信できます。 その後、ソースはそれに応じて動作できます。

この API を呼び出すと、'eventName' で渡されたがソースで許可されているイベントの 1 つでない場合にエラーがスローされます。

sendEvent?(eventName: string, data: any): void;

パラメーター

eventName

string

イベントの名前を表す大文字と小文字を区別する文字列。

data

any

動的データ ソースに送信されるデータ。

戻り値

void