Partager via

VisualDescriptor class

  • Référence
Paquet:
powerbi-client

Un visuel Power BI dans une page

Propriétés

layout

Disposition visuelle : position, taille et visibilité.
name

Nom du visuel
page

Page Power BI parente qui contient ce visuel
title

Titre visuel
type

Type visuel

Méthodes

clone(ICloneVisualRequest)

Clonez le visuel existant dans une nouvelle instance.
exportData(ExportDataType, number)

Exporte les données visuelles. Peut exporter jusqu’à 30 000 lignes.
getFilters()

Obtient tous les filtres de niveau visuel du visuel actuel.

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

Obtenir l’état du segment. Fonctionne uniquement pour les visuels de type segment.

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

Obtenir des insights pour un visuel unique

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

Mises à jour la position d’un visuel.

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

Supprime tous les filtres du visuel actuel.

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

Redimensionner un visuel.

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

Définit les filtres du visuel actuel sur « filtres ».

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

Définir l’état du segment. Fonctionne uniquement pour les visuels de type segment.
setVisualDisplayState(VisualContainerDisplayMode)

Mises à jour l’état d’affichage d’un visuel.

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

Triez un visuel par dataField et direction.
updateFilters(FiltersOperations, IFilter[])

Mettez à jour les filtres du visuel actuel en fonction de l’opération : Ajouter, remplacer tout, remplacer par cible ou supprimer.

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

Détails de la propriété

layout

Disposition visuelle : position, taille et visibilité.

layout: IVisualLayout

Valeur de propriété

IVisualLayout

name

Nom du visuel

name: string

Valeur de propriété

string

page

Page Power BI parente qui contient ce visuel

page: IPageNode

Valeur de propriété

IPageNode

title

Titre visuel

title: string

Valeur de propriété

string

type

Type visuel

type: string

Valeur de propriété

string

Détails de la méthode

clone(ICloneVisualRequest)

Clonez le visuel existant dans une nouvelle instance.

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

Paramètres

request
ICloneVisualRequest

Retours

Promise<ICloneVisualResponse>

exportData(ExportDataType, number)

Exporte les données visuelles. Peut exporter jusqu’à 30 000 lignes.

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

Paramètres

exportDataType
ExportDataType
rows

number

Retours

Promise<IExportDataResult>

getFilters()

Obtient tous les filtres de niveau visuel du visuel actuel.

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

function getFilters(): Promise<IFilter[]>

Retours

Promise<IFilter[]>

getSlicerState()

Obtenir l’état du segment. Fonctionne uniquement pour les visuels de type segment.

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

function getSlicerState(): Promise<ISlicerState>

Retours

Promise<ISlicerState>

getSmartNarrativeInsights()

Obtenir des insights pour un visuel unique

visual.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Retours

Promise<ISmartNarratives>

moveVisual(number, number, number)

Mises à jour la position d’un visuel.

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

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

Paramètres

x

number

y

number

z

number

Retours

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Supprime tous les filtres du visuel actuel.

visual.removeFilters();

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

Retours

Promise<IHttpPostMessageResponse<void>>

resizeVisual(number, number)

Redimensionner un visuel.

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

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

Paramètres

width

number

height

number

Retours

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Définit les filtres du visuel actuel sur « filtres ».

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

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

Paramètres

filters

IFilter[]

Retours

Promise<IHttpPostMessageResponse<void>>

setSlicerState(ISlicerState)

Définir l’état du segment. Fonctionne uniquement pour les visuels de type segment.

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

Paramètres

state
ISlicerState

Retours

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(VisualContainerDisplayMode)

Mises à jour l’état d’affichage d’un visuel.

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

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

Paramètres

displayState
VisualContainerDisplayMode

Retours

Promise<IHttpPostMessageResponse<void>>

sortBy(ISortByVisualRequest)

Triez un visuel par dataField et direction.

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

Paramètres

request
ISortByVisualRequest

Retours

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Mettez à jour les filtres du visuel actuel en fonction de l’opération : Ajouter, remplacer tout, remplacer par cible ou supprimer.

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

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

Paramètres

operation
FiltersOperations
filters

IFilter[]

Retours

Promise<IHttpPostMessageResponse<void>>