VisualDescriptor class
ページ内の Power BI ビジュアル
プロパティ
layout | 視覚的なレイアウト: 位置、サイズ、可視性。 |
name | ビジュアル名 |
page | このビジュアルを含む親 Power BI ページ |
title | ビジュアル タイトル |
type | ビジュアルの種類 |
メソッド
clone(IClone |
既存のビジュアルを新しいインスタンスに複製します。 |
export |
ビジュアル データをエクスポートします。 最大 30,000 行をエクスポートできます。 |
get |
現在のビジュアルのすべてのビジュアル レベル フィルターを取得します。
|
get |
スライサーの状態を取得します。 スライサー型のビジュアルに対してのみ機能します。
|
get |
1 つのビジュアルの分析情報を取得する
|
move |
ビジュアルの位置を更新します。
|
remove |
現在のビジュアルからすべてのフィルターを削除します。
|
resize |
ビジュアルのサイズを変更します。
|
set |
現在のビジュアルのフィルターを 'filters' に設定します。
|
set |
スライサーの状態を設定します。 スライサー型のビジュアルに対してのみ機能します。 |
set |
ビジュアルの表示状態を更新します。
|
sort |
dataField と方向でビジュアルを並べ替えます。 |
update |
操作に従って、現在のビジュアルのフィルターを更新します。追加、すべて置換、ターゲットで置き換えるか、削除します。
|
プロパティの詳細
layout
name
ビジュアル名
name: string
プロパティ値
string
page
title
ビジュアル タイトル
title: string
プロパティ値
string
type
ビジュアルの種類
type: string
プロパティ値
string
メソッドの詳細
clone(ICloneVisualRequest)
既存のビジュアルを新しいインスタンスに複製します。
function clone(request?: ICloneVisualRequest): Promise<ICloneVisualResponse>
パラメーター
- request
- ICloneVisualRequest
戻り値
Promise<ICloneVisualResponse>
exportData(ExportDataType, number)
ビジュアル データをエクスポートします。 最大 30,000 行をエクスポートできます。
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()
1 つのビジュアルの分析情報を取得する
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[])
現在のビジュアルのフィルターを 'filters' に設定します。
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>>