VisualDescriptor class

套件:

powerbi-client

頁面內的Power BI 視覺效果

屬性

layout	視覺效果配置：位置、大小和可見性。
name	視覺效果名稱
page	包含此視覺效果的父Power BI 頁面
title	視覺效果標題
type	視覺效果類型

方法

clone(ICloneVisualRequest)	將現有的視覺效果複製到新的實例。
exportData(ExportDataType, number)	匯出視覺效果數據。 最多可以匯出 30K 個數據列。
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)	依 dataField 和方向排序視覺效果。
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)

匯出視覺效果數據。 最多可以匯出 30K 個數據列。

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)

依 dataField 和方向排序視覺效果。

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>>