Partager via

DynamicDataSourceManager class

  • Référence
Paquet:
@microsoft/sp-component-base

Le Gestionnaire de source de données dynamiques est responsable des opérations suivantes : - Construction de la source de données dynamiques - Autorisation de l’initialisation de la source de données dynamique par un composant - Autorisation à la source de données de mettre à jour ses métadonnées et d’avertir quand les données ont été mises à jour.

Propriétés

isDisposed

Retourne true si DynamicDataSourceManager est supprimé.
sourceId

Retourne l’ID de la source de données actuelle. Si le composant n’a pas été initialisé en tant que source de données dynamique, il retourne une chaîne vide.

Méthodes

dispose()

Supprime les ressources détenues par la source de données dynamiques.
initializeSource(callableFunctions)

Initialise la source de données dynamique pour le composant.
notifyPropertyChanged(propertyId)

Avertit que cette source a mis à jour une propriété spécifique.

Lorsqu’il est appelé, il permet de diffuser la notification à tous les consommateurs qui se sont inscrits à cette notification à partir de cette source.
notifySourceChanged()

Avertit que cette source a mis à jour ses propriétés.

Lorsqu’il est appelé, il permet de diffuser la notification à tous les consommateurs qui se sont inscrits à cette notification à partir de cette source.
updateMetadata(metadata)

Mises à jour les métadonnées de la source de données dynamique. Il permet de mettre à jour des champs tels que titre ou description. Les champs générés automatiquement comme alias, componentId ou instanceId ne peuvent pas être mis à jour.

Détails de la propriété

isDisposed

Retourne true si DynamicDataSourceManager est supprimé.

get isDisposed(): boolean;

Valeur de propriété

boolean

sourceId

Retourne l’ID de la source de données actuelle. Si le composant n’a pas été initialisé en tant que source de données dynamique, il retourne une chaîne vide.

get sourceId(): string;

Valeur de propriété

string

Détails de la méthode

dispose()

Supprime les ressources détenues par la source de données dynamiques.

dispose(): void;

Retours

void

initializeSource(callableFunctions)

Initialise la source de données dynamique pour le composant.

initializeSource(callableFunctions: IDynamicDataCallables): void;

Paramètres

callableFunctions
IDynamicDataCallables

Ensemble de méthodes exposées via la source de données dynamique

Retours

void

notifyPropertyChanged(propertyId)

Avertit que cette source a mis à jour une propriété spécifique.

Lorsqu’il est appelé, il permet de diffuser la notification à tous les consommateurs qui se sont inscrits à cette notification à partir de cette source.

notifyPropertyChanged(propertyId: string): void;

Paramètres

propertyId

string

ID de la propriété mise à jour dans la source.

Retours

void

notifySourceChanged()

Avertit que cette source a mis à jour ses propriétés.

Lorsqu’il est appelé, il permet de diffuser la notification à tous les consommateurs qui se sont inscrits à cette notification à partir de cette source.

notifySourceChanged(): void;

Retours

void

updateMetadata(metadata)

Mises à jour les métadonnées de la source de données dynamique. Il permet de mettre à jour des champs tels que titre ou description. Les champs générés automatiquement comme alias, componentId ou instanceId ne peuvent pas être mis à jour.

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

Paramètres

metadata

Partial<IDynamicDataSourceMetadata>

Partie des métadonnées.

Retours

void