Настройка отображаемого имени поля визуальных данных

В этой статье описывается, как получить и задать отображаемое имя поля визуальных данных, назначенного роли данных. Возможность изменять отображаемые имена полей визуальных данных полезна для визуальных элементов, которые отображают имена полей данных в отчетах в виде заголовков столбцов. Например, визуальные элементы таблицы и матрицы.

Получение отображаемого имени

Чтобы получить отображаемое имя поля визуальных данных, вызовите метод getDataFieldDisplayName визуального элемента.

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

Этот метод имеет следующие переменные:

  • dataRole — имя целевой роли данных, которой назначается поле данных.
  • index — индекс поля данных, отображаемое имя которого считывается.

Например:

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

Сведения о методе getDataFields см. в разделе Настройка полей данных. Сведения о методе getCapabilities см. в статье Получение возможностей визуального.

Задание отображаемого имени

Чтобы задать отображаемое имя поля визуальных данных, вызовите метод setDataFieldDisplayName визуального элемента.

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

Этот метод имеет следующие переменные:

  • dataRole — имя целевой роли данных, которой назначается поле данных.
  • index — индекс поля данных, отображаемое имя которого должно быть переименовано.
  • newDisplayName — новое отображаемое имя поля данных.

Например:

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

Связанное содержимое

  • Last updated on