VisualDescriptor class

Pacote:

powerbi-client

Um visual do Power BI dentro de uma página

Propriedades

layout	O layout visual: posição, tamanho e visibilidade.
name	O nome visual
page	A página pai do Power BI que contém este visual
title	O título visual
type	O tipo visual

Métodos

clone(ICloneVisualRequest)	Clone o visual existente para uma nova instância.
exportData(ExportDataType, number)	Exporta dados visuais. Pode exportar até 30K linhas.
getFilters()	Obtém todos os filtros de nível visual do visual atual. visual.getFilters() .then(filters => { ... });
getSlicerState()	Obter estado de segmentação de dados. Funciona apenas para elementos visuais do tipo segmentação de dados. visual.getSlicerState() .then(state => { ... });
getSmartNarrativeInsights()	Obtenha informações para um único visual visual.getSmartNarrativeInsights();
moveVisual(number, number, number)	Atualiza a posição de um visual. visual.moveVisual(x, y, z) .catch(error => { ... });
removeFilters()	Remove todos os filtros do visual atual. visual.removeFilters();
resizeVisual(number, number)	Redimensione um visual. visual.resizeVisual(width, height) .catch(error => { ... });
setFilters(IFilter[])	Define os filtros no visual atual como 'filtros'. visual.setFilters(filters); .catch(errors => { ... });
setSlicerState(ISlicerState)	Defina o estado da segmentação de dados. Funciona apenas para elementos visuais do tipo segmentação de dados.
setVisualDisplayState(VisualContainerDisplayMode)	Atualiza o estado de exibição de um visual. visual.setVisualDisplayState(displayState) .catch(error => { ... });
sortBy(ISortByVisualRequest)	Classifique um visual por dataField e direção.
updateFilters(FiltersOperations, IFilter[])	Atualize os filtros para o visual atual de acordo com a operação: Adicionar, substituir tudo, substituir por destino ou remover. visual.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });

Detalhes de Propriedade

layout

O layout visual: posição, tamanho e visibilidade.

layout: IVisualLayout

Valor de Propriedade

IVisualLayout

name

O nome visual

name: string

Valor de Propriedade

string

page

A página pai do Power BI que contém este visual

page: IPageNode

Valor de Propriedade

IPageNode

title

O título visual

title: string

Valor de Propriedade

string

type

O tipo visual

type: string

Valor de Propriedade

string

Detalhes de Método

clone(ICloneVisualRequest)

Clone o visual existente para uma nova instância.

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

Parâmetros

request

ICloneVisualRequest

Devoluções

Promise<ICloneVisualResponse>

exportData(ExportDataType, number)

Exporta dados visuais. Pode exportar até 30K linhas.

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

Parâmetros

exportDataType

ExportDataType

rows

number

Devoluções

Promise<IExportDataResult>

getFilters()

Obtém todos os filtros de nível visual do visual atual.

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

function getFilters(): Promise<IFilter[]>

Devoluções

Promise<IFilter[]>

getSlicerState()

Obter estado de segmentação de dados. Funciona apenas para elementos visuais do tipo segmentação de dados.

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

function getSlicerState(): Promise<ISlicerState>

Devoluções

Promise<ISlicerState>

getSmartNarrativeInsights()

Obtenha informações para um único visual

visual.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Devoluções

Promise<ISmartNarratives>

moveVisual(number, number, number)

Atualiza a posição de um visual.

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

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

Parâmetros

x

number

y

number

z

number

Devoluções

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Remove todos os filtros do visual atual.

visual.removeFilters();

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

Devoluções

Promise<IHttpPostMessageResponse<void>>

resizeVisual(number, number)

Redimensione um visual.

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

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

Parâmetros

width

number

height

number

Devoluções

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Define os filtros no visual atual como 'filtros'.

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

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

Parâmetros

filters

IFilter[]

Devoluções

Promise<IHttpPostMessageResponse<void>>

setSlicerState(ISlicerState)

Defina o estado da segmentação de dados. Funciona apenas para elementos visuais do tipo segmentação de dados.

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

Parâmetros

state

ISlicerState

Devoluções

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(VisualContainerDisplayMode)

Atualiza o estado de exibição de um visual.

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

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

Parâmetros

displayState

VisualContainerDisplayMode

Devoluções

Promise<IHttpPostMessageResponse<void>>

sortBy(ISortByVisualRequest)

Classifique um visual por dataField e direção.

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

Parâmetros

request

ISortByVisualRequest

Devoluções

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Atualize os filtros para o visual atual de acordo com a operação: Adicionar, substituir tudo, substituir por destino ou remover.

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

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

Parâmetros

operation

FiltersOperations

filters

IFilter[]

Devoluções

Promise<IHttpPostMessageResponse<void>>