@microsoft/sp-dynamic-data package

SharePoint Framework support for dynamic data bindings.

Classes

DynamicDataReference

Class that contains the Dynamic Data reference. This includes the source, property, and property path (if applicable) of Dynamic Data

Interfaces

IDynamicDataAnnotatedPropertyValue

Describes the value and the structure of a property value. It contains sample value of the property and the metadata describing the structure of that value.

IDynamicDataCallables

Interface for components to implement in order to be dynamic data sources. This can be implemented as an object with state, or a set of loose functions that returns the data.

IDynamicDataEventDefinition

Definition of an event which a dynamic data source accepts.

It includes the name of the event and description to be seen and used by end users.

IDynamicDataPropertyDefinition

Definition of a property. It includes the id of the property to be used with the APIs, along with a user-friendly, localized title and description to be seen and used by end users.

IDynamicDataPropertyMetadata

Metadata of a property

IDynamicDataPropertyValueMetadata

Metadata describing the sample value of the property.

IDynamicDataPropertyValueMetadataCollection

A collection of key value pairs, where 'key' is one of the keys from the property value object and 'value' is the metadata describing the 'key' and its value.

IDynamicDataSource

Dynamic Data Sources provide Dynamic Data to consumers. They offer metadata to identify the data sources and API to get the data.

IDynamicDataSourceMetadata

Metadata of the Dynamic Data Source. It allows consumers to easily distinguish Dynamic Data Sources.