VisualDescriptor class

Pakket:

powerbi-client

Een Power BI-visual binnen een pagina

Eigenschappen

layout	De visuele indeling: positie, grootte en zichtbaarheid.
name	De naam van de visual
page	De bovenliggende Power BI-pagina met deze visual
title	De titel van de visual
type	Het type visual

Methoden

clone(ICloneVisualRequest)	Bestaande visual klonen naar een nieuw exemplaar.
exportData(ExportDataType, number)	Hiermee exporteert u visuele gegevens. Kan maximaal 30.000 rijen exporteren.
getFilters()	Hiermee haalt u alle filters op visualniveau van de huidige visual op. visual.getFilters() .then(filters => { ... });
getSlicerState()	De status van de slicer ophalen. Werkt alleen voor visuals van het type slicer. visual.getSlicerState() .then(state => { ... });
getSmartNarrativeInsights()	Inzichten verkrijgen voor één visual visual.getSmartNarrativeInsights();
moveVisual(number, number, number)	Hiermee wordt de positie van een visual bijgewerkt. visual.moveVisual(x, y, z) .catch(error => { ... });
removeFilters()	Hiermee verwijdert u alle filters uit de huidige visual. visual.removeFilters();
resizeVisual(number, number)	Het formaat van een visual wijzigen. visual.resizeVisual(width, height) .catch(error => { ... });
setFilters(IFilter[])	Hiermee stelt u de filters voor de huidige visual in op 'filters'. visual.setFilters(filters); .catch(errors => { ... });
setSlicerState(ISlicerState)	De slicerstatus instellen. Werkt alleen voor visuals van het type slicer.
setVisualDisplayState(VisualContainerDisplayMode)	Hiermee wordt de weergavestatus van een visual bijgewerkt. visual.setVisualDisplayState(displayState) .catch(error => { ... });
sortBy(ISortByVisualRequest)	Sorteer een visual op dataField en richting.
updateFilters(FiltersOperations, IFilter[])	Werk de filters voor de huidige visual bij op basis van de bewerking: Alles toevoegen, vervangen door doel of verwijderen. visual.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });

Eigenschapdetails

layout

De visuele indeling: positie, grootte en zichtbaarheid.

layout: IVisualLayout

Waarde van eigenschap

IVisualLayout

name

De naam van de visual

name: string

Waarde van eigenschap

string

page

De bovenliggende Power BI-pagina met deze visual

page: IPageNode

Waarde van eigenschap

IPageNode

title

De titel van de visual

title: string

Waarde van eigenschap

string

type

Het type visual

type: string

Waarde van eigenschap

string

Methodedetails

clone(ICloneVisualRequest)

Bestaande visual klonen naar een nieuw exemplaar.

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

Parameters

request

ICloneVisualRequest

Retouren

Promise<ICloneVisualResponse>

exportData(ExportDataType, number)

Hiermee exporteert u visuele gegevens. Kan maximaal 30.000 rijen exporteren.

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

Parameters

exportDataType

ExportDataType

rows

number

Retouren

Promise<IExportDataResult>

getFilters()

Hiermee haalt u alle filters op visualniveau van de huidige visual op.

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

function getFilters(): Promise<IFilter[]>

Retouren

Promise<IFilter[]>

getSlicerState()

De status van de slicer ophalen. Werkt alleen voor visuals van het type slicer.

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

function getSlicerState(): Promise<ISlicerState>

Retouren

Promise<ISlicerState>

getSmartNarrativeInsights()

Inzichten verkrijgen voor één visual

visual.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Retouren

Promise<ISmartNarratives>

moveVisual(number, number, number)

Hiermee wordt de positie van een visual bijgewerkt.

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

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

Parameters

x

number

y

number

z

number

Retouren

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Hiermee verwijdert u alle filters uit de huidige visual.

visual.removeFilters();

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

Retouren

Promise<IHttpPostMessageResponse<void>>

resizeVisual(number, number)

Het formaat van een visual wijzigen.

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

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

Parameters

width

number

height

number

Retouren

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Hiermee stelt u de filters voor de huidige visual in op 'filters'.

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

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

Parameters

filters

IFilter[]

Retouren

Promise<IHttpPostMessageResponse<void>>

setSlicerState(ISlicerState)

De slicerstatus instellen. Werkt alleen voor visuals van het type slicer.

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

Parameters

state

ISlicerState

Retouren

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(VisualContainerDisplayMode)

Hiermee wordt de weergavestatus van een visual bijgewerkt.

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

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

Parameters

displayState

VisualContainerDisplayMode

Retouren

Promise<IHttpPostMessageResponse<void>>

sortBy(ISortByVisualRequest)

Sorteer een visual op dataField en richting.

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

Parameters

request

ISortByVisualRequest

Retouren

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Werk de filters voor de huidige visual bij op basis van de bewerking: Alles toevoegen, vervangen door doel of verwijderen.

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

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

Parameters

operation

FiltersOperations

filters

IFilter[]

Retouren

Promise<IHttpPostMessageResponse<void>>