Page class

Balíček:

powerbi-client

Stránka sestavy Power BI

Vlastnosti

background	Barva pozadí stránky.
defaultDisplayOption	Možnosti zobrazení stránky tak, jak jsou uložené v sestavě.
defaultSize	Velikost stránky uložená v sestavě
displayName	Zobrazovaný název stránky sestavy definovaný uživatelem, který není definován, pokud je stránka vytvořena ručně
isActive	Je tato stránka aktivní?
mobileSize	Velikost stránky mobilního zobrazení (pokud je definovaná) uložená v sestavě
name	Název stránky sestavy
report	Nadřazená sestava Power BI, ve které je tato stránka členem
visibility	Viditelnost stránky. 0 – Vždy viditelné 1 – skryté v režimu zobrazení
wallpaper	Barva tapety stránky.

Metody

delete()	Odstranění stránky ze sestavy // Delete the page from the report page.delete();
getFilters()	Získá všechny filtry na úrovni stránek v rámci sestavy. page.getFilters() .then(filters => { ... });
getSlicers()	Získá seznam vizuálů průřezu na stránce. page.getSlicers() .then(slicers => { ... });
getSmartNarrativeInsights()	Získání přehledů pro stránku sestavy page.getSmartNarrativeInsights();
getVisualByName(string)	Získá vizuál podle názvu na stránce. page.getVisualByName(visualName: string) .then(visual => { ... });
getVisuals()	Získá všechny vizuály na stránce. page.getVisuals() .then(visuals => { ... });
hasLayout(LayoutType)	Zkontroluje, jestli má stránka rozložení. page.hasLayout(layoutType) .then(hasLayout: boolean => { ... });
moveVisual(string, number, number, number)	Aktualizace umístění vizuálu na stránce. page.moveVisual(visualName, x, y, z) .catch(error => { ... });
removeFilters()	Odebere z této stránky sestavy všechny filtry. page.removeFilters();
resizePage(PageSizeType, number, number)	Aktualizace velikost aktivní stránky. page.resizePage(pageSizeType, width, height) .catch(error => { ... });
resizeVisual(string, number, number)	Změna velikosti vizuálu na stránce page.resizeVisual(visualName, width, height) .catch(error => { ... });
setActive()	Nastaví aktuální stránku jako aktivní stránku sestavy. page.setActive();
setDisplayName(string)	Nastavte displayName na aktuální stránku. page.setName(displayName);
setFilters(IFilter[])	Nastaví všechny filtry na aktuální stránce. page.setFilters(filters) .catch(errors => { ... });
setVisualDisplayState(string, VisualContainerDisplayMode)	Aktualizace stav zobrazení vizuálu na stránce. page.setVisualDisplayState(visualName, displayState) .catch(error => { ... });
updateFilters(FiltersOperations, IFilter[])	Aktualizujte filtry pro aktuální stránku podle operace: Přidat, nahradit vše, nahradit cílem nebo odebrat. page.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });

Podrobnosti vlastnosti

background

Barva pozadí stránky.

background: IPageBackground

Hodnota vlastnosti

IPageBackground

defaultDisplayOption

Možnosti zobrazení stránky tak, jak jsou uložené v sestavě.

defaultDisplayOption: DisplayOption

Hodnota vlastnosti

DisplayOption

defaultSize

Velikost stránky uložená v sestavě

defaultSize: ICustomPageSize

Hodnota vlastnosti

ICustomPageSize

displayName

Zobrazovaný název stránky sestavy definovaný uživatelem, který není definován, pokud je stránka vytvořena ručně

displayName: string

Hodnota vlastnosti

string

isActive

Je tato stránka aktivní?

isActive: boolean

Hodnota vlastnosti

boolean

mobileSize

Velikost stránky mobilního zobrazení (pokud je definovaná) uložená v sestavě

mobileSize: ICustomPageSize

Hodnota vlastnosti

ICustomPageSize

name

Název stránky sestavy

name: string

Hodnota vlastnosti

string

report

Nadřazená sestava Power BI, ve které je tato stránka členem

report: IReportNode

Hodnota vlastnosti

IReportNode

visibility

Viditelnost stránky. 0 – Vždy viditelné 1 – skryté v režimu zobrazení

visibility: SectionVisibility

Hodnota vlastnosti

SectionVisibility

wallpaper

Barva tapety stránky.

wallpaper: IPageWallpaper

Hodnota vlastnosti

IPageWallpaper

Podrobnosti metody

delete()

Odstranění stránky ze sestavy

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

function delete(): Promise<void>

Návraty

Promise<void>

getFilters()

Získá všechny filtry na úrovni stránek v rámci sestavy.

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

function getFilters(): Promise<IFilter[]>

Návraty

Promise<IFilter[]>

getSlicers()

Získá seznam vizuálů průřezu na stránce.

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

function getSlicers(): Promise<IVisual[]>

Návraty

Promise<IVisual[]>

getSmartNarrativeInsights()

Získání přehledů pro stránku sestavy

page.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Návraty

Promise<ISmartNarratives>

getVisualByName(string)

Získá vizuál podle názvu na stránce.

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

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

Parametry

visualName

string

Návraty

Promise<VisualDescriptor>

getVisuals()

Získá všechny vizuály na stránce.

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

function getVisuals(): Promise<VisualDescriptor[]>

Návraty

Promise<VisualDescriptor[]>

hasLayout(LayoutType)

Zkontroluje, jestli má stránka rozložení.

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

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

Parametry

layoutType

LayoutType

Návraty

Promise<boolean>

moveVisual(string, number, number, number)

Aktualizace umístění vizuálu na stránce.

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

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

Parametry

visualName

string

x

number

y

number

z

number

Návraty

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Odebere z této stránky sestavy všechny filtry.

page.removeFilters();

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

Návraty

Promise<IHttpPostMessageResponse<void>>

resizePage(PageSizeType, number, number)

Aktualizace velikost aktivní stránky.

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

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

Parametry

pageSizeType

PageSizeType

width

number

height

number

Návraty

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, number, number)

Změna velikosti vizuálu na stránce

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

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

Parametry

visualName

string

width

number

height

number

Návraty

Promise<IHttpPostMessageResponse<void>>

setActive()

Nastaví aktuální stránku jako aktivní stránku sestavy.

page.setActive();

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

Návraty

Promise<IHttpPostMessageResponse<void>>

setDisplayName(string)

Nastavte displayName na aktuální stránku.

page.setName(displayName);

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

Parametry

displayName

string

Návraty

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Nastaví všechny filtry na aktuální stránce.

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

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

Parametry

filters

IFilter[]

Návraty

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, VisualContainerDisplayMode)

Aktualizace stav zobrazení vizuálu na stránce.

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

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

Parametry

visualName

string

displayState

VisualContainerDisplayMode

Návraty

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Aktualizujte filtry pro aktuální stránku podle operace: Přidat, nahradit vše, nahradit cílem nebo odebrat.

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

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

Parametry

operation

FiltersOperations

filters

IFilter[]

Návraty

Promise<IHttpPostMessageResponse<void>>