本文介绍如何获取和设置分配给数据角色的视觉数据字段的显示名称。 更改视觉对象数据字段的显示名称的功能对于将报表上的数据字段名称显示为列标题的视觉对象非常有用。 例如,表和矩阵视觉对象。
获取显示名称
若要获取视觉对象数据字段的显示名称,请调用视觉对象的 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');