DynamicDataProvider class

Paket:

@microsoft/sp-component-base

Der dynamische Datenanbieter ermöglicht Komponenten die Nutzung dynamischer Daten. Es ermöglicht Komponenten, dynamische Datenquellen anzufordern und die Registrierung für diese zu registrieren/aufzuheben.

Eigenschaften

isDisposed

Gibt true zurück, wenn der dynamische Datenanbieter verworfen wird.

Methoden

dispose()	Löscht den dynamischen Datenanbieter.
getAvailableSources()	Gibt eine Liste mit allen verfügbaren dynamischen Datenquellen zurück.
registerAvailableSourcesChanged(callback)	Registriert einen Rückruf für ein Ereignis, das ausgelöst wird, wenn die Liste der verfügbaren dynamischen Datenquellen aktualisiert wird.
registerPropertyChanged(sourceId, propertyId, callback)	Registriert einen Rückruf für Updates, wenn eine Eigenschaft in einer dynamischen Datenquelle geändert wird.
registerSourceChanged(sourceId, callback)	Registriert einen Rückruf für Updates, wenn eine dynamische Datenquelle geändert wird. Dies geschieht, wenn eine Eigenschaft innerhalb der Quelle aktualisiert wird.
tryGetSource(id)	Gibt eine dynamische Datenquelle anhand ihrer ID zurück. Wenn die Quelle nicht vorhanden ist, wird undefiniert zurückgegeben.
unregisterAvailableSourcesChanged(callback)	Hebt die Registrierung eines Rückrufs für ein Ereignis auf, das ausgelöst wird, wenn die Liste der verfügbaren dynamischen Datenquellen aktualisiert wird.
unregisterPropertyChanged(sourceId, propertyId, callback)	Hebt die Registrierung eines Rückrufs für Updates auf, wenn eine Eigenschaft in einer dynamischen Datenquelle geändert wird.
unregisterSourceChanged(sourceId, callback)	Hebt die Registrierung eines Rückrufs für Updates auf, wenn eine dynamische Datenquelle geändert wird.

Details zur Eigenschaft

isDisposed

Gibt true zurück, wenn der dynamische Datenanbieter verworfen wird.

get isDisposed(): boolean;

Eigenschaftswert

boolean

Details zur Methode

dispose()

Löscht den dynamischen Datenanbieter.

dispose(): void;

Gibt zurück

void

getAvailableSources()

Gibt eine Liste mit allen verfügbaren dynamischen Datenquellen zurück.

getAvailableSources(): ReadonlyArray<IDynamicDataSource>;

Gibt zurück

ReadonlyArray<IDynamicDataSource>

Schreibgeschütztes Array mit allen verfügbaren Quellen.

registerAvailableSourcesChanged(callback)

Registriert einen Rückruf für ein Ereignis, das ausgelöst wird, wenn die Liste der verfügbaren dynamischen Datenquellen aktualisiert wird.

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

Parameter

callback

() => void

Funktion, die ausgeführt werden soll, wenn die Quellen aktualisiert werden.

Gibt zurück

void

registerPropertyChanged(sourceId, propertyId, callback)

Registriert einen Rückruf für Updates, wenn eine Eigenschaft in einer dynamischen Datenquelle geändert wird.

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

Parameter

sourceId

string

ID der dynamischen Datenquelle.

propertyId

string

ID der -Eigenschaft der Quelle.

callback

() => void

Funktion, die ausgeführt werden soll, wenn die Quelle ihre Daten aktualisiert.

Gibt zurück

void

registerSourceChanged(sourceId, callback)

Registriert einen Rückruf für Updates, wenn eine dynamische Datenquelle geändert wird. Dies geschieht, wenn eine Eigenschaft innerhalb der Quelle aktualisiert wird.

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

Parameter

sourceId

string

ID der dynamischen Datenquelle.

callback

() => void

Funktion, die ausgeführt werden soll, wenn die Quelle ihre Daten aktualisiert.

Gibt zurück

void

tryGetSource(id)

Gibt eine dynamische Datenquelle anhand ihrer ID zurück. Wenn die Quelle nicht vorhanden ist, wird undefiniert zurückgegeben.

tryGetSource(id: string): IDynamicDataSource | undefined;

Parameter

id

string

ID der dynamischen Datenquelle.

Gibt zurück

IDynamicDataSource | undefined

unregisterAvailableSourcesChanged(callback)

Hebt die Registrierung eines Rückrufs für ein Ereignis auf, das ausgelöst wird, wenn die Liste der verfügbaren dynamischen Datenquellen aktualisiert wird.

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

Parameter

callback

() => void

Funktion, die aus der Registrierung entfernt werden soll. Muss identisch sein, bei dem es registriert wurde.

Gibt zurück

void

unregisterPropertyChanged(sourceId, propertyId, callback)

Hebt die Registrierung eines Rückrufs für Updates auf, wenn eine Eigenschaft in einer dynamischen Datenquelle geändert wird.

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

Parameter

sourceId

string

ID der dynamischen Datenquelle.

propertyId

string

ID der -Eigenschaft der Quelle.

callback

() => void

Funktion, die aus der Registrierung entfernt werden soll. Muss identisch sein, bei dem es registriert wurde.

Gibt zurück

void

unregisterSourceChanged(sourceId, callback)

Hebt die Registrierung eines Rückrufs für Updates auf, wenn eine dynamische Datenquelle geändert wird.

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

Parameter

sourceId

string

ID der dynamischen Datenquelle.

callback

() => void

Funktion, die aus der Registrierung entfernt werden soll. Muss identisch sein, bei dem es registriert wurde.

Gibt zurück

void