Compartir a través de

Page class

  • Referencia
Paquete:
powerbi-client

Página de un informe de Power BI

Propiedades

background

Color de fondo de página.
defaultDisplayOption

Opciones de presentación de páginas como guardadas en el informe.
defaultSize

Tamaño de página como se guarda en el informe.
displayName

Nombre para mostrar definido por el usuario de la página del informe, que no está definido si la página se crea manualmente.
isActive

¿Esta página es la página activa?
mobileSize

Tamaño de página de vista móvil (si se define) como se guarda en el informe.
name

Nombre de la página del informe
report

Informe primario de Power BI de que esta página es miembro de
visibility

Visibilidad de la página. 0 - Always Visible 1 - Oculto en modo de vista
wallpaper

Color del fondo de pantalla de la página.

Métodos

delete()

Eliminar la página del informe

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

Obtiene todos los filtros de nivel de página dentro del informe.

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

Obtiene la lista de objetos visuales de segmentación de datos de la página.

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

Obtener información para la página del informe

page.getSmartNarrativeInsights();
getVisualByName(string)

Obtiene un objeto visual por nombre en la página.

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

Obtiene todos los objetos visuales de la página.

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

Comprueba si la página tiene diseño.

page.hasLayout(layoutType)
 .then(hasLayout: boolean => { ... });
moveVisual(string, number, number, number)

Actualiza la posición de un objeto visual en una página.

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

Quita todos los filtros de esta página del informe.

page.removeFilters();
resizePage(PageSizeType, number, number)

Actualiza el tamaño de la página activa.

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

Cambiar el tamaño de un objeto visual en una página.

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

Convierte la página actual en la página activa del informe.

page.setActive();
setDisplayName(string)

Establezca displayName en la página actual.

page.setName(displayName);
setFilters(IFilter[])

Establece todos los filtros de la página actual.

page.setFilters(filters)
  .catch(errors => { ... });
setVisualDisplayState(string, VisualContainerDisplayMode)

Actualiza el estado de visualización de un objeto visual en una página.

page.setVisualDisplayState(visualName, displayState)
  .catch(error => { ... });
updateFilters(FiltersOperations, IFilter[])

Actualice los filtros de la página actual según la operación: Agregar, reemplazar todo, reemplazar por destino o quitar.

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

Detalles de las propiedades

background

Color de fondo de página.

background: IPageBackground

Valor de propiedad

IPageBackground

defaultDisplayOption

Opciones de presentación de páginas como guardadas en el informe.

defaultDisplayOption: DisplayOption

Valor de propiedad

DisplayOption

defaultSize

Tamaño de página como se guarda en el informe.

defaultSize: ICustomPageSize

Valor de propiedad

ICustomPageSize

displayName

Nombre para mostrar definido por el usuario de la página del informe, que no está definido si la página se crea manualmente.

displayName: string

Valor de propiedad

string

isActive

¿Esta página es la página activa?

isActive: boolean

Valor de propiedad

boolean

mobileSize

Tamaño de página de vista móvil (si se define) como se guarda en el informe.

mobileSize: ICustomPageSize

Valor de propiedad

ICustomPageSize

name

Nombre de la página del informe

name: string

Valor de propiedad

string

report

Informe primario de Power BI de que esta página es miembro de

report: IReportNode

Valor de propiedad

IReportNode

visibility

Visibilidad de la página. 0 - Always Visible 1 - Oculto en modo de vista

visibility: SectionVisibility

Valor de propiedad

SectionVisibility

wallpaper

Color del fondo de pantalla de la página.

wallpaper: IPageWallpaper

Valor de propiedad

IPageWallpaper

Detalles del método

delete()

Eliminar la página del informe

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

function delete(): Promise<void>

Devoluciones

Promise<void>

getFilters()

Obtiene todos los filtros de nivel de página dentro del informe.

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

function getFilters(): Promise<IFilter[]>

Devoluciones

Promise<IFilter[]>

getSlicers()

Obtiene la lista de objetos visuales de segmentación de datos de la página.

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

function getSlicers(): Promise<IVisual[]>

Devoluciones

Promise<IVisual[]>

getSmartNarrativeInsights()

Obtener información para la página del informe

page.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Devoluciones

Promise<ISmartNarratives>

getVisualByName(string)

Obtiene un objeto visual por nombre en la página.

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

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

Parámetros

visualName

string

Devoluciones

Promise<VisualDescriptor>

getVisuals()

Obtiene todos los objetos visuales de la página.

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

function getVisuals(): Promise<VisualDescriptor[]>

Devoluciones

Promise<VisualDescriptor[]>

hasLayout(LayoutType)

Comprueba si la página tiene diseño.

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

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

Parámetros

layoutType
LayoutType

Devoluciones

Promise<boolean>

moveVisual(string, number, number, number)

Actualiza la posición de un objeto visual en una 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

Devoluciones

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Quita todos los filtros de esta página del informe.

page.removeFilters();

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

Devoluciones

Promise<IHttpPostMessageResponse<void>>

resizePage(PageSizeType, number, number)

Actualiza el tamaño de la página activa.

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

Devoluciones

Promise<IHttpPostMessageResponse<void>>

resizeVisual(string, number, number)

Cambiar el tamaño de un objeto visual en una 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

Devoluciones

Promise<IHttpPostMessageResponse<void>>

setActive()

Convierte la página actual en la página activa del informe.

page.setActive();

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

Devoluciones

Promise<IHttpPostMessageResponse<void>>

setDisplayName(string)

Establezca displayName en la página actual.

page.setName(displayName);

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

Parámetros

displayName

string

Devoluciones

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Establece todos los filtros de la página actual.

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

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

Parámetros

filters

IFilter[]

Devoluciones

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(string, VisualContainerDisplayMode)

Actualiza el estado de visualización de un objeto visual en una página.

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

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

Parámetros

visualName

string

displayState
VisualContainerDisplayMode

Devoluciones

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Actualice los filtros de la página actual según la operación: Agregar, reemplazar todo, reemplazar por destino o quitar.

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

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

Parámetros

operation
FiltersOperations
filters

IFilter[]

Devoluciones

Promise<IHttpPostMessageResponse<void>>