Compartir a través de

VisualDescriptor class

  • Referencia
Paquete:
powerbi-client

Objeto visual de Power BI dentro de una página

Propiedades

layout

Diseño visual: posición, tamaño y visibilidad.
name

Nombre del objeto visual
page

Página principal de Power BI que contiene este objeto visual
title

Título del objeto visual
type

Tipo de objeto visual

Métodos

clone(ICloneVisualRequest)

Clone el objeto visual existente en una nueva instancia.
exportData(ExportDataType, number)

Exporta datos visuales. Puede exportar hasta 30 000 filas.
getFilters()

Obtiene todos los filtros de nivel visual del objeto visual actual.

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

Obtiene el estado de la segmentación de datos. Solo funciona para objetos visuales de segmentación de tipos.

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

Obtención de conclusiones para un solo objeto visual

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

Actualiza la posición de un objeto visual.

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

Quita todos los filtros del objeto visual actual.

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

Cambiar el tamaño de un objeto visual.

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

Establece los filtros del objeto visual actual en "filtros".

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

Establezca el estado de segmentación. Solo funciona para objetos visuales de segmentación de tipos.
setVisualDisplayState(VisualContainerDisplayMode)

Actualiza el estado de presentación de un objeto visual.

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

Ordene un objeto visual por dataField y dirección.
updateFilters(FiltersOperations, IFilter[])

Actualice los filtros del objeto visual actual según la operación: agregue, reemplace todo, reemplace por destino o quite.

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

Detalles de las propiedades

layout

Diseño visual: posición, tamaño y visibilidad.

layout: IVisualLayout

Valor de propiedad

IVisualLayout

name

Nombre del objeto visual

name: string

Valor de propiedad

string

page

Página principal de Power BI que contiene este objeto visual

page: IPageNode

Valor de propiedad

IPageNode

title

Título del objeto visual

title: string

Valor de propiedad

string

type

Tipo de objeto visual

type: string

Valor de propiedad

string

Detalles del método

clone(ICloneVisualRequest)

Clone el objeto visual existente en una nueva instancia.

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

Parámetros

request
ICloneVisualRequest

Devoluciones

Promise<ICloneVisualResponse>

exportData(ExportDataType, number)

Exporta datos visuales. Puede exportar hasta 30 000 filas.

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

Parámetros

exportDataType
ExportDataType
rows

number

Devoluciones

Promise<IExportDataResult>

getFilters()

Obtiene todos los filtros de nivel visual del objeto visual actual.

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

function getFilters(): Promise<IFilter[]>

Devoluciones

Promise<IFilter[]>

getSlicerState()

Obtiene el estado de la segmentación de datos. Solo funciona para objetos visuales de segmentación de tipos.

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

function getSlicerState(): Promise<ISlicerState>

Devoluciones

Promise<ISlicerState>

getSmartNarrativeInsights()

Obtención de conclusiones para un solo objeto visual

visual.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Devoluciones

Promise<ISmartNarratives>

moveVisual(number, number, number)

Actualiza la posición de un objeto 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

Devoluciones

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Quita todos los filtros del objeto visual actual.

visual.removeFilters();

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

Devoluciones

Promise<IHttpPostMessageResponse<void>>

resizeVisual(number, number)

Cambiar el tamaño de un objeto visual.

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

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

Parámetros

width

number

height

number

Devoluciones

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Establece los filtros del objeto visual actual en "filtros".

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

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

Parámetros

filters

IFilter[]

Devoluciones

Promise<IHttpPostMessageResponse<void>>

setSlicerState(ISlicerState)

Establezca el estado de segmentación. Solo funciona para objetos visuales de segmentación de tipos.

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

Parámetros

state
ISlicerState

Devoluciones

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(VisualContainerDisplayMode)

Actualiza el estado de presentación de un objeto visual.

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

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

Parámetros

displayState
VisualContainerDisplayMode

Devoluciones

Promise<IHttpPostMessageResponse<void>>

sortBy(ISortByVisualRequest)

Ordene un objeto visual por dataField y dirección.

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

Parámetros

request
ISortByVisualRequest

Devoluciones

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Actualice los filtros del objeto visual actual según la operación: agregue, reemplace todo, reemplace por destino o quite.

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

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

Parámetros

operation
FiltersOperations
filters

IFilter[]

Devoluciones

Promise<IHttpPostMessageResponse<void>>