Compartilhar via


Configurar o nome de exibição de um campo de dados visual

Este artigo descreve como obter e definir o nome de exibição de um campo de dados visual atribuído a uma função de dados. A capacidade de alterar os nomes de exibição de campos de dados visuais é útil para visuais que exibem nomes de campo de dados em relatórios como cabeçalhos de coluna. Por exemplo, visuais de tabela e matriz.

Obter o nome de exibição

Para obter o nome de exibição de um campo de dados visuais, chame o método getDataFieldDisplayName do visual.

getDataFieldDisplayName(dataRole: string, index: number): Promise<string>

Esse método tem as seguintes variáveis:

  • dataRole - O nome da função de dados de destino à qual o campo de dados é atribuído.
  • index - O índice do campo de dados cujo nome de exibição é lido.

Por exemplo:

let dataFieldDisplayName = visual.getDataFieldDisplayName('Category', 1);

Para obter informações sobre o método getDataFields, consulte Configurar campos de dados. Para obter informações sobre o método getCapabilities, consulte Obter os recursos de umvisual.

Definir o nome de exibição

Para definir o nome de exibição de um campo de dados visual, chame o método setDataFieldDisplayName do visual.

setDataFieldDisplayName(dataRole: string, index: number, newDisplayName: string): Promise<IError>

Esse método tem as seguintes variáveis:

  • dataRole - O nome da função de dados de destino à qual o campo de dados é atribuído.
  • index - O índice do campo de dados cujo nome de exibição deve ser renomeado.
  • newDisplayName - O novo nome de exibição do campo de dados.

Por exemplo:

await visual.setDataFieldDisplayName('Category', 1, 'New Display Name');