Page class

Пакет:

powerbi-client

Страница отчета Power BI

Свойства

background	Цвет фона страницы.
defaultDisplayOption	Параметры отображения страницы, сохраненные в отчете.
defaultSize	Размер страницы, сохраненный в отчете.
displayName	Определяемое пользователем отображаемое имя страницы отчета, которое не определено, если страница создана вручную
isActive	Является ли эта страница активной страницей
mobileSize	Размер страницы "Мобильное представление" (если определено), как сохранено в отчете.
name	Имя страницы отчета
report	Родительский отчет Power BI о том, что эта страница является членом
visibility	Видимость страницы. 0 — всегда видимый 1 — скрытый в режиме просмотра
wallpaper	Цвет фона страницы.

Методы

delete()	Удаление страницы из отчета // Delete the page from the report page.delete();
getFilters()	Возвращает все фильтры на уровне страницы в отчете. page.getFilters() .then(filters => { ... });
getSlicers()	Возвращает список визуальных элементов среза на странице. page.getSlicers() .then(slicers => { ... });
getSmartNarrativeInsights()	Получение аналитических сведений на странице отчета page.getSmartNarrativeInsights();
getVisualByName(string)	Получает визуальный элемент по имени на странице. page.getVisualByName(visualName: string) .then(visual => { ... });
getVisuals()	Возвращает все визуальные элементы на странице. page.getVisuals() .then(visuals => { ... });
hasLayout(LayoutType)	Проверяет, имеет ли страница макет. page.hasLayout(layoutType) .then(hasLayout: boolean => { ... });
moveVisual(string, number, number, number)	Обновляет положение визуального элемента на странице. page.moveVisual(visualName, x, y, z) .catch(error => { ... });
removeFilters()	Удаляет все фильтры из этой страницы отчета. page.removeFilters();
resizePage(PageSizeType, number, number)	Обновляет размер активной страницы. page.resizePage(pageSizeType, width, height) .catch(error => { ... });
resizeVisual(string, number, number)	Изменение размера визуального элемента на странице. page.resizeVisual(visualName, width, height) .catch(error => { ... });
setActive()	Делает текущую страницу активной страницей отчета. page.setActive();
setDisplayName(string)	Задайте значение displayName для текущей страницы. page.setName(displayName);
setFilters(IFilter[])	Задает все фильтры на текущей странице. page.setFilters(filters) .catch(errors => { ... });
setVisualDisplayState(string, VisualContainerDisplayMode)	Обновляет состояние отображения визуального элемента на странице. page.setVisualDisplayState(visualName, displayState) .catch(error => { ... });
updateFilters(FiltersOperations, IFilter[])	Обновите фильтры для текущей страницы в соответствии с операцией: добавьте, замените все, замените целевым объектом или удалите. page.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });

Сведения о свойстве

background

Цвет фона страницы.

background: IPageBackground

Значение свойства

IPageBackground

defaultDisplayOption

Параметры отображения страницы, сохраненные в отчете.

defaultDisplayOption: DisplayOption

Значение свойства

DisplayOption

defaultSize

Размер страницы, сохраненный в отчете.

defaultSize: ICustomPageSize

Значение свойства

ICustomPageSize

displayName

Определяемое пользователем отображаемое имя страницы отчета, которое не определено, если страница создана вручную

displayName: string

Значение свойства

string

isActive

Является ли эта страница активной страницей

isActive: boolean

Значение свойства

boolean

mobileSize

Размер страницы "Мобильное представление" (если определено), как сохранено в отчете.

mobileSize: ICustomPageSize

Значение свойства

ICustomPageSize

name

Имя страницы отчета

name: string

Значение свойства

string

report

Родительский отчет Power BI о том, что эта страница является членом

report: IReportNode

Значение свойства

IReportNode

visibility

Видимость страницы. 0 — всегда видимый 1 — скрытый в режиме просмотра

visibility: SectionVisibility

Значение свойства

SectionVisibility

wallpaper

Цвет фона страницы.

wallpaper: IPageWallpaper

Значение свойства

IPageWallpaper

Сведения о методе

delete()

Удаление страницы из отчета

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

function delete(): Promise<void>

Возвращаемое значение

Promise<void>

getFilters()

Возвращает все фильтры на уровне страницы в отчете.

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

function getFilters(): Promise<IFilter[]>

Возвращаемое значение

Promise<IFilter[]>

getSlicers()

Возвращает список визуальных элементов среза на странице.

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

function getSlicers(): Promise<IVisual[]>

Возвращаемое значение

Promise<IVisual[]>

getSmartNarrativeInsights()

Получение аналитических сведений на странице отчета

page.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Возвращаемое значение

Promise<ISmartNarratives>

getVisualByName(string)

Получает визуальный элемент по имени на странице.

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

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

Параметры

visualName

string

Возвращаемое значение

Promise<VisualDescriptor>

getVisuals()

Возвращает все визуальные элементы на странице.

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

function getVisuals(): Promise<VisualDescriptor[]>

Возвращаемое значение

Promise<VisualDescriptor[]>

hasLayout(LayoutType)

Проверяет, имеет ли страница макет.

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

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

Параметры

layoutType

LayoutType

Возвращаемое значение

Promise<boolean>

moveVisual(string, number, number, number)

Обновляет положение визуального элемента на странице.

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

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

Параметры

visualName

string

x

number

y

number

z

number

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Удаляет все фильтры из этой страницы отчета.

page.removeFilters();

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

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

resizePage(PageSizeType, number, number)

Обновляет размер активной страницы.

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

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

Параметры

pageSizeType

PageSizeType

width

number

height

number

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, number, number)

Изменение размера визуального элемента на странице.

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

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

Параметры

visualName

string

width

number

height

number

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

setActive()

Делает текущую страницу активной страницей отчета.

page.setActive();

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

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

setDisplayName(string)

Задайте значение displayName для текущей страницы.

page.setName(displayName);

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

Параметры

displayName

string

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Задает все фильтры на текущей странице.

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

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

Параметры

filters

IFilter[]

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, VisualContainerDisplayMode)

Обновляет состояние отображения визуального элемента на странице.

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

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

Параметры

visualName

string

displayState

VisualContainerDisplayMode

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Обновите фильтры для текущей страницы в соответствии с операцией: добавьте, замените все, замените целевым объектом или удалите.

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

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

Параметры

operation

FiltersOperations

filters

IFilter[]

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>