Page class

Pacchetto:

powerbi-client

Pagina di un report di Power BI

Proprietà

background	Colore di sfondo della pagina.
defaultDisplayOption	Opzioni di visualizzazione pagina salvate nel report.
defaultSize	Dimensioni della pagina salvate nel report.
displayName	Nome visualizzato definito dall'utente della pagina del report, che non è definito se la pagina viene creata manualmente
isActive	Questa pagina è la pagina attiva
mobileSize	Dimensioni della pagina visualizzazione per dispositivi mobili (se definite) salvate nel report.
name	Nome della pagina del report
report	Report padre di Power BI di cui questa pagina è membro
visibility	Visibilità della pagina. 0 - Sempre visibile 1 - Nascosto in modalità visualizzazione
wallpaper	Colore dello sfondo della pagina.

Metodi

delete()	Eliminare la pagina dal report // Delete the page from the report page.delete();
getFilters()	Ottiene tutti i filtri a livello di pagina all'interno del report. page.getFilters() .then(filters => { ... });
getSlicers()	Ottiene l'elenco degli oggetti visivi del filtro dei dati nella pagina. page.getSlicers() .then(slicers => { ... });
getSmartNarrativeInsights()	Ottenere informazioni dettagliate per la pagina del report page.getSmartNarrativeInsights();
getVisualByName(string)	Ottiene un oggetto visivo in base al nome nella pagina. page.getVisualByName(visualName: string) .then(visual => { ... });
getVisuals()	Ottiene tutti gli oggetti visivi nella pagina. page.getVisuals() .then(visuals => { ... });
hasLayout(LayoutType)	Controlla se il layout della pagina è. page.hasLayout(layoutType) .then(hasLayout: boolean => { ... });
moveVisual(string, number, number, number)	Aggiornamenti la posizione di un oggetto visivo in una pagina. page.moveVisual(visualName, x, y, z) .catch(error => { ... });
removeFilters()	Rimuove tutti i filtri da questa pagina del report. page.removeFilters();
resizePage(PageSizeType, number, number)	Aggiornamenti le dimensioni della pagina attiva. page.resizePage(pageSizeType, width, height) .catch(error => { ... });
resizeVisual(string, number, number)	Ridimensionare un oggetto visivo in una pagina. page.resizeVisual(visualName, width, height) .catch(error => { ... });
setActive()	Rende la pagina corrente la pagina attiva del report. page.setActive();
setDisplayName(string)	Impostare displayName sulla pagina corrente. page.setName(displayName);
setFilters(IFilter[])	Imposta tutti i filtri nella pagina corrente. page.setFilters(filters) .catch(errors => { ... });
setVisualDisplayState(string, VisualContainerDisplayMode)	Aggiornamenti lo stato di visualizzazione di un oggetto visivo in una pagina. page.setVisualDisplayState(visualName, displayState) .catch(error => { ... });
updateFilters(FiltersOperations, IFilter[])	Aggiornare i filtri per la pagina corrente in base all'operazione: Aggiungi, sostituisci tutto, sostituisci per destinazione o rimuovi. page.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });

Dettagli proprietà

background

Colore di sfondo della pagina.

background: IPageBackground

Valore della proprietà

IPageBackground

defaultDisplayOption

Opzioni di visualizzazione pagina salvate nel report.

defaultDisplayOption: DisplayOption

Valore della proprietà

DisplayOption

defaultSize

Dimensioni della pagina salvate nel report.

defaultSize: ICustomPageSize

Valore della proprietà

ICustomPageSize

displayName

Nome visualizzato definito dall'utente della pagina del report, che non è definito se la pagina viene creata manualmente

displayName: string

Valore della proprietà

string

isActive

Questa pagina è la pagina attiva

isActive: boolean

Valore della proprietà

boolean

mobileSize

Dimensioni della pagina visualizzazione per dispositivi mobili (se definite) salvate nel report.

mobileSize: ICustomPageSize

Valore della proprietà

ICustomPageSize

name

Nome della pagina del report

name: string

Valore della proprietà

string

report

