Sdílet prostřednictvím

VisualDescriptor class

  • Reference
Balíček:
powerbi-client

Vizuál Power BI na stránce

Vlastnosti

layout

Rozložení vizuálu: pozice, velikost a viditelnost.
name

Název vizuálu
page

Nadřazená stránka Power BI, která obsahuje tento vizuál
title

Název vizuálu
type

Typ vizuálu

Metody

clone(ICloneVisualRequest)

Klonování existujícího vizuálu do nové instance
exportData(ExportDataType, number)

Exportuje data vizuálu. Může exportovat až 30 tisíc řádků.
getFilters()

Získá všechny filtry na úrovni vizuálu aktuálního vizuálu.

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

Získání stavu průřezu Funguje jenom pro vizuály průřezu typu.

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

Získání přehledů pro jeden vizuál

visual.getSmartNarrativeInsights();
moveVisual(number, number, number)

Aktualizace pozici vizuálu.

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

Odebere z aktuálního vizuálu všechny filtry.

visual.removeFilters();
resizeVisual(number, number)

Změna velikosti vizuálu

visual.resizeVisual(width, height)
  .catch(error => { ... });
setFilters(IFilter[])

Nastaví filtry v aktuálním vizuálu na filtry.

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

Nastavte stav průřezu. Funguje jenom pro vizuály průřezu typu.
setVisualDisplayState(VisualContainerDisplayMode)

Aktualizace stav zobrazení vizuálu.

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

Seřaďte vizuál podle dataField a směru.
updateFilters(FiltersOperations, IFilter[])

Aktualizujte filtry pro aktuální vizuál podle operace: Přidat, nahradit vše, nahradit cílem nebo odebrat.

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

Podrobnosti vlastnosti

layout

Rozložení vizuálu: pozice, velikost a viditelnost.

layout: IVisualLayout

Hodnota vlastnosti

IVisualLayout

name

Název vizuálu

name: string

Hodnota vlastnosti

string

page

Nadřazená stránka Power BI, která obsahuje tento vizuál

page: IPageNode

Hodnota vlastnosti

IPageNode

title

Název vizuálu

title: string

Hodnota vlastnosti

string

type

Typ vizuálu

type: string

Hodnota vlastnosti

string

Podrobnosti metody

clone(ICloneVisualRequest)

Klonování existujícího vizuálu do nové instance

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

Parametry

request
ICloneVisualRequest

Návraty

Promise<ICloneVisualResponse>

exportData(ExportDataType, number)

Exportuje data vizuálu. Může exportovat až 30 tisíc řádků.

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

Parametry

exportDataType
ExportDataType
rows

number

Návraty

Promise<IExportDataResult>

getFilters()

Získá všechny filtry na úrovni vizuálu aktuálního vizuálu.

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

function getFilters(): Promise<IFilter[]>

Návraty

Promise<IFilter[]>

getSlicerState()

Získání stavu průřezu Funguje jenom pro vizuály průřezu typu.

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

function getSlicerState(): Promise<ISlicerState>

Návraty

Promise<ISlicerState>

getSmartNarrativeInsights()

Získání přehledů pro jeden vizuál

visual.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Návraty

Promise<ISmartNarratives>

moveVisual(number, number, number)

Aktualizace pozici vizuálu.

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

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

Parametry

x

number

y

number

z

number

Návraty

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Odebere z aktuálního vizuálu všechny filtry.

visual.removeFilters();

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

Návraty

Promise<IHttpPostMessageResponse<void>>

resizeVisual(number, number)

Změna velikosti vizuálu

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

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

Parametry

width

number

height

number

Návraty

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Nastaví filtry v aktuálním vizuálu na filtry.

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

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

Parametry

filters

IFilter[]

Návraty

Promise<IHttpPostMessageResponse<void>>

setSlicerState(ISlicerState)

Nastavte stav průřezu. Funguje jenom pro vizuály průřezu typu.

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

Parametry

state
ISlicerState

Návraty

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(VisualContainerDisplayMode)

Aktualizace stav zobrazení vizuálu.

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

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

Parametry

displayState
VisualContainerDisplayMode

Návraty

Promise<IHttpPostMessageResponse<void>>

sortBy(ISortByVisualRequest)

Seřaďte vizuál podle dataField a směru.

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

Parametry

request
ISortByVisualRequest

Návraty

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Aktualizujte filtry pro aktuální vizuál podle operace: Přidat, nahradit vše, nahradit cílem nebo odebrat.

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

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

Parametry

operation
FiltersOperations
filters

IFilter[]

Návraty

Promise<IHttpPostMessageResponse<void>>