VisualDescriptor class

包:

powerbi-client

页面内的 Power BI 视觉对象

属性

layout	视觉对象布局：位置、大小和可见性。
name	视觉对象名称
page	包含此视觉对象的父 Power BI 页面
title	视觉对象标题
type	视觉对象类型

方法

clone(ICloneVisualRequest)	将现有视觉对象克隆到新实例。
exportData(ExportDataType, number)	导出视觉对象数据。 最多可导出 3 万行。
getFilters()	获取当前视觉对象的所有视觉对象级别筛选器。 visual.getFilters() .then(filters => { ... });
getSlicerState()	获取切片器状态。 仅适用于切片器类型的视觉对象。 visual.getSlicerState() .then(state => { ... });
getSmartNarrativeInsights()	获取单个视觉对象的见解 visual.getSmartNarrativeInsights();
moveVisual(number, number, number)	汇报视觉对象的位置。 visual.moveVisual(x, y, z) .catch(error => { ... });
removeFilters()	从当前视觉对象中删除所有筛选器。 visual.removeFilters();
resizeVisual(number, number)	调整视觉对象的大小。 visual.resizeVisual(width, height) .catch(error => { ... });
setFilters(IFilter[])	将当前视觉对象的筛选器设置为“筛选器”。 visual.setFilters(filters); .catch(errors => { ... });
setSlicerState(ISlicerState)	设置切片器状态。 仅适用于切片器类型的视觉对象。
setVisualDisplayState(VisualContainerDisplayMode)	汇报视觉对象的显示状态。 visual.setVisualDisplayState(displayState) .catch(error => { ... });
sortBy(ISortByVisualRequest)	按数据字段和方向对视觉对象进行排序。
updateFilters(FiltersOperations, IFilter[])	根据以下操作更新当前视觉对象的筛选器：添加、全部替换、按目标替换或删除。 visual.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });

属性详细信息

layout

视觉对象布局：位置、大小和可见性。

layout: IVisualLayout

属性值

IVisualLayout

name

视觉对象名称

name: string

属性值

string

page

包含此视觉对象的父 Power BI 页面

page: IPageNode

属性值

IPageNode

title

视觉对象标题

title: string

属性值

string

type

视觉对象类型

type: string

属性值

string

方法详细信息

clone(ICloneVisualRequest)

将现有视觉对象克隆到新实例。

function clone(request?: ICloneVisualRequest): Promise<ICloneVisualResponse>

参数

request

ICloneVisualRequest

返回

Promise<ICloneVisualResponse>

exportData(ExportDataType, number)

导出视觉对象数据。 最多可导出 3 万行。

function exportData(exportDataType?: ExportDataType, rows?: number): Promise<IExportDataResult>

参数

exportDataType

ExportDataType

rows

number

返回

Promise<IExportDataResult>

getFilters()

获取当前视觉对象的所有视觉对象级别筛选器。

visual.getFilters()
 .then(filters => { ... });

function getFilters(): Promise<IFilter[]>

返回

Promise<IFilter[]>

getSlicerState()

获取切片器状态。 仅适用于切片器类型的视觉对象。

visual.getSlicerState()
 .then(state => { ... });

function getSlicerState(): Promise<ISlicerState>

返回

Promise<ISlicerState>

getSmartNarrativeInsights()

获取单个视觉对象的见解

visual.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

返回

Promise<ISmartNarratives>

moveVisual(number, number, number)

汇报视觉对象的位置。

visual.moveVisual(x, y, z)
  .catch(error => { ... });

function moveVisual(x: number, y: number, z?: number): Promise<IHttpPostMessageResponse<void>>

参数

x

number

y

number

z

number

返回

Promise<IHttpPostMessageResponse<void>>

removeFilters()

从当前视觉对象中删除所有筛选器。

visual.removeFilters();

function removeFilters(): Promise<IHttpPostMessageResponse<void>>

返回

Promise<IHttpPostMessageResponse<void>>

resizeVisual(number, number)

调整视觉对象的大小。

visual.resizeVisual(width, height)
  .catch(error => { ... });

function resizeVisual(width: number, height: number): Promise<IHttpPostMessageResponse<void>>

参数

width

number

height

number

返回

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

将当前视觉对象的筛选器设置为“筛选器”。

visual.setFilters(filters);
  .catch(errors => { ... });

function setFilters(filters: IFilter[]): Promise<IHttpPostMessageResponse<void>>

参数

filters

IFilter[]

返回

Promise<IHttpPostMessageResponse<void>>

setSlicerState(ISlicerState)

设置切片器状态。 仅适用于切片器类型的视觉对象。

function setSlicerState(state: ISlicerState): Promise<IHttpPostMessageResponse<void>>

参数

state

ISlicerState

返回

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(VisualContainerDisplayMode)

汇报视觉对象的显示状态。

visual.setVisualDisplayState(displayState)
  .catch(error => { ... });

function setVisualDisplayState(displayState: VisualContainerDisplayMode): Promise<IHttpPostMessageResponse<void>>

参数

displayState

VisualContainerDisplayMode

返回

Promise<IHttpPostMessageResponse<void>>

sortBy(ISortByVisualRequest)

按数据字段和方向对视觉对象进行排序。

function sortBy(request: ISortByVisualRequest): Promise<IHttpPostMessageResponse<void>>

参数

request

ISortByVisualRequest

返回

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

根据以下操作更新当前视觉对象的筛选器：添加、全部替换、按目标替换或删除。

visual.updateFilters(FiltersOperations.Add, filters)
  .catch(errors => { ... });

function updateFilters(operation: FiltersOperations, filters?: IFilter[]): Promise<IHttpPostMessageResponse<void>>

参数

operation

FiltersOperations

filters

IFilter[]

返回

Promise<IHttpPostMessageResponse<void>>