Partager via

DynamicDataProvider class

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

Le fournisseur de données dynamiques permet aux composants de consommer des données dynamiques. Il permet aux composants de demander des sources de données dynamiques et de s’inscrire/annuler leur inscription.

Propriétés

isDisposed

Retourne true si le fournisseur de données dynamiques est supprimé.

Méthodes

dispose()

Supprime le fournisseur de données dynamiques.
getAvailableSources()

Retourne une liste avec toutes les sources de données dynamiques disponibles.
registerAvailableSourcesChanged(callback)

Inscrit un rappel à un événement qui se déclenche lorsque la liste des sources de données dynamiques disponibles est mise à jour.
registerPropertyChanged(sourceId, propertyId, callback)

Inscrit un rappel pour les mises à jour lorsqu’une propriété est modifiée dans une source de données dynamiques.
registerSourceChanged(sourceId, callback)

Inscrit un rappel pour les mises à jour lorsqu’une source de données dynamiques est modifiée. Cela se produit lorsqu’une propriété est mise à jour dans la source.
tryGetSource(id)

Retourne une source de données dynamique, par son ID. Si la source n’est pas présente, elle retourne undefined.
unregisterAvailableSourcesChanged(callback)

Annule l’inscription d’un rappel à un événement qui se déclenche lorsque la liste des sources de données dynamiques disponibles est mise à jour.
unregisterPropertyChanged(sourceId, propertyId, callback)

Annule l’inscription d’un rappel pour les mises à jour lorsqu’une propriété est modifiée dans une source de données dynamiques.
unregisterSourceChanged(sourceId, callback)

Annule l’inscription d’un rappel pour les mises à jour lorsqu’une source de données dynamiques est modifiée.

Détails de la propriété

isDisposed

Retourne true si le fournisseur de données dynamiques est supprimé.

get isDisposed(): boolean;

Valeur de propriété

boolean

Détails de la méthode

dispose()

Supprime le fournisseur de données dynamiques.

dispose(): void;

Retours

void

getAvailableSources()

Retourne une liste avec toutes les sources de données dynamiques disponibles.

getAvailableSources(): ReadonlyArray<IDynamicDataSource>;

Retours

ReadonlyArray<IDynamicDataSource>

Tableau en lecture seule avec toutes les sources disponibles.

registerAvailableSourcesChanged(callback)

Inscrit un rappel à un événement qui se déclenche lorsque la liste des sources de données dynamiques disponibles est mise à jour.

registerAvailableSourcesChanged(callback: () => void): void;

Paramètres

callback

() => void

Fonction à exécuter lorsque les sources sont mises à jour.

Retours

void

registerPropertyChanged(sourceId, propertyId, callback)

Inscrit un rappel pour les mises à jour lorsqu’une propriété est modifiée dans une source de données dynamiques.

registerPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;

Paramètres

sourceId

string

ID de la source de données dynamique.

propertyId

string

ID de la propriété de la source.

callback

() => void

Fonction à exécuter lorsque la source met à jour ses données.

Retours

void

registerSourceChanged(sourceId, callback)

Inscrit un rappel pour les mises à jour lorsqu’une source de données dynamiques est modifiée. Cela se produit lorsqu’une propriété est mise à jour dans la source.

registerSourceChanged(sourceId: string, callback: () => void): void;

Paramètres

sourceId

string

ID de la source de données dynamique.

callback

() => void

Fonction à exécuter lorsque la source met à jour ses données.

Retours

void

tryGetSource(id)

Retourne une source de données dynamique, par son ID. Si la source n’est pas présente, elle retourne undefined.

tryGetSource(id: string): IDynamicDataSource | undefined;

Paramètres

id

string

ID de la source de données dynamique.

Retours

IDynamicDataSource | undefined

unregisterAvailableSourcesChanged(callback)

Annule l’inscription d’un rappel à un événement qui se déclenche lorsque la liste des sources de données dynamiques disponibles est mise à jour.

unregisterAvailableSourcesChanged(callback: () => void): void;

Paramètres

callback

() => void

Fonction à supprimer de l’inscription. Doit être la même que celle avec laquelle il a été inscrit.

Retours

void

unregisterPropertyChanged(sourceId, propertyId, callback)

Annule l’inscription d’un rappel pour les mises à jour lorsqu’une propriété est modifiée dans une source de données dynamiques.

unregisterPropertyChanged(sourceId: string, propertyId: string, callback: () => void): void;

Paramètres

sourceId

string

ID de la source de données dynamique.

propertyId

string

ID de la propriété de la source.

callback

() => void

Fonction à supprimer de l’inscription. Doit être la même que celle avec laquelle il a été inscrit.

Retours

void

unregisterSourceChanged(sourceId, callback)

Annule l’inscription d’un rappel pour les mises à jour lorsqu’une source de données dynamiques est modifiée.

unregisterSourceChanged(sourceId: string, callback: () => void): void;

Paramètres

sourceId

string

ID de la source de données dynamique.

callback

() => void

Fonction à supprimer de l’inscription. Doit être la même que celle avec laquelle il a été inscrit.

Retours

void