sp component base.dynamicdataprovider

Home > @microsoft/sp-component-base > DynamicDataProvider

DynamicDataProvider class

The Dynamic Data Provider allows components to consume Dynamic Data. It allows components to request Dynamic Data sources and register/unregister to those.

Signature:

export default class DynamicDataProvider implements IDisposable

Implements: IDisposable

Properties

Property	Modifiers	Type	Description
isDisposed		boolean	Returns true if the Dynamic Data Provider is disposed.

Methods

Method	Modifiers	Description
dispose()		Disposes the Dynamic Data Provider.
getAvailableSources()		Returns a list with all available Dynamic Data Sources.
registerAvailableSourcesChanged(callback)		Registers a callback to an event that raises when the list of available Dynamic Data Sources is updated.
registerPropertyChanged(sourceId, propertyId, callback)		Registers a callback for updates when a property is changed in a Dynamic Data source.
registerSourceChanged(sourceId, callback)		Registers a callback for updates when a Dynamic Data source is changed. This happens when any property is updated within the source.
tryGetSource(id)		Returns a Dynamic Data Source, by its id. If the source is not present, it returns undefined.
unregisterAvailableSourcesChanged(callback)		Unregisters a callback to an event that raises when the list of available Dynamic Data Sources is updated.
unregisterPropertyChanged(sourceId, propertyId, callback)		Unregisters a callback for updates when a property is changed in a Dynamic Data source.
unregisterSourceChanged(sourceId, callback)		Unregisters a callback for updates when a Dynamic Data source is changed.