Report padre di Power BI di cui questa pagina è membro

report: IReportNode

Valore della proprietà

IReportNode

visibility

Visibilità della pagina. 0 - Sempre visibile 1 - Nascosto in modalità visualizzazione

visibility: SectionVisibility

Valore della proprietà

SectionVisibility

wallpaper

Colore dello sfondo della pagina.

wallpaper: IPageWallpaper

Valore della proprietà

IPageWallpaper

Dettagli metodo

delete()

Eliminare la pagina dal report

// Delete the page from the report
page.delete();

function delete(): Promise<void>

Restituisce

Promise<void>

getFilters()

Ottiene tutti i filtri a livello di pagina all'interno del report.

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

function getFilters(): Promise<IFilter[]>

Restituisce

Promise<IFilter[]>

getSlicers()

Ottiene l'elenco degli oggetti visivi del filtro dei dati nella pagina.

page.getSlicers()
 .then(slicers => {
     ...
 });

function getSlicers(): Promise<IVisual[]>

Restituisce

Promise<IVisual[]>

getSmartNarrativeInsights()

Ottenere informazioni dettagliate per la pagina del report

page.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Restituisce

Promise<ISmartNarratives>

getVisualByName(string)

Ottiene un oggetto visivo in base al nome nella pagina.

page.getVisualByName(visualName: string)
 .then(visual => {
     ...
 });

function getVisualByName(visualName: string): Promise<VisualDescriptor>

Parametri

visualName

string

Restituisce

Promise<VisualDescriptor>

getVisuals()

Ottiene tutti gli oggetti visivi nella pagina.

page.getVisuals()
  .then(visuals => { ... });

function getVisuals(): Promise<VisualDescriptor[]>

Restituisce

Promise<VisualDescriptor[]>

hasLayout(LayoutType)

Controlla se il layout della pagina è.

page.hasLayout(layoutType)
 .then(hasLayout: boolean => { ... });

function hasLayout(layoutType: LayoutType): Promise<boolean>

Parametri

layoutType

LayoutType

Restituisce

Promise<boolean>

moveVisual(string, number, number, number)

Aggiornamenti la posizione di un oggetto visivo in una pagina.

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

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

Parametri

visualName

string

x

number

y

number

z

number

Restituisce

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Rimuove tutti i filtri da questa pagina del report.

page.removeFilters();

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

Restituisce

Promise<IHttpPostMessageResponse<void>>

resizePage(PageSizeType, number, number)

Aggiornamenti le dimensioni della pagina attiva.

page.resizePage(pageSizeType, width, height)
  .catch(error => { ... });

function resizePage(pageSizeType: PageSizeType, width?: number, height?: number): Promise<IHttpPostMessageResponse<void>>

Parametri

pageSizeType

PageSizeType

width

number

height

number

Restituisce

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, number, number)

Ridimensionare un oggetto visivo in una pagina.

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

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

Parametri

visualName

string

width

number

height

number

Restituisce

Promise<IHttpPostMessageResponse<void>>

setActive()

Rende la pagina corrente la pagina attiva del report.

page.setActive();

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

Restituisce

Promise<IHttpPostMessageResponse<void>>

setDisplayName(string)

Impostare displayName sulla pagina corrente.

page.setName(displayName);

function setDisplayName(displayName: string): Promise<IHttpPostMessageResponse<void>>

Parametri

displayName

string

Restituisce

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Imposta tutti i filtri nella pagina corrente.

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

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

Parametri

filters

IFilter[]

Restituisce

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, VisualContainerDisplayMode)

Aggiornamenti lo stato di visualizzazione di un oggetto visivo in una pagina.

page.setVisualDisplayState(visualName, displayState)
  .catch(error => { ... });

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

Parametri

visualName

string

displayState

VisualContainerDisplayMode

Restituisce

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Aggiornare i filtri per la pagina corrente in base all'operazione: Aggiungi, sostituisci tutto, sostituisci per destinazione o rimuovi.

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

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

Parametri

operation

FiltersOperations

filters

IFilter[]

Restituisce

Promise<IHttpPostMessageResponse<void>>