VisualDescriptor class

Pacchetto:

powerbi-client

Oggetto visivo di Power BI all'interno di una pagina

Proprietà

layout	Layout visivo: posizione, dimensioni e visibilità.
name	Nome dell'oggetto visivo
page	Pagina padre di Power BI che contiene questo oggetto visivo
title	Titolo dell'oggetto visivo
type	Tipo di oggetto visivo

Metodi

clone(ICloneVisualRequest)	Clonare un oggetto visivo esistente in una nuova istanza.
exportData(ExportDataType, number)	Esporta i dati visivi. Può esportare fino a 30.000 righe.
getFilters()	Ottiene tutti i filtri a livello di oggetto visivo dell'oggetto visivo corrente. visual.getFilters() .then(filters => { ... });
getSlicerState()	Ottenere lo stato del filtro dei dati. Funziona solo per gli oggetti visivi di tipo filtro dei dati. visual.getSlicerState() .then(state => { ... });
getSmartNarrativeInsights()	Ottenere informazioni dettagliate per un singolo oggetto visivo visual.getSmartNarrativeInsights();
moveVisual(number, number, number)	Aggiorna la posizione di un oggetto visivo. visual.moveVisual(x, y, z) .catch(error => { ... });
removeFilters()	Rimuove tutti i filtri dall'oggetto visivo corrente. visual.removeFilters();
resizeVisual(number, number)	Ridimensionare un oggetto visivo. visual.resizeVisual(width, height) .catch(error => { ... });
setFilters(IFilter[])	Imposta i filtri nell'oggetto visivo corrente su 'filters'. visual.setFilters(filters); .catch(errors => { ... });
setSlicerState(ISlicerState)	Impostare lo stato del filtro dei dati. Funziona solo per gli oggetti visivi di tipo filtro dei dati.
setVisualDisplayState(VisualContainerDisplayMode)	Aggiorna lo stato di visualizzazione di un oggetto visivo. visual.setVisualDisplayState(displayState) .catch(error => { ... });
sortBy(ISortByVisualRequest)	Ordinare un oggetto visivo in base a dataField e direzione.
updateFilters(FiltersOperations, IFilter[])	Aggiornare i filtri per l'oggetto visivo corrente in base all'operazione: Aggiungi, sostituisci tutto, sostituisci per destinazione o rimuovi. visual.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });

Dettagli proprietà

layout

Layout visivo: posizione, dimensioni e visibilità.

layout: IVisualLayout

Valore della proprietà

IVisualLayout

name

Nome dell'oggetto visivo

name: string

Valore della proprietà

string

page

Pagina padre di Power BI che contiene questo oggetto visivo

page: IPageNode

Valore della proprietà

IPageNode

title

Titolo dell'oggetto visivo

title: string

Valore della proprietà

string

type

Tipo di oggetto visivo

type: string

Valore della proprietà

string

Dettagli metodo

clone(ICloneVisualRequest)

Clonare un oggetto visivo esistente in una nuova istanza.

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

Parametri

request

ICloneVisualRequest

Valori restituiti

Promise<ICloneVisualResponse>

exportData(ExportDataType, number)

Esporta i dati visivi. Può esportare fino a 30.000 righe.

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

Parametri

exportDataType

ExportDataType

rows

number

Valori restituiti

Promise<IExportDataResult>

getFilters()

Ottiene tutti i filtri a livello di oggetto visivo dell'oggetto visivo corrente.

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

function getFilters(): Promise<IFilter[]>

Valori restituiti

Promise<IFilter[]>

getSlicerState()

Ottenere lo stato del filtro dei dati. Funziona solo per gli oggetti visivi di tipo filtro dei dati.

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

function getSlicerState(): Promise<ISlicerState>

Valori restituiti

Promise<ISlicerState>

getSmartNarrativeInsights()

Ottenere informazioni dettagliate per un singolo oggetto visivo

visual.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Valori restituiti

Promise<ISmartNarratives>

moveVisual(number, number, number)

Aggiorna la posizione di un oggetto visivo.

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

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

Parametri

x

number

y

number

z

number

Valori restituiti

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Rimuove tutti i filtri dall'oggetto visivo corrente.

visual.removeFilters();

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

Valori restituiti

Promise<IHttpPostMessageResponse<void>>

resizeVisual(number, number)

Ridimensionare un oggetto visivo.

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

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

Parametri

width

number

height

number

Valori restituiti

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Imposta i filtri nell'oggetto visivo corrente su 'filters'.

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

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

Parametri

filters

IFilter[]

Valori restituiti

Promise<IHttpPostMessageResponse<void>>

setSlicerState(ISlicerState)

Impostare lo stato del filtro dei dati. Funziona solo per gli oggetti visivi di tipo filtro dei dati.

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

Parametri

state

ISlicerState

Valori restituiti

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(VisualContainerDisplayMode)

Aggiorna lo stato di visualizzazione di un oggetto visivo.

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

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

Parametri

displayState

VisualContainerDisplayMode

Valori restituiti

Promise<IHttpPostMessageResponse<void>>

sortBy(ISortByVisualRequest)

Ordinare un oggetto visivo in base a dataField e direzione.

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

Parametri

request

ISortByVisualRequest

Valori restituiti

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Aggiornare i filtri per l'oggetto visivo corrente in base all'operazione: Aggiungi, sostituisci tutto, sostituisci per destinazione o rimuovi.

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

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

Parametri

operation

FiltersOperations

filters

IFilter[]

Valori restituiti

Promise<IHttpPostMessageResponse<void>>