Compartilhar via

DynamicDataSourceManager class

  • Referência
Pacote:
@microsoft/sp-component-base

O Gestor de Origens de Dados Dinâmico é responsável por: - Construir a origem de dados dinâmica – permitir a inicialização da origem de dados dinâmica por um componente – Permitir que a origem de dados atualize os metadados e notifique quando os dados forem atualizados.

Propriedades

isDisposed

Devolve true se o DynamicDataSourceManager for eliminado.
sourceId

Devolve o ID da DataSource atual. Se o componente não inicializou como uma origem de dados dinâmica, devolve uma cadeia vazia.

Métodos

dispose()

Elimina os recursos detidos pela origem de Dados Dinâmicos.
initializeSource(callableFunctions)

Inicializa a Origem de Dados Dinâmica para o componente.
notifyPropertyChanged(propertyId)

Notifica que esta origem atualizou uma propriedade específica.

Quando invocada, permite difundir a notificação para todos os consumidores que se registaram nesta notificação a partir desta origem.
notifySourceChanged()

Notifica que esta origem atualizou as respetivas propriedades.

Quando invocada, permite difundir a notificação para todos os consumidores que se registaram nesta notificação a partir desta origem.
updateMetadata(metadata)

Atualizações os metadados da Origem de Dados Dinâmica. Permite atualizar campos como o título ou a descrição. Os campos gerados automaticamente, como alias, componentId ou instanceId, não podem ser atualizados.

Detalhes da propriedade

isDisposed

Devolve true se o DynamicDataSourceManager for eliminado.

get isDisposed(): boolean;

Valor da propriedade

boolean

sourceId

Devolve o ID da DataSource atual. Se o componente não inicializou como uma origem de dados dinâmica, devolve uma cadeia vazia.

get sourceId(): string;

Valor da propriedade

string

Detalhes do método

dispose()

Elimina os recursos detidos pela origem de Dados Dinâmicos.

dispose(): void;

Retornos

void

initializeSource(callableFunctions)

Inicializa a Origem de Dados Dinâmica para o componente.

initializeSource(callableFunctions: IDynamicDataCallables): void;

Parâmetros

callableFunctions
IDynamicDataCallables

Conjunto de métodos que são expostos através da Origem de Dados Dinâmica

Retornos

void

notifyPropertyChanged(propertyId)

Notifica que esta origem atualizou uma propriedade específica.

Quando invocada, permite difundir a notificação para todos os consumidores que se registaram nesta notificação a partir desta origem.

notifyPropertyChanged(propertyId: string): void;

Parâmetros

propertyId

string

ID da propriedade atualizada na origem.

Retornos

void

notifySourceChanged()

Notifica que esta origem atualizou as respetivas propriedades.

Quando invocada, permite difundir a notificação para todos os consumidores que se registaram nesta notificação a partir desta origem.

notifySourceChanged(): void;

Retornos

void

updateMetadata(metadata)

Atualizações os metadados da Origem de Dados Dinâmica. Permite atualizar campos como o título ou a descrição. Os campos gerados automaticamente, como alias, componentId ou instanceId, não podem ser atualizados.

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

Parâmetros

metadata

Partial<IDynamicDataSourceMetadata>

Parcial dos metadados.

Retornos

void