Page class

Pacote:

powerbi-client

Uma página de relatório do Power BI

Propriedades

background	Cor da tela de fundo da página.
defaultDisplayOption	Opções de exibição de página, conforme salvo no relatório.
defaultSize	Tamanho da página, conforme salvo no relatório.
displayName	O nome de exibição definido pelo usuário da página de relatório, que será indefinido se a página for criada manualmente
isActive	Esta página é a página ativa
mobileSize	Tamanho da página de exibição móvel (se definido) conforme salvo no relatório.
name	O nome da página do relatório
report	O relatório pai do Power BI do qual esta página é membro
visibility	A visibilidade da página. 0 – Always Visible 1 – Oculto no modo de exibição
wallpaper	Cor do papel de parede da página.

Métodos

delete()	Excluir a página do relatório // Delete the page from the report page.delete();
getFilters()	Obtém todos os filtros de nível de página dentro do relatório. page.getFilters() .then(filters => { ... });
getSlicers()	Obtém a lista de visuais de segmentação de dados na página. page.getSlicers() .then(slicers => { ... });
getSmartNarrativeInsights()	Obter insights para a página de relatório page.getSmartNarrativeInsights();
getVisualByName(string)	Obtém um visual pelo nome na página. page.getVisualByName(visualName: string) .then(visual => { ... });
getVisuals()	Obtém todos os visuais na página. page.getVisuals() .then(visuals => { ... });
hasLayout(LayoutType)	Verifica se a página tem layout. page.hasLayout(layoutType) .then(hasLayout: boolean => { ... });
moveVisual(string, number, number, number)	Atualiza a posição de um visual em uma página. page.moveVisual(visualName, x, y, z) .catch(error => { ... });
removeFilters()	Remove todos os filtros desta página do relatório. page.removeFilters();
resizePage(PageSizeType, number, number)	Atualiza o tamanho da página ativa. page.resizePage(pageSizeType, width, height) .catch(error => { ... });
resizeVisual(string, number, number)	Redimensione um visual em uma página. page.resizeVisual(visualName, width, height) .catch(error => { ... });
setActive()	Torna a página atual a página ativa do relatório. page.setActive();
setDisplayName(string)	Defina displayName como a página atual. page.setName(displayName);
setFilters(IFilter[])	Define todos os filtros na página atual. page.setFilters(filters) .catch(errors => { ... });
setVisualDisplayState(string, VisualContainerDisplayMode)	Atualiza o estado de exibição de um visual em uma página. page.setVisualDisplayState(visualName, displayState) .catch(error => { ... });
updateFilters(FiltersOperations, IFilter[])	Atualize os filtros da página atual de acordo com a operação: Adicionar, substituir tudo, substituir por destino ou remover. page.updateFilters(FiltersOperations.Add, filters) .catch(errors => { ... });

Detalhes da propriedade

background

Cor da tela de fundo da página.

background: IPageBackground

Valor da propriedade

IPageBackground

defaultDisplayOption

Opções de exibição de página, conforme salvo no relatório.

defaultDisplayOption: DisplayOption

Valor da propriedade

DisplayOption

defaultSize

Tamanho da página, conforme salvo no relatório.

defaultSize: ICustomPageSize

Valor da propriedade

ICustomPageSize

displayName

O nome de exibição definido pelo usuário da página de relatório, que será indefinido se a página for criada manualmente

displayName: string

Valor da propriedade

string

isActive

Esta página é a página ativa

isActive: boolean

Valor da propriedade

boolean

mobileSize

Tamanho da página de exibição móvel (se definido) conforme salvo no relatório.

mobileSize: ICustomPageSize

Valor da propriedade

ICustomPageSize

name

O nome da página do relatório

name: string

Valor da propriedade

string

report

O relatório pai do Power BI do qual esta página é membro

report: IReportNode

Valor da propriedade

IReportNode

visibility

A visibilidade da página. 0 – Always Visible 1 – Oculto no modo de exibição

visibility: SectionVisibility

Valor da propriedade

SectionVisibility

wallpaper

Cor do papel de parede da página.

wallpaper: IPageWallpaper

Valor da propriedade

IPageWallpaper

Detalhes do método

delete()

Excluir a página do relatório

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

function delete(): Promise<void>

Retornos

Promise<void>

getFilters()

Obtém todos os filtros de nível de página dentro do relatório.

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

function getFilters(): Promise<IFilter[]>

Retornos

Promise<IFilter[]>

getSlicers()

Obtém a lista de visuais de segmentação de dados na página.

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

function getSlicers(): Promise<IVisual[]>

Retornos

Promise<IVisual[]>

getSmartNarrativeInsights()

Obter insights para a página de relatório

page.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Retornos

Promise<ISmartNarratives>

getVisualByName(string)

Obtém um visual pelo nome na página.

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

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

Parâmetros

visualName

string

Retornos

Promise<VisualDescriptor>

getVisuals()

Obtém todos os visuais na página.

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

function getVisuals(): Promise<VisualDescriptor[]>

Retornos

Promise<VisualDescriptor[]>

hasLayout(LayoutType)

Verifica se a página tem layout.

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

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

Parâmetros

layoutType

LayoutType

Retornos

Promise<boolean>

moveVisual(string, number, number, number)

Atualiza a posição de um visual em uma página.

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

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

Parâmetros

visualName

string

x

number

y

number

z

number

Retornos

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Remove todos os filtros desta página do relatório.

page.removeFilters();

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

Retornos

Promise<IHttpPostMessageResponse<void>>

resizePage(PageSizeType, number, number)

Atualiza o tamanho da página ativa.

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

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

Parâmetros

pageSizeType

PageSizeType

width

number

height

number

Retornos

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, number, number)

Redimensione um visual em uma página.

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

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

Parâmetros

visualName

string

width

number

height

number

Retornos

Promise<IHttpPostMessageResponse<void>>

setActive()

Torna a página atual a página ativa do relatório.

page.setActive();

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

Retornos

Promise<IHttpPostMessageResponse<void>>

setDisplayName(string)

Defina displayName como a página atual.

page.setName(displayName);

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

Parâmetros

displayName

string

Retornos

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Define todos os filtros na página atual.

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

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

Parâmetros

filters

IFilter[]

Retornos

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, VisualContainerDisplayMode)

Atualiza o estado de exibição de um visual em uma página.

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

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

Parâmetros

visualName

string

displayState

VisualContainerDisplayMode

Retornos

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Atualize os filtros da página atual de acordo com a operação: Adicionar, substituir tudo, substituir por destino ou remover.

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

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

Parâmetros

operation

FiltersOperations

filters

IFilter[]

Retornos

Promise<IHttpPostMessageResponse<void>>