DynamicDataSourceManager class

Package:

@microsoft/sp-component-base

The Dynamic Data Source Manager is responsible for: - Constructing the dynamic data source - Allowing initialization of the dynamic data source by a component - Allowing data source to update its metadata and notify when data has been updated.

Properties

isDisposed	Returns true if the DynamicDataSourceManager is disposed.
sourceId	Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it returns an empty string.

Methods

dispose()	Disposes the resources held by the Dynamic Data source.
initializeSource(callableFunctions)	Initializes the Dynamic Data Source for the component.
notifyPropertyChanged(propertyId)	Notifies that this source has updated a specific property. When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source.
notifySourceChanged()	Notifies that this source has updated its properties. When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source.
updateMetadata(metadata)	Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated.

Property Details

isDisposed

Returns true if the DynamicDataSourceManager is disposed.

get isDisposed(): boolean;

Property Value

boolean

sourceId

Returns the Id of the current DataSource. If the component did not initialize as a dynamic data source, then it returns an empty string.

get sourceId(): string;

Property Value

string

Method Details

dispose()

Disposes the resources held by the Dynamic Data source.

dispose(): void;

Returns

void

initializeSource(callableFunctions)

Initializes the Dynamic Data Source for the component.

initializeSource(callableFunctions: IDynamicDataCallables): void;

Parameters

callableFunctions

IDynamicDataCallables

Set of methods that are exposed through the Dynamic Data Source

Returns

void

notifyPropertyChanged(propertyId)

Notifies that this source has updated a specific property.

When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source.

notifyPropertyChanged(propertyId: string): void;

Parameters

propertyId

string

Id of the updated property in the source.

Returns

void

notifySourceChanged()

Notifies that this source has updated its properties.

When invoked, it enables to broadcast the notification to all the consumers who have registered to this notification from this source.

notifySourceChanged(): void;

Returns

void

updateMetadata(metadata)

Updates the metadata of the Dynamic Data Source. It allows to update fields like title or description. Auto-generated fields like alias, componentId or instanceId cannot be updated.

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

Parameters

metadata

Partial<IDynamicDataSourceMetadata>

Partial of the metadata.

Returns

void