IDynamicDataCallables interface

参考

包:: @microsoft/sp-dynamic-data

要实现的组件的接口，以便成为动态数据源。这可以实现为具有状态的对象，或一组返回数据的松散函数。

方法

allowedEvents()	返回动态数据源上允许的事件的列表。当此函数返回非空结果时，源必须定义“sendEvent”api。如果未定义此 API 或返回空数组，则使用者将无法与此源通信。
getAnnotatedPropertyValue(propertyId)	给定属性 ID 后，返回其批注值。如果源未提供带批注的值，则它会回退到任何“getPropertyValue”返回，因为示例值和元数据是未定义的。
getPropertyDefinitions()	返回 DataSource 将提供的所有属性定义。
getPropertyValue(propertyId)	给定属性 ID，返回属性的值。
sendEvent(eventName, data)	如果已定义，则使用者能够将数据发送到关联的动态数据源。然后，源可以采取相应的措施。当在“eventName”中传递的不是源上允许的事件之一时，调用此 API 会引发错误。

方法详细信息

allowedEvents()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

返回动态数据源上允许的事件的列表。

当此函数返回非空结果时，源必须定义“sendEvent”api。

如果未定义此 API 或返回空数组，则使用者将无法与此源通信。

allowedEvents?(): ReadonlyArray<IDynamicDataEventDefinition>;

ReadonlyArray<IDynamicDataEventDefinition>

getAnnotatedPropertyValue(propertyId)

给定属性 ID 后，返回其批注值。如果源未提供带批注的值，则它会回退到任何“getPropertyValue”返回，因为示例值和元数据是未定义的。

getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;

参数

propertyId: string

从动态数据源公开的属性 ID 之一。

IDynamicDataAnnotatedPropertyValue | undefined

getPropertyDefinitions()

返回 DataSource 将提供的所有属性定义。

getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;

ReadonlyArray<IDynamicDataPropertyDefinition>

getPropertyValue(propertyId)

给定属性 ID，返回属性的值。

getPropertyValue(propertyId: string): any;

参数

propertyId: string

any

注解

假定此函数返回数组时，它是同质的。

sendEvent(eventName, data)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

如果已定义，则使用者能够将数据发送到关联的动态数据源。然后，源可以采取相应的措施。

当在“eventName”中传递的不是源上允许的事件之一时，调用此 API 会引发错误。

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

参数

eventName: string

表示事件名称的区分大小写的字符串。

data: any

要发送到动态数据源的数据。

void

通过