Konfigurowanie nazwy wyświetlanej pola danych wizualizacji

W tym artykule opisano sposób pobierania i ustawiania nazwy wyświetlanego pola danych wizualizacji przypisanego do roli danych. Możliwość zmiany nazw wyświetlanych pól danych wizualizacji jest przydatna w przypadku wizualizacji, które wyświetlają nazwy pól danych w raportach jako nagłówki kolumn. Na przykład wizualizacje tabel i macierzy.

Pobieranie nazwy wyświetlanej

Aby uzyskać nazwę wyświetlaną pola danych wizualizacji, wywołaj metodę getDataFieldDisplayName wizualizacji.

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

Ta metoda ma następujące zmienne:

  • dataRole — nazwa roli danych docelowych, do której przypisano pole danych.
  • index — indeks pola danych, którego nazwa wyświetlana jest odczytywana.

Na przykład:

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

Aby uzyskać informacje o metodzie getDataFields, zobacz Konfigurowanie pól danych. Aby uzyskać informacje o metodzie getCapabilities, zobacz Uzyskiwanie możliwości wizualizacji.

Ustawianie nazwy wyświetlanej

Aby ustawić nazwę wyświetlaną pola danych wizualizacji, wywołaj metodę setDataFieldDisplayName wizualizacji.

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

Ta metoda ma następujące zmienne:

  • dataRole — nazwa roli danych docelowych, do której przypisano pole danych.
  • index — indeks pola danych, którego nazwa wyświetlana ma zostać zmieniona.
  • newDisplayName — nowa nazwa wyświetlana pola danych.

Na przykład:

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