Freigeben über

VisualDescriptor class

  • Referenz
Paket:
powerbi-client

Ein Visuelles Power BI-Element auf einer Seite

Eigenschaften

layout

Das visuelle Layout: Position, Größe und Sichtbarkeit.
name

Der visuelle Name
page

Die übergeordnete Power BI-Seite, die dieses visuelle Element enthält
title

Der visuelle Titel
type

Der visuelle Typ

Methoden

clone(ICloneVisualRequest)

Klonen Sie vorhandene visuelle Elemente in eine neue Instanz.
exportData(ExportDataType, number)

Exportiert visuelle Daten. Kann bis zu 30K-Zeilen exportieren.
getFilters()

Ruft alle Filter auf visueller Ebene des aktuellen visuellen Elements ab.

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

Rufen Sie den Datenschnittstatus ab. Funktioniert nur für visuelle Elemente des Typschnitts.

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

Abrufen von Einblicken für einzelne visuelle Elemente

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

Aktualisiert die Position eines visuellen Elements.

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

Entfernt alle Filter aus dem aktuellen visuellen Element.

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

Ändern Sie die Größe eines visuellen Elements.

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

Legt die Filter für das aktuelle visuelle Element auf "Filter" fest.

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

Legen Sie den Datenschnittstatus fest. Funktioniert nur für visuelle Elemente des Typschnitts.
setVisualDisplayState(VisualContainerDisplayMode)

Aktualisiert den Anzeigezustand eines visuellen Elements.

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

Sortieren Sie ein visuelles Element nach DataField und Richtung.
updateFilters(FiltersOperations, IFilter[])

Aktualisieren Sie die Filter für das aktuelle visuelle Element gemäß dem Vorgang: Hinzufügen, Ersetzen aller, Ersetzen durch Ziel oder Entfernen.

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

Details zur Eigenschaft

layout

Das visuelle Layout: Position, Größe und Sichtbarkeit.

layout: IVisualLayout

Eigenschaftswert

IVisualLayout

name

Der visuelle Name

name: string

Eigenschaftswert

string

page

Die übergeordnete Power BI-Seite, die dieses visuelle Element enthält

page: IPageNode

Eigenschaftswert

IPageNode

title

Der visuelle Titel

title: string

Eigenschaftswert

string

type

Der visuelle Typ

type: string

Eigenschaftswert

string

Details zur Methode

clone(ICloneVisualRequest)

Klonen Sie vorhandene visuelle Elemente in eine neue Instanz.

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

Parameter

request
ICloneVisualRequest

Gibt zurück

Promise<ICloneVisualResponse>

exportData(ExportDataType, number)

Exportiert visuelle Daten. Kann bis zu 30K-Zeilen exportieren.

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

Parameter

exportDataType
ExportDataType
rows

number

Gibt zurück

Promise<IExportDataResult>

getFilters()

Ruft alle Filter auf visueller Ebene des aktuellen visuellen Elements ab.

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

function getFilters(): Promise<IFilter[]>

Gibt zurück

Promise<IFilter[]>

getSlicerState()

Rufen Sie den Datenschnittstatus ab. Funktioniert nur für visuelle Elemente des Typschnitts.

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

function getSlicerState(): Promise<ISlicerState>

Gibt zurück

Promise<ISlicerState>

getSmartNarrativeInsights()

Abrufen von Einblicken für einzelne visuelle Elemente

visual.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Gibt zurück

Promise<ISmartNarratives>

moveVisual(number, number, number)

Aktualisiert die Position eines visuellen Elements.

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

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

Parameter

x

number

y

number

z

number

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Entfernt alle Filter aus dem aktuellen visuellen Element.

visual.removeFilters();

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

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

resizeVisual(number, number)

Ändern Sie die Größe eines visuellen Elements.

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

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

Parameter

width

number

height

number

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Legt die Filter für das aktuelle visuelle Element auf "Filter" fest.

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

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

Parameter

filters

IFilter[]

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

setSlicerState(ISlicerState)

Legen Sie den Datenschnittstatus fest. Funktioniert nur für visuelle Elemente des Typschnitts.

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

Parameter

state
ISlicerState

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(VisualContainerDisplayMode)

Aktualisiert den Anzeigezustand eines visuellen Elements.

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

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

Parameter

displayState
VisualContainerDisplayMode

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

sortBy(ISortByVisualRequest)

Sortieren Sie ein visuelles Element nach DataField und Richtung.

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

Parameter

request
ISortByVisualRequest

Gibt zurück

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Aktualisieren Sie die Filter für das aktuelle visuelle Element gemäß dem Vorgang: Hinzufügen, Ersetzen aller, Ersetzen durch Ziel oder Entfernen.

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

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

Parameter

operation
FiltersOperations
filters

IFilter[]

Gibt zurück

Promise<IHttpPostMessageResponse<void>>