Page class

Pakiet:

powerbi-client

Strona raportu usługi Power BI

Właściwości

background	Kolor tła strony.
defaultDisplayOption	Opcje wyświetlania strony zapisane w raporcie.
defaultSize	Rozmiar strony zapisany w raporcie.
displayName	Zdefiniowana przez użytkownika nazwa wyświetlana strony raportu, która jest niezdefiniowana, jeśli strona została utworzona ręcznie
isActive	Czy ta strona jest aktywną stroną
mobileSize	Rozmiar strony widoku dla urządzeń przenośnych (jeśli jest zdefiniowany) zapisany w raporcie.
name	Nazwa strony raportu
report	Nadrzędny raport usługi Power BI, do którego należy ta strona
visibility	Widoczność strony. 0 — Zawsze widoczne 1 — ukryte w trybie wyświetlania
wallpaper	Kolor tapety strony.

Metody

delete()	Usuwanie strony z raportu // Delete the page from the report page.delete();
getFilters()	Pobiera wszystkie filtry na poziomie strony w raporcie. page.getFilters() .then(filters => { ... });
getSlicers()	Pobiera listę wizualizacji fragmentatora na stronie. page.getSlicers() .then(slicers => { ... });
getSmartNarrativeInsights()	Uzyskiwanie szczegółowych informacji dla strony raportu page.getSmartNarrativeInsights();
getVisualByName(string)	Pobiera wizualizację według nazwy na stronie. page.getVisualByName(visualName: string) .then(visual => { ... });
getVisuals()	Pobiera wszystkie wizualizacje na stronie. page.getVisuals() .then(visuals => { ... });
hasLayout(LayoutType)	Sprawdza, czy strona ma układ. page.hasLayout(layoutType) .then(hasLayout: boolean => { ... });
moveVisual(string, number, number, number)	Aktualizuje położenie wizualizacji na stronie. page.moveVisual(visualName, x, y, z) .catch(error => { ... });
removeFilters()	Usuwa wszystkie filtry z tej strony raportu. page.removeFilters();
resizePage(PageSizeType, number, number)	Aktualizuje rozmiar aktywnej strony. page.resizePage(pageSizeType, width, height) .catch(error => { ... });
resizeVisual(string, number, number)	Zmienianie rozmiaru wizualizacji na stronie. page.resizeVisual(visualName, width, height) .catch(error => { ... });
setActive()	Sprawia, że bieżąca strona jest aktywną stroną raportu. page.setActive();
setDisplayName(string)	Ustaw wartość displayName na bieżącą stronę. page.setName(displayName);
setFilters(IFilter[])	Ustawia wszystkie filtry na bieżącej stronie. page.setFilters(filters) .catch(errors => { ... });
setVisualDisplayState(string, VisualContainerDisplayMode)	Aktualizuje stan wyświetlania wizualizacji na stronie. page.setVisualDisplayState(visualName, displayState) .catch(error => { ... });
updateFilters(FiltersOperations, IFilter[])	Zaktualizuj filtry bieżącej strony zgodnie z operacją: Dodaj, zastąp wszystkie, zastąp elementem docelowym lub usuń. page.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });

Szczegóły właściwości

background

Kolor tła strony.

background: IPageBackground

Wartość właściwości

IPageBackground

defaultDisplayOption

Opcje wyświetlania strony zapisane w raporcie.

defaultDisplayOption: DisplayOption

Wartość właściwości

DisplayOption

defaultSize

Rozmiar strony zapisany w raporcie.

defaultSize: ICustomPageSize

Wartość właściwości

ICustomPageSize

displayName

Zdefiniowana przez użytkownika nazwa wyświetlana strony raportu, która jest niezdefiniowana, jeśli strona została utworzona ręcznie

displayName: string

Wartość właściwości

string

isActive

Czy ta strona jest aktywną stroną

isActive: boolean

Wartość właściwości

boolean

mobileSize

Rozmiar strony widoku dla urządzeń przenośnych (jeśli jest zdefiniowany) zapisany w raporcie.

mobileSize: ICustomPageSize

Wartość właściwości

ICustomPageSize

name

Nazwa strony raportu

name: string

Wartość właściwości

string

report

Nadrzędny raport usługi Power BI, do którego należy ta strona

report: IReportNode

Wartość właściwości

IReportNode

visibility

Widoczność strony. 0 — Zawsze widoczne 1 — ukryte w trybie wyświetlania

visibility: SectionVisibility

Wartość właściwości

SectionVisibility

wallpaper

Kolor tapety strony.

wallpaper: IPageWallpaper

Wartość właściwości

IPageWallpaper

Szczegóły metody

delete()

Usuwanie strony z raportu

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

function delete(): Promise<void>

Zwraca

Promise<void>

getFilters()

Pobiera wszystkie filtry na poziomie strony w raporcie.

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

function getFilters(): Promise<IFilter[]>

Zwraca

Promise<IFilter[]>

getSlicers()

Pobiera listę wizualizacji fragmentatora na stronie.

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

function getSlicers(): Promise<IVisual[]>

Zwraca

Promise<IVisual[]>

getSmartNarrativeInsights()

Uzyskiwanie szczegółowych informacji dla strony raportu

page.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Zwraca

Promise<ISmartNarratives>

getVisualByName(string)

Pobiera wizualizację według nazwy na stronie.

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

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

Parametry

visualName

string

Zwraca

Promise<VisualDescriptor>

getVisuals()

Pobiera wszystkie wizualizacje na stronie.

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

function getVisuals(): Promise<VisualDescriptor[]>

Zwraca

Promise<VisualDescriptor[]>

hasLayout(LayoutType)

Sprawdza, czy strona ma układ.

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

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

Parametry

layoutType

LayoutType

Zwraca

Promise<boolean>

moveVisual(string, number, number, number)

Aktualizuje położenie wizualizacji na stronie.

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

Zwraca

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Usuwa wszystkie filtry z tej strony raportu.

page.removeFilters();

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

Zwraca

Promise<IHttpPostMessageResponse<void>>

resizePage(PageSizeType, number, number)

Aktualizuje rozmiar aktywnej strony.

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

Zwraca

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, number, number)

Zmienianie rozmiaru wizualizacji na stronie.

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

Zwraca

Promise<IHttpPostMessageResponse<void>>

setActive()

Sprawia, że bieżąca strona jest aktywną stroną raportu.

page.setActive();

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

Zwraca

Promise<IHttpPostMessageResponse<void>>

setDisplayName(string)

Ustaw wartość displayName na bieżącą stronę.

page.setName(displayName);

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

Parametry

displayName

string

Zwraca

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Ustawia wszystkie filtry na bieżącej stronie.

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

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

Parametry

filters

IFilter[]

Zwraca

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, VisualContainerDisplayMode)

Aktualizuje stan wyświetlania wizualizacji na stronie.

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

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

Parametry

visualName

string

displayState

VisualContainerDisplayMode

Zwraca

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Zaktualizuj filtry bieżącej strony zgodnie z operacją: Dodaj, zastąp wszystkie, zastąp elementem docelowym lub usuń.

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

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

Parametry

operation

FiltersOperations

filters

IFilter[]

Zwraca

Promise<IHttpPostMessageResponse<void>>