Compartilhar via

DynamicDataProvider class

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

O Fornecedor de Dados Dinâmicos permite que os componentes consumam Dados Dinâmicos. Permite que os componentes solicitem origens de Dados Dinâmicos e registem/anulem o registo dessas origens.

Propriedades

isDisposed

Devolve true se o Fornecedor de Dados Dinâmicos for eliminado.

Métodos

dispose()

Elimina o Fornecedor de Dados Dinâmicos.
getAvailableSources()

Devolve uma lista com todas as Origens de Dados Dinâmicas disponíveis.
registerAvailableSourcesChanged(callback)

Regista uma chamada de retorno para um evento que gera quando a lista de Origens de Dados Dinâmicas disponíveis é atualizada.
registerPropertyChanged(sourceId, propertyId, callback)

Regista uma chamada de retorno para atualizações quando uma propriedade é alterada numa origem de Dados Dinâmicos.
registerSourceChanged(sourceId, callback)

Regista uma chamada de retorno para atualizações quando uma origem de Dados Dinâmicos é alterada. Isto acontece quando qualquer propriedade é atualizada na origem.
tryGetSource(id)

Devolve uma Origem de Dados Dinâmica, pelo respetivo ID. Se a origem não estiver presente, devolve indefinido.
unregisterAvailableSourcesChanged(callback)

Anula o registo de uma chamada de retorno para um evento que é gerado quando a lista de Origens de Dados Dinâmicas disponíveis é atualizada.
unregisterPropertyChanged(sourceId, propertyId, callback)

Anule o registo de uma chamada de retorno para atualizações quando uma propriedade é alterada numa origem de Dados Dinâmicos.
unregisterSourceChanged(sourceId, callback)

Anule o registo de uma chamada de retorno para atualizações quando uma origem de Dados Dinâmicos é alterada.

Detalhes da propriedade

isDisposed

Devolve true se o Fornecedor de Dados Dinâmicos for eliminado.

get isDisposed(): boolean;

Valor da propriedade

boolean

Detalhes do método

dispose()

Elimina o Fornecedor de Dados Dinâmicos.

dispose(): void;

Retornos

void

getAvailableSources()

Devolve uma lista com todas as Origens de Dados Dinâmicas disponíveis.

getAvailableSources(): ReadonlyArray<IDynamicDataSource>;

Retornos

ReadonlyArray<IDynamicDataSource>

Matriz só de leitura com todas as origens disponíveis.

registerAvailableSourcesChanged(callback)

Regista uma chamada de retorno para um evento que gera quando a lista de Origens de Dados Dinâmicas disponíveis é atualizada.

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

Parâmetros

callback

() => void

Função a executar quando as origens são atualizadas.

Retornos

void

registerPropertyChanged(sourceId, propertyId, callback)

Regista uma chamada de retorno para atualizações quando uma propriedade é alterada numa origem de Dados Dinâmicos.

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

Parâmetros

sourceId

string

ID da Origem de Dados Dinâmica.

propertyId

string

ID da propriedade da origem.

callback

() => void

Função a executar quando a origem atualizar os respetivos dados.

Retornos

void

registerSourceChanged(sourceId, callback)

Regista uma chamada de retorno para atualizações quando uma origem de Dados Dinâmicos é alterada. Isto acontece quando qualquer propriedade é atualizada na origem.

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

Parâmetros

sourceId

string

ID da Origem de Dados Dinâmica.

callback

() => void

Função a executar quando a origem atualizar os respetivos dados.

Retornos

void

tryGetSource(id)

Devolve uma Origem de Dados Dinâmica, pelo respetivo ID. Se a origem não estiver presente, devolve indefinido.

tryGetSource(id: string): IDynamicDataSource | undefined;

Parâmetros

id

string

ID da Origem de Dados Dinâmica.

Retornos

IDynamicDataSource | undefined

unregisterAvailableSourcesChanged(callback)

Anula o registo de uma chamada de retorno para um evento que é gerado quando a lista de Origens de Dados Dinâmicas disponíveis é atualizada.

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

Parâmetros

callback

() => void

Função a remover do registo. Tem de ser o mesmo em que foi registado.

Retornos

void

unregisterPropertyChanged(sourceId, propertyId, callback)

Anule o registo de uma chamada de retorno para atualizações quando uma propriedade é alterada numa origem de Dados Dinâmicos.

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

Parâmetros

sourceId

string

ID da Origem de Dados Dinâmica.

propertyId

string

ID da propriedade da origem.

callback

() => void

Função a remover do registo. Tem de ser o mesmo em que foi registado.

Retornos

void

unregisterSourceChanged(sourceId, callback)

Anule o registo de uma chamada de retorno para atualizações quando uma origem de Dados Dinâmicos é alterada.

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

Parâmetros

sourceId

string

ID da Origem de Dados Dinâmica.

callback

() => void

Função a remover do registo. Tem de ser o mesmo em que foi registado.

Retornos

void