DynamicDataProvider class

Paquete:

@microsoft/sp-component-base

El proveedor de datos dinámicos permite que los componentes consuman datos dinámicos. Permite que los componentes soliciten orígenes de datos dinámicos y los registren o anulen el registro.

Propiedades

isDisposed

Devuelve true si se elimina el proveedor de datos dinámicos.

Métodos

dispose()	Elimina el proveedor de datos dinámico.
getAvailableSources()	Devuelve una lista con todos los orígenes de datos dinámicos disponibles.
registerAvailableSourcesChanged(callback)	Registra una devolución de llamada a un evento que se genera cuando se actualiza la lista de orígenes de datos dinámicos disponibles.
registerPropertyChanged(sourceId, propertyId, callback)	Registra una devolución de llamada para las actualizaciones cuando se cambia una propiedad en un origen de datos dinámico.
registerSourceChanged(sourceId, callback)	Registra una devolución de llamada para las actualizaciones cuando se cambia un origen de datos dinámico. Esto sucede cuando se actualiza cualquier propiedad dentro del origen.
tryGetSource(id)	Devuelve un origen de datos dinámico, por su identificador. Si el origen no está presente, devuelve undefined.
unregisterAvailableSourcesChanged(callback)	Anula el registro de una devolución de llamada a un evento que se genera cuando se actualiza la lista de orígenes de datos dinámicos disponibles.
unregisterPropertyChanged(sourceId, propertyId, callback)	Anula el registro de una devolución de llamada para las actualizaciones cuando se cambia una propiedad en un origen de datos dinámico.
unregisterSourceChanged(sourceId, callback)	Anula el registro de una devolución de llamada para las actualizaciones cuando se cambia un origen de datos dinámico.

Detalles de las propiedades

isDisposed

Devuelve true si se elimina el proveedor de datos dinámicos.

get isDisposed(): boolean;

Valor de propiedad

boolean

Detalles del método

dispose()

Elimina el proveedor de datos dinámico.

dispose(): void;

Devoluciones

void

getAvailableSources()

Devuelve una lista con todos los orígenes de datos dinámicos disponibles.

getAvailableSources(): ReadonlyArray<IDynamicDataSource>;

Devoluciones

ReadonlyArray<IDynamicDataSource>

Matriz de solo lectura con todos los orígenes disponibles.

registerAvailableSourcesChanged(callback)

Registra una devolución de llamada a un evento que se genera cuando se actualiza la lista de orígenes de datos dinámicos disponibles.

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

Parámetros

callback

() => void

Función que se ejecutará cuando se actualicen los orígenes.

Devoluciones

void

registerPropertyChanged(sourceId, propertyId, callback)

Registra una devolución de llamada para las actualizaciones cuando se cambia una propiedad en un origen de datos dinámico.

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

Parámetros

sourceId

string

Identificador del origen de datos dinámico.

propertyId

string

Identificador de la propiedad del origen.

callback

() => void

Función que se ejecutará cuando el origen actualice sus datos.

Devoluciones

void

registerSourceChanged(sourceId, callback)

Registra una devolución de llamada para las actualizaciones cuando se cambia un origen de datos dinámico. Esto sucede cuando se actualiza cualquier propiedad dentro del origen.

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

Parámetros

sourceId

string

Identificador del origen de datos dinámico.

callback

() => void

Función que se ejecutará cuando el origen actualice sus datos.

Devoluciones

void

tryGetSource(id)

Devuelve un origen de datos dinámico, por su identificador. Si el origen no está presente, devuelve undefined.

tryGetSource(id: string): IDynamicDataSource | undefined;

Parámetros

id

string

Identificador del origen de datos dinámico.

Devoluciones

IDynamicDataSource | undefined

unregisterAvailableSourcesChanged(callback)

Anula el registro de una devolución de llamada a un evento que se genera cuando se actualiza la lista de orígenes de datos dinámicos disponibles.

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

Parámetros

callback

() => void

Función que se va a quitar del registro. Debe ser el mismo con el que se registró.

Devoluciones

void

unregisterPropertyChanged(sourceId, propertyId, callback)

Anula el registro de una devolución de llamada para las actualizaciones cuando se cambia una propiedad en un origen de datos dinámico.

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

Parámetros

sourceId

string

Identificador del origen de datos dinámico.

propertyId

string

Identificador de la propiedad del origen.

callback

() => void

Función que se va a quitar del registro. Debe ser el mismo con el que se registró.

Devoluciones

void

unregisterSourceChanged(sourceId, callback)

Anula el registro de una devolución de llamada para las actualizaciones cuando se cambia un origen de datos dinámico.

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

Parámetros

sourceId

string

Identificador del origen de datos dinámico.

callback

() => void

Función que se va a quitar del registro. Debe ser el mismo con el que se registró.

Devoluciones

void