Compartilhar via

IDynamicDataCallables interface

  • Referência
Pacote:
@microsoft/sp-dynamic-data

Interface para os componentes implementarem para serem origens de dados dinâmicas. Isto pode ser implementado como um objeto com estado ou um conjunto de funções soltas que devolvem os dados.

Métodos

allowedEvents()

Devolve a lista de eventos permitidos na origem de dados dinâmica.

Quando esta função devolve um resultado não vazio, a origem tem de definir a api "sendEvent".

Se esta api não estiver definida ou devolver uma matriz vazia, nenhum consumidor poderá falar com esta origem.
getAnnotatedPropertyValue(propertyId)

Dado um ID de propriedade, devolve o respetivo valor anotado. Se a origem não fornecer o valor anotado, reverterá para o que "getPropertyValue" devolver como o valor de exemplo e os metadados não seriam definidos.
getPropertyDefinitions()

Devolve todas as definições de propriedade que o DataSource irá fornecer.
getPropertyValue(propertyId)

Dado um ID de propriedade, devolve o valor da propriedade .
sendEvent(eventName, data)

Se definido, permite ao consumidor enviar dados para a origem de dados dinâmica associada. Em seguida, a fonte pode agir em conformidade.

Invocar esta api gera um erro quando o "eventName" transmitido não é um dos eventos permitidos na origem.

Detalhes do método

allowedEvents()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Devolve a lista de eventos permitidos na origem de dados dinâmica.

Quando esta função devolve um resultado não vazio, a origem tem de definir a api "sendEvent".

Se esta api não estiver definida ou devolver uma matriz vazia, nenhum consumidor poderá falar com esta origem.

allowedEvents?(): ReadonlyArray<IDynamicDataEventDefinition>;

Retornos

ReadonlyArray<IDynamicDataEventDefinition>

getAnnotatedPropertyValue(propertyId)

Dado um ID de propriedade, devolve o respetivo valor anotado. Se a origem não fornecer o valor anotado, reverterá para o que "getPropertyValue" devolver como o valor de exemplo e os metadados não seriam definidos.

getAnnotatedPropertyValue?(propertyId: string): IDynamicDataAnnotatedPropertyValue | undefined;

Parâmetros

propertyId

string

Um dos IDs de propriedade expostos a partir da origem de dados dinâmica.

Retornos

IDynamicDataAnnotatedPropertyValue | undefined

getPropertyDefinitions()

Devolve todas as definições de propriedade que o DataSource irá fornecer.

getPropertyDefinitions(): ReadonlyArray<IDynamicDataPropertyDefinition>;

Retornos

ReadonlyArray<IDynamicDataPropertyDefinition>

getPropertyValue(propertyId)

Dado um ID de propriedade, devolve o valor da propriedade .

getPropertyValue(propertyId: string): any;

Parâmetros

propertyId

string

Retornos

any

Comentários

Presume-se que, quando esta função devolve uma matriz, é homogénea.

sendEvent(eventName, data)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Se definido, permite ao consumidor enviar dados para a origem de dados dinâmica associada. Em seguida, a fonte pode agir em conformidade.

Invocar esta api gera um erro quando o "eventName" transmitido não é um dos eventos permitidos na origem.

sendEvent?(eventName: string, data: any): void;

Parâmetros

eventName

string

Uma cadeia sensível a maiúsculas e minúsculas que representa o nome do evento.

data

any

Dados a serem enviados para a origem de dados dinâmica.

Retornos

void