Compartilhar via

VisualDescriptor class

  • Referência
Pacote:
powerbi-client

Um visual do Power BI em uma página

Propriedades

layout

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

O nome do 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 em uma nova instância.
exportData(ExportDataType, number)

Exporta dados visuais. Pode exportar até 30 mil linhas.
getFilters()

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

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

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

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

Obter insights 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)

Redimensionar 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 visuais de segmentação de tipo.
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 todos, substituir por destino ou remover.

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

Detalhes da propriedade

layout

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

layout: IVisualLayout

Valor da propriedade

IVisualLayout

name

O nome do visual

name: string

Valor da propriedade

string

page

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

page: IPageNode

Valor da propriedade

IPageNode

title

O título visual

title: string

Valor da propriedade

string

type

O tipo visual

type: string

Valor da propriedade

string

Detalhes do método

clone(ICloneVisualRequest)

Clone o visual existente em uma nova instância.

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

Parâmetros

request
ICloneVisualRequest

Retornos

Promise<ICloneVisualResponse>

exportData(ExportDataType, number)

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

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

Parâmetros

exportDataType
ExportDataType
rows

number

Retornos

Promise<IExportDataResult>

getFilters()

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

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

function getFilters(): Promise<IFilter[]>

Retornos

Promise<IFilter[]>

getSlicerState()

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

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

function getSlicerState(): Promise<ISlicerState>

Retornos

Promise<ISlicerState>

getSmartNarrativeInsights()

Obter insights para um único visual

visual.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Retornos

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

Retornos

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Remove todos os filtros do visual atual.

visual.removeFilters();

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

Retornos

Promise<IHttpPostMessageResponse<void>>

resizeVisual(number, number)

Redimensionar um visual.

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

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

Parâmetros

width

number

height

number

Retornos

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[]

Retornos

Promise<IHttpPostMessageResponse<void>>

setSlicerState(ISlicerState)

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

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

Parâmetros

state
ISlicerState

Retornos

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

Retornos

Promise<IHttpPostMessageResponse<void>>

sortBy(ISortByVisualRequest)

Classifique um visual por dataField e direção.

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

Parâmetros

request
ISortByVisualRequest

Retornos

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Atualize os filtros para o visual atual de acordo com a operação: Adicionar, substituir todos, 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[]

Retornos

Promise<IHttpPostMessageResponse<void>>